Package com.inductiveautomation.ignition.common

Interface Path

All Superinterfaces:
Serializable
All Known Subinterfaces:
TagPath, TagPath
All Known Implementing Classes:
AbstractTagPath, AbstractTagPath, BasicTagPath, BasicTagPath, PropertyAlteredTagPath, PropertyAlteredTagPath, QualifiedPath, SimplifiedTagPath, SimplifiedTagPath, SourceAlteredTagPath, SourceAlteredTagPath, StringPath, StringPath.CaseSensitiveStringPath
public interface Path extends Serializable

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Set<Class<?>>
    SERIALIZATION_WHITELIST
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getLastPathComponent()
    Convenience function to return the last path element.
    Path
    getParentPath()
    Returns a path representing the element above the current path.
    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.

  • Field Details

    • SERIALIZATION_WHITELIST

      static final Set<Class<?>> SERIALIZATION_WHITELIST

  • Method Details

    • getPathLength

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

    • getPathComponent

      String getPathComponent(int i)
      Returns the path element at the specified location.

    • getLastPathComponent

      String getLastPathComponent()
      Convenience function to return the last path element.

    • isAncestorOf

      boolean isAncestorOf(Path path)
      Returns whether the provided path is a child path of this one.

    • getParentPath

      Path getParentPath()
      Returns a path representing the element above the current path.