Package com.atlassian.confluence.core.service

Interface SingleEntityLocator

All Superinterfaces:
EntityLocator
All Known Subinterfaces:
BlogPostLocator, PageLocator, SpaceLocator
All Known Implementing Classes:
AbstractPageLocator, AbstractSingleEntityLocator, IdAndVersionPageLocator, IdBlogPostLocator, IdContentLocator, IdPageLocator, KeySpaceLocator, SinglePageLocator, TitleAndSpaceKeyPageLocator
public interface SingleEntityLocator extends EntityLocator
EntityLocator that will only ever find either zero or one objects.

  • Method Summary

    Modifier and Type
    Method
    Description
    ConfluenceEntityObject
    getEntity()
    Get the entities that matches the query represented by this locator.

    Methods inherited from interface com.atlassian.confluence.core.service.EntityLocator

    getEntities

  • Method Details

    • getEntity

      ConfluenceEntityObject getEntity()
      Get the entities that matches the query represented by this locator. If no entities match the query, this method will return null.
      Returns:
      the entity matching the locator's query, or null if no such object is found.