public class ObjectPropertyReference extends EntityReference
TOSTRING_SERIALIZER
Modifier | Constructor and Description |
---|---|
|
ObjectPropertyReference(EntityReference reference)
Constructor which would raise exceptions if the source entity reference does not have the appropriate type or
parent, etc.
|
|
ObjectPropertyReference(EntityReference reference,
EntityReference parent)
Clone an ObjectPropertyReference, but use the specified parent for its new parent.
|
protected |
ObjectPropertyReference(EntityReference reference,
EntityReference oldReference,
EntityReference newReference)
Clone an ObjectPropertyReference, but replace one of the parent in the chain by a new one.
|
|
ObjectPropertyReference(String propertyName,
ObjectReference objectReference)
Builds a property reference for the passed property in the passed object.
|
|
ObjectPropertyReference(String wiki,
String space,
String page,
String objectName,
String propertyName)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
ObjectPropertyReference |
replaceParent(EntityReference newParent)
Return a clone of this reference, but with its parent replaced by the passed one.
|
ObjectPropertyReference |
replaceParent(EntityReference oldParent,
EntityReference newParent)
Return a clone of this reference, but with one of its parent replaced by another one.
|
protected void |
setParent(EntityReference parent)
Entity reference are immutable since 3.3M2, so this method is now protected.
|
protected void |
setType(EntityType type)
Entity reference are immutable since 3.3M2, so this method is now protected.
|
appendParent, compareTo, equals, equals, equals, equalsNonRecursive, extractFirstReference, extractReference, getName, getParameter, getParameters, getParent, getReversedReferenceChain, getRoot, getType, hashCode, hasParent, removeParent, setName, setParameter, setParameters, size, toString
public ObjectPropertyReference(EntityReference reference)
reference
- the raw reference to build this object reference fromprotected ObjectPropertyReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)
reference
- the reference that is clonedoldReference
- the old parent that will be replacednewReference
- the new parent that will replace oldReference in the chainpublic ObjectPropertyReference(String propertyName, ObjectReference objectReference)
propertyName
- the name of the property to create reference forobjectReference
- the reference to the object whose property ispublic ObjectPropertyReference(EntityReference reference, EntityReference parent)
reference
- the reference to cloneparent
- the new parent to use@Deprecated public ObjectPropertyReference(String wiki, String space, String page, String objectName, String propertyName)
wiki
- the wiki of the document where the parent object of this property isspace
- the space of the document where the parent object of this property ispage
- the document where the parent object of this property isobjectName
- the name of the parent object of this propertypropertyName
- the name of the property to refer toprotected void setType(EntityType type)
Overridden to check the type to be a property type.
setType
in class EntityReference
type
- the type for this entityEntityReference.setType(org.xwiki.model.EntityType)
protected void setParent(EntityReference parent)
Overridden to ensure that the parent of a property is always an object.
setParent
in class EntityReference
parent
- the parent for this entity, may be null for a root entity.EntityReference.setParent(org.xwiki.model.reference.EntityReference)
public ObjectPropertyReference replaceParent(EntityReference oldParent, EntityReference newParent)
EntityReference
replaceParent
in class EntityReference
oldParent
- the old parent that will be replacednewParent
- the new parent that will replace oldParent in the chain. If the same as oldParent, this is
returned.public ObjectPropertyReference replaceParent(EntityReference newParent)
EntityReference
replaceParent
in class EntityReference
newParent
- the new parent that will replace the parentCopyright © 2004–2022 XWiki. All rights reserved.