org.xwiki.model.reference
Class SpaceReference

java.lang.Object
  org.xwiki.model.reference.EntityReference
      org.xwiki.model.reference.SpaceReference

All Implemented Interfaces:

Serializable, Cloneable, Comparable<EntityReference>

public class SpaceReference
extends EntityReference

Represents a reference to a space (space name). Note that nested spaces are supported.

Since:

2.2M1

Version:

$Id$

See Also:

Serialized Form

Constructor Summary

SpaceReference(EntityReference reference)
Special constructor that transforms a generic entity reference into a SpaceReference.

SpaceReference(String spaceName, SpaceReference parent)

SpaceReference(String spaceName, WikiReference parent)

Method Summary

void	setParent(EntityReference parent) Overridden in order to verify the validity of the passed parent
void	setType(EntityType type) Overridden in order to verify the validity of the passed type

Methods inherited from class org.xwiki.model.reference.EntityReference

clone, compareTo, equals, extractReference, getChild, getName, getParent, getRoot, getType, hashCode, setChild, setName, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SpaceReference

public SpaceReference(EntityReference reference)

Special constructor that transforms a generic entity reference into a SpaceReference. It checks the validity of the passed reference (ie correct type and correct parent).

Throws:

IllegalArgumentException - if the passed reference is not a valid space reference

SpaceReference

public SpaceReference(String spaceName,
                      SpaceReference parent)

SpaceReference

public SpaceReference(String spaceName,
                      WikiReference parent)

Method Detail

setParent

public void setParent(EntityReference parent)

Overridden in order to verify the validity of the passed parent

Overrides:

setParent in class EntityReference

Throws:

IllegalArgumentException - if the passed parent is not a valid space reference parent (ie either a space reference or a wiki reference)

See Also:

EntityReference.setParent(EntityReference)

setType

public void setType(EntityType type)

Overridden in order to verify the validity of the passed type

Overrides:

setType in class EntityReference

Throws:

IllegalArgumentException - if the passed type is not a space type

See Also:

EntityReference.setType(org.xwiki.model.EntityType)