com.inductiveautomation.ignition.common

Class StringPath

java.lang.Object

com.inductiveautomation.ignition.common.StringPath

All Implemented Interfaces:

Path, java.io.Serializable

public class StringPath
extends java.lang.Object
implements Path

A simple path based on string based path components.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PATH_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
StringPath(java.lang.String[] parts)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static StringPath	extend(StringPath parent, java.lang.String... subparts)
static StringPath	extend(StringPath parent, StringPath other)
static StringPath	from(TagPath path)
StringPath	getChildPath(java.lang.String nextId)
java.lang.String	getLastPathComponent() Convenience function to return the last path element.
StringPath	getParentPath() Returns the parent, or NULL if at the root level.
java.lang.String[]	getParts()
java.lang.String	getPathComponent(int i) Returns the path element at the specified location.
int	getPathLength() Returns the number of elements in the path, which can be retrieved through getPathComponent().
int	hashCode()
boolean	isAncestorOf(Path child) Returns whether the provided path is a child path of this one.
static StringPath	of(java.lang.String... parts)
static StringPath	parse(java.lang.String value)
StringPath	subPath() Returns the path, minus the first element.
StringPath	subPath(int start, int len)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SEPARATOR

public static final java.lang.String PATH_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

StringPath

public StringPath(java.lang.String[] parts)

Method Detail

getParts

public java.lang.String[] getParts()

of

public static StringPath of(java.lang.String... parts)

from

public static StringPath from(TagPath path)

parse

public static StringPath parse(java.lang.String value)

extend

public static StringPath extend(StringPath parent,
                                java.lang.String... subparts)

extend

public static StringPath extend(StringPath parent,
                                StringPath other)

getPathLength

public int getPathLength()

Description copied from interface: Path

Returns the number of elements in the path, which can be retrieved through getPathComponent().

Specified by:

getPathLength in interface Path

Returns:

subPath

public StringPath subPath()

Returns the path, minus the first element.

Returns:

subPath

public StringPath subPath(int start,
                          int len)

getParentPath

public StringPath getParentPath()

Returns the parent, or NULL if at the root level.

getChildPath

public StringPath getChildPath(java.lang.String nextId)

getPathComponent

public java.lang.String getPathComponent(int i)

Description copied from interface: Path

Returns the path element at the specified location.

Specified by:

getPathComponent in interface Path

Returns:

getLastPathComponent

public java.lang.String getLastPathComponent()

Description copied from interface: Path

Convenience function to return the last path element.

Specified by:

getLastPathComponent in interface Path

Returns:

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

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object