Package com.enonic.xp.data
Class PropertySet
- java.lang.Object
-
- com.enonic.xp.data.PropertySet
-
@PublicApi public final class PropertySet extends Object
-
-
Constructor Summary
Constructors Constructor Description PropertySet()
-
Method Summary
-
-
-
Method Detail
-
getTree
public PropertyTree getTree()
-
getProperty
public Property getProperty()
-
copy
public PropertySet copy(PropertyTree tree)
-
toTree
public PropertyTree toTree()
-
countAncestors
@Deprecated public int countAncestors()
Deprecated.
-
ifNotNull
public PropertySet ifNotNull()
-
newSet
public PropertySet newSet()
-
detach
public PropertySet detach()
-
countProperties
public int countProperties(String name)
-
setProperty
public Property setProperty(PropertyPath path, Value value)
-
ensureProperty
public void ensureProperty(String name, ValueType valueType)
WARNING: This method may be removed at any time. It is not recommended to use it in new code. This method is only used to simulate the behavior of PropertySet Serialisation. SeePropertyArrayJson.fromJson(com.enonic.xp.data.PropertySet)
Ensures that the property with the given name has type of valueType given. If the property does not exist, empty property (without values) will be created. If the property with values exists and is not a type of valueType given, an exception will be thrown. Difference with setProperty is that this method does not set the property value.- Parameters:
name
- property namevalueType
- expected value type
-
setValues
public void setValues(PropertyPath path, Iterable<Value> values)
-
removeProperty
public void removeProperty(String path)
-
removeProperty
public void removeProperty(PropertyPath path)
-
removeProperties
public void removeProperties(String name)
-
hasProperty
public boolean hasProperty(String path)
-
hasProperty
public boolean hasProperty(PropertyPath path)
-
hasProperty
public boolean hasProperty(String name, int index)
-
getProperty
public Property getProperty(PropertyPath path)
-
isNull
public boolean isNull(String path)
-
isNull
public boolean isNull(PropertyPath path)
-
isNotNull
public boolean isNotNull(String path)
-
isNotNull
public boolean isNotNull(PropertyPath path)
-
getPropertyNames
public String[] getPropertyNames()
-
getProperties
public ImmutableList<Property> getProperties(String name)
-
getProperties
public ImmutableList<Property> getProperties(ValueType valueType)
-
getPropertySize
public int getPropertySize()
-
getPropertyArrays
public Collection<PropertyArray> getPropertyArrays()
-
getValue
public Value getValue(PropertyPath path)
-
getPropertySet
public PropertySet getPropertySet(PropertyPath path)
-
getPropertySet
public PropertySet getPropertySet(String path)
-
setSet
public Property setSet(String path, PropertySet value)
-
setSet
public Property setSet(PropertyPath path, PropertySet value)
-
setSet
public Property setSet(String name, int index, PropertySet value)
-
addSet
public Property addSet(String name, PropertySet value)
-
addSets
public Property[] addSets(String name, PropertySet... values)
-
addSet
public PropertySet addSet(String name)
-
setString
public Property setString(PropertyPath path, String value)
-
addStrings
public Property[] addStrings(String name, Collection<String> values)
-
setXml
public Property setXml(PropertyPath path, String value)
-
setBoolean
public Property setBoolean(PropertyPath path, Boolean value)
-
setLong
public Property setLong(PropertyPath path, Long value)
-
setLocalDate
public Property setLocalDate(PropertyPath path, LocalDate value)
-
setLocalDateTime
public Property setLocalDateTime(String path, LocalDateTime value)
-
setLocalDateTime
public Property setLocalDateTime(PropertyPath path, LocalDateTime value)
-
setLocalDateTime
public Property setLocalDateTime(String name, int index, LocalDateTime value)
-
addLocalDateTime
public Property addLocalDateTime(String name, LocalDateTime value)
-
addLocalDateTimes
public Property[] addLocalDateTimes(String name, LocalDateTime... values)
-
setLocalTime
public Property setLocalTime(PropertyPath path, LocalTime value)
-
setInstant
public Property setInstant(PropertyPath path, Instant value)
-
setDouble
public Property setDouble(PropertyPath path, Double value)
-
setGeoPoint
public Property setGeoPoint(PropertyPath path, GeoPoint value)
-
setReference
public Property setReference(PropertyPath path, Reference value)
-
setBinaryReference
public Property setBinaryReference(String path, BinaryReference value)
-
setBinaryReference
public Property setBinaryReference(PropertyPath path, BinaryReference value)
-
setBinaryReference
public Property setBinaryReference(String name, int index, BinaryReference value)
-
addBinaryReference
public Property addBinaryReference(String name, BinaryReference value)
-
addBinaryReferences
public Property[] addBinaryReferences(String name, BinaryReference... values)
-
setLink
public Property setLink(PropertyPath path, Link value)
-
getSet
public PropertySet getSet(String name, int index)
-
getSet
public PropertySet getSet(PropertyPath path)
-
getSet
public PropertySet getSet(String path)
-
getSets
public Iterable<PropertySet> getSets(String name)
-
getString
public String getString(PropertyPath path)
-
getBoolean
public Boolean getBoolean(PropertyPath path)
-
getLong
public Long getLong(PropertyPath path)
-
getDouble
public Double getDouble(PropertyPath path)
-
getGeoPoint
public GeoPoint getGeoPoint(PropertyPath path)
-
getReference
public Reference getReference(PropertyPath path)
-
getBinaryReference
public BinaryReference getBinaryReference(String name, int index)
-
getBinaryReference
public BinaryReference getBinaryReference(PropertyPath path)
-
getBinaryReference
public BinaryReference getBinaryReference(String path)
-
getBinaryReferences
public Iterable<BinaryReference> getBinaryReferences(String name)
-
getLink
public Link getLink(PropertyPath path)
-
getLocalDate
public LocalDate getLocalDate(PropertyPath path)
-
getLocalDateTime
public LocalDateTime getLocalDateTime(String name, int index)
-
getLocalDateTime
public LocalDateTime getLocalDateTime(PropertyPath path)
-
getLocalDateTime
public LocalDateTime getLocalDateTime(String path)
-
getLocalDateTimes
public Iterable<LocalDateTime> getLocalDateTimes(String name)
-
getLocalTime
public LocalTime getLocalTime(PropertyPath path)
-
getInstant
public Instant getInstant(PropertyPath path)
-
getEnum
public <T extends Enum<T>> T getEnum(PropertyPath path, Class<T> enumClass)
-
setEnum
public Property setEnum(PropertyPath path, Enum value)
-
-