Package com.inductiveautomation.ignition.common

Class AdaptedQualifiedPath

java.lang.Object

com.inductiveautomation.ignition.common.QualifiedPath

com.inductiveautomation.ignition.common.AdaptedQualifiedPath

All Implemented Interfaces:

Path, Serializable

public class AdaptedQualifiedPath
extends QualifiedPath

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdaptedQualifiedPath.Builder	Builder class for AdaptedQualifiedPath.

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.common.QualifiedPath

QualifiedPath.Part, QualifiedPath.QualifiedPathSimpleTypeAdapter

Field Summary

Fields inherited from class com.inductiveautomation.ignition.common.QualifiedPath

COMPONENTID_SEPERATOR, PART_SEPERATOR, parts, SUBPART_SEPERATOR

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

SERIALIZATION_WHITELIST

Method Summary

Modifier and Type	Method	Description
AdaptedQualifiedPath	clone()
QualifiedPath	getDeepestOriginalPath()	Gets the deepest original path, unwrapping any nested AdaptedQualifiedPath instances.
QualifiedPath	getOriginalPath()	Gets the original, non-normalized path.
boolean	isAdaptedPath()	Checks if this path has been adapted (i.e., if it's different from the original path).
static AdaptedQualifiedPath.Builder	newBuilder()	Creates a builder for AdaptedQualifiedPath.
static AdaptedQualifiedPath	pair(QualifiedPath adaptedPath, QualifiedPath originalPath)	Creates a new AdaptedQualifiedPath.
static AdaptedQualifiedPath	parse(String value)
static AdaptedQualifiedPath	parseSafe(String value)
String	toStringFull()
String	toStringFullSimple()

Methods inherited from class com.inductiveautomation.ignition.common.QualifiedPath

equals, extend, extend, from, getFirstPathComponent, getFirstPathComponentId, getLastPathComponent, getLastPathComponentId, getParentPath, getPart, getPartsFor, getPathComponent, getPathComponent, getPathComponentOrElse, getPathLength, hasAnyPathComponent, hashCode, hasPathComponent, indexOf, insert, insertAfter, isAncestorOf, of, parseSubParts, prepend, remove, replace, strip, subpath, subpath, subpath, subpath, toString, toStringSimple

Methods inherited from class java.lang.Object

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

Method Details

pair

public static AdaptedQualifiedPath pair(QualifiedPath adaptedPath,
 QualifiedPath originalPath)

Creates a new AdaptedQualifiedPath.

Parameters:

adaptedPath - The adapted QualifiedPath

originalPath - The original QualifiedPath

Returns:

A new AdaptedQualifiedPath instance

Throws:

IllegalStateException - if the originalPath chain exceeds MAX_NESTING_DEPTH

getOriginalPath

public QualifiedPath getOriginalPath()

Gets the original, non-normalized path. This returns the immediate original path, which may itself be an AdaptedQualifiedPath if multiple normalizations occurred.

Returns:

The original QualifiedPath (may be an AdaptedQualifiedPath if nested)

See Also:

• getDeepestOriginalPath()

getDeepestOriginalPath

public QualifiedPath getDeepestOriginalPath()

Gets the deepest original path, unwrapping any nested AdaptedQualifiedPath instances. This returns the true user-provided path before any normalization occurred.

Use this method when you need the original path as the user specified it, regardless of how many normalization steps have been applied.

Returns:

The deepest original QualifiedPath (always a plain QualifiedPath, never an AdaptedQualifiedPath)

Throws:

IllegalStateException - if nesting depth exceeds MAX_NESTING_DEPTH, indicating excessive nesting

See Also:

• getOriginalPath()

isAdaptedPath

public boolean isAdaptedPath()

Checks if this path has been adapted (i.e., if it's different from the original path).

Returns:

true if the path has been adapted, false otherwise

clone

public AdaptedQualifiedPath clone()

Overrides:

clone in class QualifiedPath

toStringFullSimple

public String toStringFullSimple()

toStringFull

public String toStringFull()

newBuilder

public static AdaptedQualifiedPath.Builder newBuilder()

Creates a builder for AdaptedQualifiedPath.

Returns:

A new Builder instance

parse

public static AdaptedQualifiedPath parse(String value)
                                  throws IOException

Throws:

IOException

parseSafe

public static AdaptedQualifiedPath parseSafe(String value)