com.inductiveautomation.ignition.common

Interface Path

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

TagPath

All Known Implementing Classes:

AbstractTagPath, BasicTagPath, PropertyAlteredTagPath, QualifiedPath, SimplifiedTagPath, SourceAlteredTagPath, StringPath

public interface Path
extends java.io.Serializable

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLastPathComponent() Convenience function to return the last path element.
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().
boolean	isAncestorOf(Path path) Returns whether the provided path is a child path of this one.

Method Detail

getPathLength

int getPathLength()

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

Returns:

getPathComponent

java.lang.String getPathComponent(int i)

Returns the path element at the specified location.

Parameters:

i -

Returns:

getLastPathComponent

java.lang.String getLastPathComponent()

Convenience function to return the last path element.

Returns:

isAncestorOf

boolean isAncestorOf(Path path)

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

Parameters:

path -

Returns: