Package com.inductiveautomation.ignition.common.tags.browsing

Class NodeDescription

java.lang.Object

com.inductiveautomation.ignition.common.tags.browsing.NodeDescription

All Implemented Interfaces:

PropertyValueSource, Serializable

public class NodeDescription
extends Object
implements Serializable, PropertyValueSource

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NodeDescription.GsonAdapter	Gson serialization and deserialization adapter for NodeBrowseInfo objects.
static class	NodeDescription.NodeDescriptionBuilder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NodeDescription()

Method Summary

Modifier and Type	Method	Description
boolean	contains(Property<?> prop)
<T> T	get(Property<T> prop)	Retrieves the value of the property, or null if this set doesn't contain that property.
Set<NodeAttribute>	getAttributes()
static Set<Property<?>>	getBuiltInProperties()
QualifiedValue	getCurrentValue()
DataType	getDataType()
String	getDisplayFormat()
PropertySet	getExtendedInfo()
TagPath	getFullPath()
String	getName()
TagObjectType	getObjectType()
<T> T	getOrElse(Property<T> prop, T value)	Get the value for a given Property, or else fall back to value if it's not present.
Collection<Property<?>>	getProperties()
String	getSubTypeId()
String	getTooltip()
boolean	hasChildren()
static NodeDescription.NodeDescriptionBuilder	newBuilder()
static NodeDescription.NodeDescriptionBuilder	newBuilder(BrowseFilter.Meta meta)
static NodeDescription	property(Property<?> prop, QualifiedValue value)
static NodeDescription.NodeDescriptionBuilder	property(Property<?> prop, QualifiedValue value, NodeDescription.NodeDescriptionBuilder builder)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertyValueSource

getNonNull, getNonNull, getOrDefault, getValues

Constructor Details

NodeDescription

protected NodeDescription()

Method Details

getBuiltInProperties

public static Set<Property<?>> getBuiltInProperties()

getName

public String getName()

getDataType

public DataType getDataType()

getCurrentValue

public QualifiedValue getCurrentValue()

getDisplayFormat

public String getDisplayFormat()

getTooltip

public String getTooltip()

getFullPath

public TagPath getFullPath()

getObjectType

public TagObjectType getObjectType()

getSubTypeId

public String getSubTypeId()

getAttributes

public Set<NodeAttribute> getAttributes()

hasChildren

public boolean hasChildren()

newBuilder

public static NodeDescription.NodeDescriptionBuilder newBuilder(@Nullable
 BrowseFilter.Meta meta)

newBuilder

public static NodeDescription.NodeDescriptionBuilder newBuilder()

getExtendedInfo

public PropertySet getExtendedInfo()

getProperties

public Collection<Property<?>> getProperties()

Specified by:

getProperties in interface PropertyValueSource

contains

public boolean contains(Property<?> prop)

Specified by:

contains in interface PropertyValueSource

Returns:

True if the source contains a value for prop.

getOrElse

@Nullable
public <T> T getOrElse(Property<T> prop,
 T value)

Description copied from interface: PropertyValueSource

Get the value for a given Property, or else fall back to value if it's not present.

Specified by:

getOrElse in interface PropertyValueSource

Parameters:

prop - The Property for which a value is to be retrieved.

value - The value to default to if property isn't present.

Returns:

The value of property if present, value if not. Can return null if the value is null.

get

@Nullable
public <T> T get(Property<T> prop)

Description copied from interface: PropertyValueSource

Retrieves the value of the property, or null if this set doesn't contain that property.

Specified by:

get in interface PropertyValueSource

toString

public String toString()

Overrides:

toString in class Object

property

public static NodeDescription property(Property<?> prop,
 QualifiedValue value)

property

public static NodeDescription.NodeDescriptionBuilder property(Property<?> prop,
 QualifiedValue value,
 NodeDescription.NodeDescriptionBuilder builder)