Class AbstractSingleEntityLocator

  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 java.lang.Object
implements SingleEntityLocator

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

Constructor Summary
Method Summary
 java.util.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

Constructor Detail


public AbstractSingleEntityLocator()
Method Detail


public java.util.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
the entities found by this EntityLocator, or an empty list if no entities matched the query

Copyright © 2003-2014 Atlassian. All Rights Reserved.