com.atlassian.confluence.core.service
Class AbstractSingleEntityLocator

java.lang.Object
  extended by com.atlassian.confluence.core.service.AbstractSingleEntityLocator
All Implemented Interfaces:
EntityLocator, SingleEntityLocator
Direct Known Subclasses:
AbstractPageLocator, IdBlogPostLocator, IdContentLocator, KeySpaceLocator

public abstract class AbstractSingleEntityLocator
extends Object
implements SingleEntityLocator

Base class for SingleEntityLocator that enforces the contract between getEntity and getEntities


Constructor Summary
AbstractSingleEntityLocator()
           
 
Method Summary
 List<ConfluenceEntityObject> getEntities()
          Get the entities that match the query represented by this locator.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.atlassian.confluence.core.service.SingleEntityLocator
getEntity
 

Constructor Detail

AbstractSingleEntityLocator

public AbstractSingleEntityLocator()
Method Detail

getEntities

public List<ConfluenceEntityObject> getEntities()
Description copied from interface: EntityLocator
Get the entities that match the query represented by this locator. If no entities match the query, this method will return an empty list. If the locator will only ever return a single entity, this method should return a single element list.

Whether the ordering of entities in the returned list is significant is dependent on the specific implementation of the locator.

Specified by:
getEntities in interface EntityLocator
Returns:
the entities found by this EntityLocator, or an empty list if no entities matched the query


Copyright © 2003–2015 Atlassian. All rights reserved.