Package com.inductiveautomation.ignition.common.tags.paths

Class AbstractTagPath

java.lang.Object

com.inductiveautomation.ignition.common.tags.paths.AbstractTagPath

All Implemented Interfaces:

Path, TagPath, Serializable, Comparable<TagPath>

Direct Known Subclasses:

BasicTagPath, PropertyAlteredTagPath, SimplifiedTagPath, SourceAlteredTagPath

public abstract class AbstractTagPath
extends Object
implements TagPath

This implementation simply takes care of the toString functions of TagPath.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.Path

SERIALIZATION_WHITELIST

Constructor Summary

Constructors

Constructor	Description
AbstractTagPath()

Method Summary

Modifier and Type	Method	Description
protected String	_createPath(boolean full)
static int	compareNullLow(Property<?> c1, Property<?> c2)	Null-safe compare.
int	compareTo(TagPath that)
boolean	equals(Object obj)
int	hashCode()
boolean	isAncestorOf(Path child)	Returns whether the provided path is a child path of this one.
String	toString()
String	toStringFull()	Returns the full string representation, with source (if any), and property designator (if any)
String	toStringPartial()	Returns the string representation of the path without the source or the property.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.common.Path

getLastPathComponent, getPathComponent, getPathLength

Methods inherited from interface com.inductiveautomation.ignition.common.tags.model.TagPath

getChildPath, getChildPath, getItemName, getParentPath, getProperty, getSource

Constructor Details

AbstractTagPath

public AbstractTagPath()

Method Details

toStringFull

public String toStringFull()

Description copied from interface: TagPath

Returns the full string representation, with source (if any), and property designator (if any)

Specified by:

toStringFull in interface TagPath

toStringPartial

public String toStringPartial()

Description copied from interface: TagPath

Returns the string representation of the path without the source or the property.

Specified by:

toStringPartial in interface TagPath

isAncestorOf

public boolean isAncestorOf(Path child)

Description copied from interface: Path

Returns whether the provided path is a child path of this one.

Specified by:

isAncestorOf in interface Path

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

_createPath

protected String _createPath(boolean full)

toString

public String toString()

Overrides:

toString in class Object

compareNullLow

public static int compareNullLow(Property<?> c1,
 Property<?> c2)

Null-safe compare. Null is the lowest value possible.

compareTo

public int compareTo(TagPath that)

Specified by:

compareTo in interface Comparable<TagPath>