com.atlassian.confluence.content.service.space
Class KeySpaceLocator

java.lang.Object
  extended by com.atlassian.confluence.core.service.AbstractSingleEntityLocator
      extended by com.atlassian.confluence.content.service.space.KeySpaceLocator
All Implemented Interfaces:
SpaceLocator, EntityLocator, SingleEntityLocator

public class KeySpaceLocator
extends AbstractSingleEntityLocator
implements SpaceLocator

A space locator that uses a space key to find a space.


Constructor Summary
KeySpaceLocator(SpaceManager spaceManager, String spaceKey)
           
 
Method Summary
 ConfluenceEntityObject getEntity()
          Get the entities that matches the query represented by this locator.
 Space getSpace()
           
 
Methods inherited from class com.atlassian.confluence.core.service.AbstractSingleEntityLocator
getEntities
 
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.EntityLocator
getEntities
 

Constructor Detail

KeySpaceLocator

public KeySpaceLocator(SpaceManager spaceManager,
                       String spaceKey)
Method Detail

getSpace

public Space getSpace()
Specified by:
getSpace in interface SpaceLocator

getEntity

public ConfluenceEntityObject getEntity()
Description copied from interface: SingleEntityLocator
Get the entities that matches the query represented by this locator. If no entities match the query, this method will return null.

Specified by:
getEntity in interface SingleEntityLocator
Returns:
the entity matching the locator's query, or null if no such object is found.


Copyright © 2003-2011 Atlassian. All Rights Reserved.