Package com.inductiveautomation.ignition.common

Class StringPath

java.lang.Object

com.inductiveautomation.ignition.common.StringPath

All Implemented Interfaces:

Path, Serializable, Comparable<StringPath>

Direct Known Subclasses:

StringPath.CaseSensitiveStringPath

public class StringPath
extends Object
implements Path, Comparable<StringPath>

A simple path based on string based path components. Comparisons are made in a case-insensitive manner.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringPath.CaseSensitiveStringPath	A case-sensitive subclass of StringPath.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH_RELATIVE
static final String	PATH_RELATIVE_UP
static final String	PATH_SEPARATOR
static final StringPath	ROOT	An empty StringPath, i.e.

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

SERIALIZATION_WHITELIST

Constructor Summary

Constructors

Constructor	Description
StringPath(String[] parts)

Method Summary

Modifier and Type	Method	Description
StringPath.CaseSensitiveStringPath	caseSensitive()	Create a new StringPath.CaseSensitiveStringPath that has the same parts as this StringPath.
int	compareTo(StringPath that)
boolean	equals(Object obj)
static StringPath	extend(StringPath parent, StringPath other)
static StringPath	extend(StringPath parent, String... subparts)
static StringPath	from(TagPath path)	Creates a string path from a tag path.
static StringPath	from(TagPath path)	Creates a string path from a tag path.
StringPath	getChildPath(String... pathParts)
String	getLastPathComponent()	Convenience function to return the last path element.
StringPath	getParentPath()	Returns the parent, or null if at the root level.
String[]	getParts()
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.
boolean	isParentOf(Path child)
static boolean	isRelative(StringPath path)
boolean	isRoot()
static StringPath	makeRelative(StringPath toRelative, StringPath root)
static StringPath	of(String... parts)
static StringPath	parse(String value)
static StringPath	removeRelative(StringPath relative, StringPath root)
StringPath	subPath()	Returns the path, minus the first element.
StringPath	subPath(int start, int len)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

ROOT

public static final StringPath ROOT

An empty StringPath, i.e. a path with zero components and zero length.

PATH_SEPARATOR

public static final String PATH_SEPARATOR

See Also:

• Constant Field Values

PATH_RELATIVE

public static final String PATH_RELATIVE

See Also:

• Constant Field Values

PATH_RELATIVE_UP

public static final String PATH_RELATIVE_UP

See Also:

• Constant Field Values

Constructor Details

StringPath

public StringPath(String[] parts)

Method Details

getParts

public String[] getParts()

of

public static StringPath of(String... parts)

from

public static StringPath from(TagPath path)

Creates a string path from a tag path. String paths do not support Source or Property, so those elements will be ignored.

from

public static StringPath from(TagPath path)

Creates a string path from a tag path. String paths do not support Source or Property, so those elements will be ignored.

parse

public static StringPath parse(String value)

Parameters:

value - A path to parse, like "path/to/thing". Null will be treated like empty string: both will create a path of zero length.

extend

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

extend

public static StringPath extend(StringPath parent,
 StringPath other)

makeRelative

public static StringPath makeRelative(StringPath toRelative,
 StringPath root)

isRelative

public static boolean isRelative(StringPath path)

removeRelative

public static StringPath removeRelative(StringPath relative,
 StringPath root)

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

subPath

public StringPath subPath()

Returns the path, minus the first element.

subPath

public StringPath subPath(int start,
 int len)

getParentPath

public StringPath getParentPath()

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

Specified by:

getParentPath in interface Path

getChildPath

public StringPath getChildPath(String... pathParts)

getPathComponent

public String getPathComponent(int i)

Description copied from interface: Path

Returns the path element at the specified location.

Specified by:

getPathComponent in interface Path

getLastPathComponent

public String getLastPathComponent()

Description copied from interface: Path

Convenience function to return the last path element.

Specified by:

getLastPathComponent in interface Path

isRoot

public boolean isRoot()

Returns:

true if the path length is zero

isParentOf

public boolean isParentOf(Path child)

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

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(StringPath that)

Specified by:

compareTo in interface Comparable<StringPath>

caseSensitive

public StringPath.CaseSensitiveStringPath caseSensitive()

Create a new StringPath.CaseSensitiveStringPath that has the same parts as this StringPath.

Returns:

a StringPath.CaseSensitiveStringPath.