Package com.inductiveautomation.ignition.common

Class QualifiedPath.Builder

java.lang.Object

com.inductiveautomation.ignition.common.QualifiedPath.Builder

Enclosing class:

QualifiedPath

public static class QualifiedPath.Builder
extends Object

A builder to assist in constructing QualifiedPaths.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
QualifiedPath	build()
QualifiedPath.Builder	set(String id, String value)
QualifiedPath.Builder	setAlarm(String alarmValue)	Sets a value for an id of WellKnownPathTypes.Alarm.
QualifiedPath.Builder	setDriver(String driverValue)
QualifiedPath.Builder	setEvent(String eventValue)	Sets a value for an id of WellKnownPathTypes.Event.
QualifiedPath.Builder	setMachine(String machineValue)	Sets a value for an id of WellKnownPathTypes.Machine.
QualifiedPath.Builder	setProject(String project)	Sets a value for an id of WellKnownPathTypes.Project.
QualifiedPath.Builder	setProperty(String propName)	Sets a value for an id of WellKnownPathTypes.Property.
QualifiedPath.Builder	setProvider(String providerValue)	Sets a value for an id of WellKnownPathTypes.Provider.
QualifiedPath.Builder	setSource(String source)	Sets a value for an id of WellKnownPathTypes.Source.
QualifiedPath.Builder	setSystem(String systemValue)	Sets a value for an id of WellKnownPathTypes.System.
QualifiedPath.Builder	setTag(String tagValue)	Sets a value for an id of WellKnownPathTypes.Tag.
QualifiedPath.Builder	setUser(String userValue)	Sets a value for an id of WellKnownPathTypes.User.
QualifiedPath.Builder	setUserProfile(String userProfile)	Sets a value for an id of WellKnownPathTypes.UserProfile.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

set

public QualifiedPath.Builder set(String id,
 String value)

setMachine

public QualifiedPath.Builder setMachine(String machineValue)

Sets a value for an id of WellKnownPathTypes.Machine.

Returns:

This Builder.

setSystem

public QualifiedPath.Builder setSystem(String systemValue)

Sets a value for an id of WellKnownPathTypes.System.

Returns:

This Builder.

setDriver

public QualifiedPath.Builder setDriver(String driverValue)

setTag

public QualifiedPath.Builder setTag(String tagValue)

Sets a value for an id of WellKnownPathTypes.Tag.

Returns:

This Builder.

setAlarm

public QualifiedPath.Builder setAlarm(String alarmValue)

Sets a value for an id of WellKnownPathTypes.Alarm.

Returns:

This Builder.

setEvent

public QualifiedPath.Builder setEvent(String eventValue)

Sets a value for an id of WellKnownPathTypes.Event.

Returns:

This Builder.

setProvider

public QualifiedPath.Builder setProvider(String providerValue)

Sets a value for an id of WellKnownPathTypes.Provider.

Returns:

This Builder.

setUser

public QualifiedPath.Builder setUser(String userValue)

Sets a value for an id of WellKnownPathTypes.User.

Returns:

This Builder.

setUserProfile

public QualifiedPath.Builder setUserProfile(String userProfile)

Sets a value for an id of WellKnownPathTypes.UserProfile.

Returns:

This Builder.

setProperty

public QualifiedPath.Builder setProperty(String propName)

Sets a value for an id of WellKnownPathTypes.Property.

Returns:

This Builder.

setSource

public QualifiedPath.Builder setSource(String source)

Sets a value for an id of WellKnownPathTypes.Source.

Returns:

This Builder.

setProject

public QualifiedPath.Builder setProject(String project)

Sets a value for an id of WellKnownPathTypes.Project.

Returns:

This Builder.

build

public QualifiedPath build()

Returns:

An QualifiedPath built from all the parts set on this Builder.