Hibernate Validator Engine 8.0.1.Final · org.hibernate.validator.internal.engine.path.PathImpl

Modifier and Type	Field and Description
private NodeImpl	currentLeafNode
private int	hashCode
private static final int	INDEX_GROUP
private static final int	INDEXED_GROUP
private static final String	LEADING_PROPERTY_GROUP Regular expression used to split a string path into its elements.
private static final Log	LOG
private List<Path.Node>	nodeList
private boolean	nodeListRequiresCopy
private static final String	OPTIONAL_INDEX_GROUP
private static final Pattern	PATH_PATTERN
private static final int	PROPERTY_NAME_GROUP
private static final String	PROPERTY_PATH_SEPARATOR
private static final String	REMAINING_PROPERTY_STRING
private static final int	REMAINING_STRING_GROUP
private static final long	serialVersionUID

Access	Constructor and Description
private	PathImpl(PathImpl the path to make a copy of. path) Copy constructor.
private	PathImpl()
private	PathImpl(List<Path.Node> nodeList)

Method Summary

Modifier and Type	Method and Description
public NodeImpl	addBeanNode()
private NodeImpl	addConstructorNode(String name, Class<?>[] parameterTypes)
public NodeImpl	addContainerElementNode(String nodeName)
public NodeImpl	addCrossParameterNode()
private NodeImpl	addMethodNode(String name, Class<?>[] parameterTypes)
public NodeImpl	addParameterNode(String nodeName, int index)
public NodeImpl	addPropertyNode(String nodeName)
public NodeImpl	addReturnValueNode()
public String	asString()
private int	buildHashCode()
public static PathImpl	createCopy(PathImpl path)
public static PathImpl	createCopyWithoutLeafNode(PathImpl path)
public static PathImpl	createPathForExecutable(ExecutableMetaData executable)
public static PathImpl	Returns: a `Path` instance representing the path described by the given string. createPathFromString(String the path as string representation. propertyPath) Returns a `Path` instance representing the path described by the given string.
public static PathImpl	createRootPath()
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public NodeImpl	getLeafNode()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	isRootPath()
private static boolean	Returns: true if the given identifier is a valid Java Identifier isValidJavaIdentifier(String string identifier to validate identifier) Validate that the given identifier is a valid Java identifier according to the Java Language Specification, chapter 3.8
public Iterator<Path.Node>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public NodeImpl	makeLeafNodeIterable()
public NodeImpl	makeLeafNodeIterableAndSetIndex(Integer index)
public NodeImpl	makeLeafNodeIterableAndSetMapKey(Object key)
private static PathImpl	parseProperty(String propertyName)
public void	removeLeafNode()
private void	requiresWriteableNodeList()
private void	resetHashCode()
public NodeImpl	setLeafNodeTypeParameter(Class<?> containerClass, Integer typeArgumentIndex)
public NodeImpl	setLeafNodeValueIfRequired(Object value)
public String	toString() Overrides java.lang.Object.toString. Implements jakarta.validation.Path.toString. Returns a human-readable representation of this path.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

currentLeafNode	back to summary
private NodeImpl currentLeafNode

hashCode	back to summary
private int hashCode

INDEX_GROUP	back to summary
private static final int INDEX_GROUP

INDEXED_GROUP	back to summary
private static final int INDEXED_GROUP

LEADING_PROPERTY_GROUP	back to summary
private static final String LEADING_PROPERTY_GROUP Regular expression used to split a string path into its elements. See Also Regular expression tester

LOG	back to summary
private static final Log LOG

nodeList	back to summary
private List<Path.Node> nodeList

nodeListRequiresCopy	back to summary
private boolean nodeListRequiresCopy

OPTIONAL_INDEX_GROUP	back to summary
private static final String OPTIONAL_INDEX_GROUP

PATH_PATTERN	back to summary
private static final Pattern PATH_PATTERN

PROPERTY_NAME_GROUP	back to summary
private static final int PROPERTY_NAME_GROUP

PROPERTY_PATH_SEPARATOR	back to summary
private static final String PROPERTY_PATH_SEPARATOR

REMAINING_PROPERTY_STRING	back to summary
private static final String REMAINING_PROPERTY_STRING

REMAINING_STRING_GROUP	back to summary
private static final int REMAINING_STRING_GROUP

serialVersionUID	back to summary
private static final long serialVersionUID

PathImpl	back to summary
private PathImpl(PathImpl path) Copy constructor. Parameters path:PathImpl the path to make a copy of.

PathImpl	back to summary
private PathImpl()

PathImpl	back to summary
private PathImpl(List<Path.Node> nodeList)

Method Detail

addBeanNode	back to summary
public NodeImpl addBeanNode()

addConstructorNode	back to summary
private NodeImpl addConstructorNode(String name, Class<?>[] parameterTypes)

addContainerElementNode	back to summary
public NodeImpl addContainerElementNode(String nodeName)

addCrossParameterNode	back to summary
public NodeImpl addCrossParameterNode()

addMethodNode	back to summary
private NodeImpl addMethodNode(String name, Class<?>[] parameterTypes)

addParameterNode	back to summary
public NodeImpl addParameterNode(String nodeName, int index)

addPropertyNode	back to summary
public NodeImpl addPropertyNode(String nodeName)

addReturnValueNode	back to summary
public NodeImpl addReturnValueNode()

asString	back to summary
public String asString()

buildHashCode	back to summary
private int buildHashCode()

createCopy	back to summary
public static PathImpl createCopy(PathImpl path)

createCopyWithoutLeafNode	back to summary
public static PathImpl createCopyWithoutLeafNode(PathImpl path)

createPathForExecutable	back to summary
public static PathImpl createPathForExecutable(ExecutableMetaData executable)

createPathFromString back to summary

createPathFromString	back to summary
public static PathImpl createPathFromString(String propertyPath) Returns a `Path` instance representing the path described by the given string. To create a root node the empty string should be passed. Parameters propertyPath:String the path as string representation. Returns:PathImpl a `Path` instance representing the path described by the given string. Exceptions IllegalArgumentException: in case `property == null` or `property` cannot be parsed.

public static PathImpl createPathFromString(String propertyPath)

Returns a Path instance representing the path described by the given string. To create a root node the empty string should be passed.

Parameters

propertyPath:String: the path as string representation.

Returns:PathImpl

a Path instance representing the path described by the given string.

Exceptions

IllegalArgumentException:: in case property == null or property cannot be parsed.

createRootPath	back to summary
public static PathImpl createRootPath()

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getLeafNode	back to summary
public NodeImpl getLeafNode()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

isRootPath	back to summary
public boolean isRootPath()

isValidJavaIdentifier back to summary

isValidJavaIdentifier	back to summary
private static boolean isValidJavaIdentifier(String identifier) Validate that the given identifier is a valid Java identifier according to the Java Language Specification, chapter 3.8 Parameters identifier:String string identifier to validate Returns:boolean true if the given identifier is a valid Java Identifier Exceptions IllegalArgumentException: if the given identifier is `null`

private static boolean isValidJavaIdentifier(String identifier)

Validate that the given identifier is a valid Java identifier according to the Java Language Specification, chapter 3.8

Parameters

identifier:String: string identifier to validate

Returns:boolean

true if the given identifier is a valid Java Identifier

Exceptions

IllegalArgumentException:: if the given identifier is null

iterator back to summary

iterator	back to summary
public Iterator<Path.Node> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Returns:Iterator<Path.Node> an Iterator. Annotations @Override

public Iterator<Path.Node> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<Path.Node>

an Iterator.

Annotations

@Override

makeLeafNodeIterable	back to summary
public NodeImpl makeLeafNodeIterable()

makeLeafNodeIterableAndSetIndex	back to summary
public NodeImpl makeLeafNodeIterableAndSetIndex(Integer index)

makeLeafNodeIterableAndSetMapKey	back to summary
public NodeImpl makeLeafNodeIterableAndSetMapKey(Object key)

parseProperty	back to summary
private static PathImpl parseProperty(String propertyName)

removeLeafNode	back to summary
public void removeLeafNode()

requiresWriteableNodeList	back to summary
private void requiresWriteableNodeList()

resetHashCode	back to summary
private void resetHashCode()

setLeafNodeTypeParameter	back to summary
public NodeImpl setLeafNodeTypeParameter(Class<?> containerClass, Integer typeArgumentIndex)

setLeafNodeValueIfRequired	back to summary
public NodeImpl setLeafNodeValueIfRequired(Object value)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Implements jakarta.validation.Path.toString.

Doc from jakarta.validation.Path.toString.

Returns a human-readable representation of this path.

Clients should not rely on any specific structure of the returned value. Instead they should iterate through the path nodes and obtain any required information by calling the methods on Node and its sub-types.

Returns:String

a human-readable representation of this path

Annotations

@Override

public final Class PathImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail