Package com.inductiveautomation.ignition.common.metaproperties

Class MetaPropertyCollection

java.lang.Object

com.inductiveautomation.ignition.common.metaproperties.MetaPropertyCollection

All Implemented Interfaces:

java.io.Serializable

public class MetaPropertyCollection
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MetaPropertyCollection()
MetaPropertyCollection(MetaPropertyCollection copy)

Method Summary

Modifier and Type	Method	Description
boolean	contains(MetaProperty property)
boolean	contains(java.lang.String name)
static MetaPropertyCollection	emptyCollection()
MetaProperty	get(MetaProperty property)
MetaProperty	get(java.lang.String name)
TypedMetaProperty<?>	getOrDefault(WellKnownMetaProperty<?> property)
java.util.Map<java.lang.String,MetaProperty>	getProperties()	Used for serialization, normally shouldn't be used directly.
boolean	isSet(WellKnownMetaProperty<?> property)	Tests to verify that the collection has the property defined, and also that the property's value is not NULL and not the default value.
void	set(MetaProperty property)	Adds the given property to the collection, or replaces the existing value.
<T> void	set(WellKnownMetaProperty<T> property, T value)	Adds a property to the collection for the given WellKnownProperty, or replaces the existing value.
void	setAll(MetaPropertyCollection source)	Merges all the properties from the source to this meta prop collection.
protected void	setAll(MetaPropertyCollection source, boolean cloneProps)
void	setProperties(java.util.Map<java.lang.String,MetaProperty> propertyMap)	Used for serialization, normally shouldn't be used directly.
int	size()
void	unsetProperty(java.lang.String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetaPropertyCollection

public MetaPropertyCollection()

MetaPropertyCollection

public MetaPropertyCollection(MetaPropertyCollection copy)

Method Detail

emptyCollection

public static MetaPropertyCollection emptyCollection()

size

public int size()

getProperties

public java.util.Map<java.lang.String,MetaProperty> getProperties()

Used for serialization, normally shouldn't be used directly.

setProperties

public void setProperties(java.util.Map<java.lang.String,MetaProperty> propertyMap)

Used for serialization, normally shouldn't be used directly.

contains

public boolean contains(java.lang.String name)

contains

public boolean contains(MetaProperty property)

unsetProperty

public void unsetProperty(java.lang.String name)

isSet

public boolean isSet(WellKnownMetaProperty<?> property)

Tests to verify that the collection has the property defined, and also that the property's value is not NULL and not the default value.

getOrDefault

public TypedMetaProperty<?> getOrDefault(WellKnownMetaProperty<?> property)

get

public MetaProperty get(MetaProperty property)

get

public MetaProperty get(java.lang.String name)

set

public void set(MetaProperty property)

Adds the given property to the collection, or replaces the existing value.

set

public <T> void set(WellKnownMetaProperty<T> property,
                    T value)

Adds a property to the collection for the given WellKnownProperty, or replaces the existing value.

setAll

public void setAll(MetaPropertyCollection source)

Merges all the properties from the source to this meta prop collection.

setAll

protected void setAll(MetaPropertyCollection source,
                      boolean cloneProps)