Package com.inductiveautomation.ignition.common

Record Class StringPath.CaseSensitiveStringPath.AlignmentResult

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.StringPath.CaseSensitiveStringPath.AlignmentResult
Record Components:
alignedPath - The aligned path
hasConflict - A conflict occurs when any subpath matches in a case-insensitive manner to the path to align to.
Enclosing class:
StringPath.CaseSensitiveStringPath
public static record StringPath.CaseSensitiveStringPath.AlignmentResult(StringPath.CaseSensitiveStringPath alignedPath, boolean hasConflict) extends Record
Result of an alignment operation.

  • Constructor Details

    • AlignmentResult

      public AlignmentResult(StringPath.CaseSensitiveStringPath alignedPath, boolean hasConflict)
      Creates an instance of a AlignmentResult record class.
      Parameters:
      alignedPath - the value for the alignedPath record component
      hasConflict - the value for the hasConflict record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • alignedPath

      public StringPath.CaseSensitiveStringPath alignedPath()
      Returns the value of the alignedPath record component.
      Returns:
      the value of the alignedPath record component

    • hasConflict

      public boolean hasConflict()
      Returns the value of the hasConflict record component.
      Returns:
      the value of the hasConflict record component