Package com.inductiveautomation.ignition.common.tags.paths

Record Class TagPathValidator.ValidatedTagPath

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.common.tags.paths.TagPathValidator.ValidatedTagPath

Enclosing class:

TagPathValidator

public static record TagPathValidator.ValidatedTagPath(String rawPath, TagPath tagPath, TagPathValidator.Quality quality, String message)
extends Record

Constructor Summary

Constructors

Constructor	Description
ValidatedTagPath(String rawPath, TagPath tagPath, TagPathValidator.Quality quality, String message)	Creates an instance of a ValidatedTagPath record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static TagPathValidator.ValidatedTagPath	invalid(String path, TagPathValidator.Quality quality, String error)
String	message()	Returns the value of the message record component.
TagPathValidator.Quality	quality()	Returns the value of the quality record component.
String	rawPath()	Returns the value of the rawPath record component.
TagPath	tagPath()	Returns the value of the tagPath record component.
final String	toString()	Returns a string representation of this record class.
static TagPathValidator.ValidatedTagPath	unvalidated(String path)
static TagPathValidator.ValidatedTagPath	valid(TagPath path)

Methods inherited from class java.lang.Object

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

Constructor Details

ValidatedTagPath

public ValidatedTagPath(String rawPath,
 TagPath tagPath,
 TagPathValidator.Quality quality,
 String message)

Creates an instance of a ValidatedTagPath record class.

Parameters:

rawPath - the value for the rawPath record component

tagPath - the value for the tagPath record component

quality - the value for the quality record component

message - the value for the message record component

Method Details

valid

public static TagPathValidator.ValidatedTagPath valid(TagPath path)

invalid

public static TagPathValidator.ValidatedTagPath invalid(String path,
 TagPathValidator.Quality quality,
 String error)

unvalidated

public static TagPathValidator.ValidatedTagPath unvalidated(String path)

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

rawPath

public String rawPath()

Returns the value of the rawPath record component.

Returns:

the value of the rawPath record component

tagPath

public TagPath tagPath()

Returns the value of the tagPath record component.

Returns:

the value of the tagPath record component

quality

public TagPathValidator.Quality quality()

Returns the value of the quality record component.

Returns:

the value of the quality record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component