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

Class TagConfigurationBuilder

java.lang.Object

com.inductiveautomation.ignition.common.tags.config.TagConfigurationBuilder

Direct Known Subclasses:

TagConfigurationBuilder.MemberTagConfigurationBuilder

public class TagConfigurationBuilder
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TagConfigurationBuilder.MemberTagConfigurationBuilder	This form of the builder is for child member builders, and only adds the "close()" function that will finish that builder and return the parent.

Constructor Summary

Constructors

Constructor	Description
TagConfigurationBuilder()

Method Summary

Modifier and Type	Method	Description
protected TagConfigurationBuilder.MemberTagConfigurationBuilder	_member(java.lang.String name)
TagConfigurationBuilder	alarm(AlarmDefinition alarm)
TagConfiguration	build()
TagConfigurationBuilder	dataType(DataType type)
TagConfigurationBuilder	fullPath(java.lang.String path)	Full path is a forward-slash ("/") separated string that is the folder path + tag name.
TagConfigurationBuilder.MemberTagConfigurationBuilder	member(java.lang.String fullPath)	Returns a builder for the given member path.
TagConfigurationBuilder	member(java.lang.String fullPath, TagConfiguration memberConfig)
TagConfigurationBuilder	name(java.lang.String name)
static TagConfigurationBuilder	newBuilder()
TagConfigurationBuilder	parameter(java.lang.String name, java.lang.String value)
TagConfigurationBuilder	path(java.lang.String path)	The path is just the folder path, not including the tag name.
TagConfigurationBuilder	properties(PropertySet props)
TagConfigurationBuilder	property(Property<?> prop, java.lang.Object value)
TagConfigurationBuilder	tagType(TagType type)
TagConfigurationBuilder	tagType(java.lang.String typeId)

Methods inherited from class java.lang.Object

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

Constructor Detail

TagConfigurationBuilder

public TagConfigurationBuilder()

Method Detail

newBuilder

public static TagConfigurationBuilder newBuilder()

name

public TagConfigurationBuilder name(java.lang.String name)

path

public TagConfigurationBuilder path(java.lang.String path)

The path is just the folder path, not including the tag name.

fullPath

public TagConfigurationBuilder fullPath(java.lang.String path)

Full path is a forward-slash ("/") separated string that is the folder path + tag name. This is equivilent to calling path() and name().

tagType

public TagConfigurationBuilder tagType(TagType type)

tagType

public TagConfigurationBuilder tagType(java.lang.String typeId)

dataType

public TagConfigurationBuilder dataType(DataType type)

property

public TagConfigurationBuilder property(Property<?> prop,
                                        java.lang.Object value)

properties

public TagConfigurationBuilder properties(PropertySet props)

parameter

public TagConfigurationBuilder parameter(java.lang.String name,
                                         java.lang.String value)

member

public TagConfigurationBuilder.MemberTagConfigurationBuilder member(java.lang.String fullPath)

Returns a builder for the given member path.

_member

protected TagConfigurationBuilder.MemberTagConfigurationBuilder _member(java.lang.String name)

member

public TagConfigurationBuilder member(java.lang.String fullPath,
                                      TagConfiguration memberConfig)

alarm

public TagConfigurationBuilder alarm(AlarmDefinition alarm)

build

public TagConfiguration build()