Package com.inductiveautomation.ignition.common.tags.config.types

Enum Class TagObjectType

java.lang.Object

java.lang.Enum<TagObjectType>

com.inductiveautomation.ignition.common.tags.config.types.TagObjectType

All Implemented Interfaces:

Serializable, Comparable<TagObjectType>, Constable

public enum TagObjectType
extends Enum<TagObjectType>

This enum represents the core set of object types in the tag system. Some of the types will have different or various implementations, and thus the intention of this enum is not to lead to instantiation of particular objects, but to provide a broad classification/base level info of the object type. since 8.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AtomicTag	A single, "normal" tag.
Folder	A folder contains other nodes, in a structure or under a type.
Node	A "node" is an entity that may have a value and may have children, usually under a tag.
Property	A "property" is a single value underneath a node.
Provider	A tag provider that manages tags.
TagModel	A tag model is an entity that manages tags below it.
UdtInstance	An instance of a UdtType.
UdtType	A type definition for a complex tag type.
Unknown	This is generally an error state, meaning we don't have the right information about the node type.

Method Summary

Modifier and Type	Method	Description
static TagObjectType	fromString(String value)	Returns the enum value represented by the string.
boolean	isComplexTag()
static TagObjectType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TagObjectType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Unknown

public static final TagObjectType Unknown

This is generally an error state, meaning we don't have the right information about the node type.

Property

public static final TagObjectType Property

A "property" is a single value underneath a node.

Node

public static final TagObjectType Node

A "node" is an entity that may have a value and may have children, usually under a tag.

Folder

public static final TagObjectType Folder

A folder contains other nodes, in a structure or under a type.

AtomicTag

public static final TagObjectType AtomicTag

A single, "normal" tag.

UdtInstance

public static final TagObjectType UdtInstance

An instance of a UdtType.

UdtType

public static final TagObjectType UdtType

A type definition for a complex tag type.

TagModel

public static final TagObjectType TagModel

A tag model is an entity that manages tags below it.

Provider

public static final TagObjectType Provider

A tag provider that manages tags.

Method Details

values

public static TagObjectType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TagObjectType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static TagObjectType fromString(String value)

Returns the enum value represented by the string. Unlike valueOf, this is not case sensitive, and will not return null- instead, Unknown will be returned.

isComplexTag

public boolean isComplexTag()