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

Modifier and Type	Field and Description
private String	asString
private final Class<?>	containerClass
public static final String	CROSS_PARAMETER_NODE_NAME
private static final Class<?>[]	EMPTY_CLASS_ARRAY
private int	hashCode
private final Integer	index
private static final String	INDEX_CLOSE
private static final String	INDEX_OPEN
private final boolean	isIterable
public static final String	ITERABLE_ELEMENT_NODE_NAME
private final Object	key
private final ElementKind	kind
public static final String	LIST_ELEMENT_NODE_NAME
private static final Log	LOG
public static final String	MAP_KEY_NODE_NAME
public static final String	MAP_VALUE_NODE_NAME
private final String	name
private final Integer	parameterIndex
private final Class<?>[]	parameterTypes
private final NodeImpl	parent
public static final String	RETURN_VALUE_NODE_NAME
private static final long	serialVersionUID
private static final String	TYPE_PARAMETER_CLOSE
private static final String	TYPE_PARAMETER_OPEN
private final Integer	typeArgumentIndex
private final Object	value

Access	Constructor and Description
private	NodeImpl(String name, NodeImpl parent, boolean isIterable, Integer index, Object key, ElementKind kind, Class<?>[] parameterTypes, Integer parameterIndex, Object value, Class<?> containerClass, Integer typeArgumentIndex)

Method Summary

Modifier and Type	Method and Description
public <T extends Path.Node> T	as(Class<T> class object representing the descriptor type to narrow down to to nodeType) Implements jakarta.validation.Path.Node.as. Narrows the type of this node down to the given type.
public final String	asString()
public final int	buildHashCode()
private String	buildToString()
public static NodeImpl	createBeanNode(NodeImpl parent)
public static NodeImpl	createConstructorNode(String name, NodeImpl parent, Class<?>[] parameterTypes)
public static NodeImpl	createContainerElementNode(String name, NodeImpl parent)
public static NodeImpl	createCrossParameterNode(NodeImpl parent)
public static NodeImpl	createMethodNode(String name, NodeImpl parent, Class<?>[] parameterTypes)
public static NodeImpl	createParameterNode(String name, NodeImpl parent, int parameterIndex)
public static NodeImpl	createPropertyNode(String name, NodeImpl parent)
public static NodeImpl	createReturnValue(NodeImpl parent)
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 Class<?>	getContainerClass() Implements jakarta.validation.Path.PropertyNode.getContainerClass, jakarta.validation.Path.BeanNode.getContainerClass, jakarta.validation.Path.ContainerElementNode.getContainerClass.
public final Integer	getIndex() Implements jakarta.validation.Path.Node.getIndex.
public final Object	getKey() Implements jakarta.validation.Path.Node.getKey.
public ElementKind	getKind() Implements jakarta.validation.Path.Node.getKind. The kind of element represented by the node.
public final String	getName() Implements jakarta.validation.Path.Node.getName. Returns the name of the element which the node represents: `null` if it is a leaf node which represents an entity / bean. In particular, the node representing the root object. The property name for a property. The method name for a method. The unqualified name of the type declaring the constructor for a constructor. The parameter named as defined by the `ParameterNameProvider` for a method or constructor parameter. The literal `<cross-parameter>` for a method or constructor cross-parameter. The literal `<return value>` for a method or constructor return value. The node name as defined by the `ValueExtractor` for a container element; specifically, the literal `<list element>` for elements stored in a list, the literal `<iterable element>` for elements stored in an `Iterable`, the literal `<map key>` for the keys stored in a `Map` and the literal `<map value>` for the values stored in a `Map`.
public int	getParameterIndex() Implements jakarta.validation.Path.ParameterNode.getParameterIndex.
public List<Class<?>>	getParameterTypes() Implements jakarta.validation.Path.MethodNode.getParameterTypes, jakarta.validation.Path.ConstructorNode.getParameterTypes.
public final NodeImpl	getParent()
public Integer	getTypeArgumentIndex() Implements jakarta.validation.Path.PropertyNode.getTypeArgumentIndex, jakarta.validation.Path.BeanNode.getTypeArgumentIndex, jakarta.validation.Path.ContainerElementNode.getTypeArgumentIndex.
public Object	getValue() Implements org.hibernate.validator.path.PropertyNode.getValue, org.hibernate.validator.path.ContainerElementNode.getValue.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
private static boolean	includeTypeParameterInformation(Class<?> containerClass, Integer typeArgumentIndex)
public final boolean	isInIterable() Implements jakarta.validation.Path.Node.isInIterable.
public final boolean	isIterable()
public static NodeImpl	makeIterable(NodeImpl node)
public static NodeImpl	makeIterableAndSetIndex(NodeImpl node, Integer index)
public static NodeImpl	makeIterableAndSetMapKey(NodeImpl node, Object key)
public static NodeImpl	setPropertyValue(NodeImpl node, Object value)
public static NodeImpl	setTypeParameter(NodeImpl node, Class<?> containerClass, Integer typeArgumentIndex)
public String	toString() Overrides java.lang.Object.toString. Implements jakarta.validation.Path.Node.toString. Returns a human-readable representation of this node.

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

asString	back to summary
private String asString

containerClass	back to summary
private final Class<?> containerClass

CROSS_PARAMETER_NODE_NAME	back to summary
public static final String CROSS_PARAMETER_NODE_NAME

EMPTY_CLASS_ARRAY	back to summary
private static final Class<?>[] EMPTY_CLASS_ARRAY

hashCode	back to summary
private int hashCode

index	back to summary
private final Integer index

INDEX_CLOSE	back to summary
private static final String INDEX_CLOSE

INDEX_OPEN	back to summary
private static final String INDEX_OPEN

isIterable	back to summary
private final boolean isIterable

ITERABLE_ELEMENT_NODE_NAME	back to summary
public static final String ITERABLE_ELEMENT_NODE_NAME

key	back to summary
private final Object key

kind	back to summary
private final ElementKind kind

LIST_ELEMENT_NODE_NAME	back to summary
public static final String LIST_ELEMENT_NODE_NAME

LOG	back to summary
private static final Log LOG

MAP_KEY_NODE_NAME	back to summary
public static final String MAP_KEY_NODE_NAME

MAP_VALUE_NODE_NAME	back to summary
public static final String MAP_VALUE_NODE_NAME

name	back to summary
private final String name

parameterIndex	back to summary
private final Integer parameterIndex

parameterTypes	back to summary
private final Class<?>[] parameterTypes

parent	back to summary
private final NodeImpl parent

RETURN_VALUE_NODE_NAME	back to summary
public static final String RETURN_VALUE_NODE_NAME

serialVersionUID	back to summary
private static final long serialVersionUID

TYPE_PARAMETER_CLOSE	back to summary
private static final String TYPE_PARAMETER_CLOSE

TYPE_PARAMETER_OPEN	back to summary
private static final String TYPE_PARAMETER_OPEN

typeArgumentIndex	back to summary
private final Integer typeArgumentIndex

value	back to summary
private final Object value

NodeImpl	back to summary
private NodeImpl(String name, NodeImpl parent, boolean isIterable, Integer index, Object key, ElementKind kind, Class<?>[] parameterTypes, Integer parameterIndex, Object value, Class<?> containerClass, Integer typeArgumentIndex)

Method Detail

as back to summary

as	back to summary
public <T extends Path.Node> T as(Class<T> nodeType) Implements jakarta.validation.Path.Node.as. Doc from jakarta.validation.Path.Node.as. Narrows the type of this node down to the given type. The appropriate type should be checked before by calling `getKind()`. Parameters <T> the type to narrow down to nodeType:Class<T> class object representing the descriptor type to narrow down to to Returns:T this node narrowed down to the given type. Annotations @Override

public <T extends Path.Node> T as(Class<T> nodeType)

Implements jakarta.validation.Path.Node.as.

Doc from jakarta.validation.Path.Node.as.

Narrows the type of this node down to the given type. The appropriate type should be checked before by calling getKind().

Parameters

<T>: the type to narrow down to
nodeType:Class<T>: class object representing the descriptor type to narrow down to to

Returns:T

this node narrowed down to the given type.

Annotations

@Override

asString	back to summary
public final String asString()

buildHashCode	back to summary
public final int buildHashCode()

buildToString	back to summary
private String buildToString()

createBeanNode	back to summary
public static NodeImpl createBeanNode(NodeImpl parent)

createConstructorNode	back to summary
public static NodeImpl createConstructorNode(String name, NodeImpl parent, Class<?>[] parameterTypes)

createContainerElementNode	back to summary
public static NodeImpl createContainerElementNode(String name, NodeImpl parent)

createCrossParameterNode	back to summary
public static NodeImpl createCrossParameterNode(NodeImpl parent)

createMethodNode	back to summary
public static NodeImpl createMethodNode(String name, NodeImpl parent, Class<?>[] parameterTypes)

createParameterNode	back to summary
public static NodeImpl createParameterNode(String name, NodeImpl parent, int parameterIndex)

createPropertyNode	back to summary
public static NodeImpl createPropertyNode(String name, NodeImpl parent)

createReturnValue	back to summary
public static NodeImpl createReturnValue(NodeImpl parent)

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

getContainerClass back to summary

getContainerClass	back to summary
public Class<?> getContainerClass() Implements jakarta.validation.Path.PropertyNode.getContainerClass, jakarta.validation.Path.BeanNode.getContainerClass, jakarta.validation.Path.ContainerElementNode.getContainerClass. Returns:Class<?> Doc from jakarta.validation.Path.PropertyNode.getContainerClass. the type of the container the node is placed in, if contained in a container type such as `Optional`, `List` or `Map`, `null` otherwise Annotations @Override

public Class<?> getContainerClass()

Implements jakarta.validation.Path.PropertyNode.getContainerClass, jakarta.validation.Path.BeanNode.getContainerClass, jakarta.validation.Path.ContainerElementNode.getContainerClass.

Returns:Class<?>

Doc from jakarta.validation.Path.PropertyNode.getContainerClass.

the type of the container the node is placed in, if contained in a container type such as Optional, List or Map, null otherwise

Annotations

@Override

getIndex back to summary

getIndex	back to summary
public final Integer getIndex() Implements jakarta.validation.Path.Node.getIndex. Returns:Integer Doc from jakarta.validation.Path.Node.getIndex. the index the node is placed in if contained in an array, a `List` or any other container supporting indexed access, `null` otherwise Annotations @Override

public final Integer getIndex()

Implements jakarta.validation.Path.Node.getIndex.

Returns:Integer

Doc from jakarta.validation.Path.Node.getIndex.

the index the node is placed in if contained in an array, a List or any other container supporting indexed access, null otherwise

Annotations

@Override

getKey back to summary

getKey	back to summary
public final Object getKey() Implements jakarta.validation.Path.Node.getKey. Returns:Object Doc from jakarta.validation.Path.Node.getKey. the key the node is placed in if contained in a `Map` or any other container supporting keyed access, `null` otherwise Annotations @Override

public final Object getKey()

Implements jakarta.validation.Path.Node.getKey.

Returns:Object

Doc from jakarta.validation.Path.Node.getKey.

the key the node is placed in if contained in a Map or any other container supporting keyed access, null otherwise

Annotations

@Override

getKind back to summary

getKind	back to summary
public ElementKind getKind() Implements jakarta.validation.Path.Node.getKind. Doc from jakarta.validation.Path.Node.getKind. The kind of element represented by the node. The following relationship between an `ElementKind` and its `Node` subtype exists: `ElementKind#BEAN`: `BeanNode` `ElementKind#PROPERTY`: `PropertyNode` `ElementKind#METHOD`: `MethodNode` `ElementKind#CONSTRUCTOR`: `ConstructorNode` `ElementKind#PARAMETER`: `ParameterNode` `ElementKind#CROSS_PARAMETER`: `CrossParameterNode` `ElementKind#RETURN_VALUE`: `ReturnValueNode` `ElementKind#CONTAINER_ELEMENT`: `ContainerElementNode` This is useful to narrow down the `Node` type and access node specific information: switch(node.getKind() { case METHOD: name = node.getName(); params = node.as(MethodNode.class).getParameterTypes(); case PARAMETER: index = node.as(ParameterNode.class).getParameterIndex(); [...] } Returns:ElementKind the `ElementKind` Annotations @Override

public ElementKind getKind()

Implements jakarta.validation.Path.Node.getKind.

Doc from jakarta.validation.Path.Node.getKind.

The kind of element represented by the node. The following relationship between an ElementKind and its Node subtype exists:

This is useful to narrow down the Node type and access node specific information:

switch(node.getKind() {
case METHOD:
    name = node.getName();
    params = node.as(MethodNode.class).getParameterTypes();
case PARAMETER:
    index = node.as(ParameterNode.class).getParameterIndex();
[...]
}

Returns:ElementKind

the ElementKind

Annotations

@Override

getName back to summary

getName	back to summary
public final String getName() Implements jakarta.validation.Path.Node.getName. Doc from jakarta.validation.Path.Node.getName. Returns the name of the element which the node represents: `null` if it is a leaf node which represents an entity / bean. In particular, the node representing the root object. The property name for a property. The method name for a method. The unqualified name of the type declaring the constructor for a constructor. The parameter named as defined by the `ParameterNameProvider` for a method or constructor parameter. The literal `<cross-parameter>` for a method or constructor cross-parameter. The literal `<return value>` for a method or constructor return value. The node name as defined by the `ValueExtractor` for a container element; specifically, the literal `<list element>` for elements stored in a list, the literal `<iterable element>` for elements stored in an `Iterable`, the literal `<map key>` for the keys stored in a `Map` and the literal `<map value>` for the values stored in a `Map`. Returns:String name of the element which the node represents Annotations @Override

public final String getName()

Implements jakarta.validation.Path.Node.getName.

Doc from jakarta.validation.Path.Node.getName.

Returns the name of the element which the node represents:

null if it is a leaf node which represents an entity / bean. In particular, the node representing the root object.
The property name for a property.
The method name for a method.
The unqualified name of the type declaring the constructor for a constructor.
The parameter named as defined by the ParameterNameProvider for a method or constructor parameter.
The literal <cross-parameter> for a method or constructor cross-parameter.
The literal <return value> for a method or constructor return value.
The node name as defined by the ValueExtractor for a container element; specifically, the literal <list element> for elements stored in a list, the literal <iterable element> for elements stored in an Iterable, the literal <map key> for the keys stored in a Map and the literal <map value> for the values stored in a Map.

Returns:String

name of the element which the node represents

Annotations

@Override

getParameterIndex	back to summary
public int getParameterIndex() Implements jakarta.validation.Path.ParameterNode.getParameterIndex. Returns:int Doc from jakarta.validation.Path.ParameterNode.getParameterIndex. the parameter index in the method or constructor definition Annotations @Override

getParameterIndex

back to summary

public int getParameterIndex()

Implements jakarta.validation.Path.ParameterNode.getParameterIndex.

Returns:int

Doc from jakarta.validation.Path.ParameterNode.getParameterIndex.

the parameter index in the method or constructor definition

Annotations

@Override

getParameterTypes	back to summary
public List<Class<?>> getParameterTypes() Implements jakarta.validation.Path.MethodNode.getParameterTypes, jakarta.validation.Path.ConstructorNode.getParameterTypes. Returns:List<Class<?>> Doc from jakarta.validation.Path.MethodNode.getParameterTypes. the list of parameter types Annotations @Override

getParameterTypes

back to summary

public List<Class<?>> getParameterTypes()

Implements jakarta.validation.Path.MethodNode.getParameterTypes, jakarta.validation.Path.ConstructorNode.getParameterTypes.

Returns:List<Class<?>>

Doc from jakarta.validation.Path.MethodNode.getParameterTypes.

the list of parameter types

Annotations

@Override

getParent	back to summary
public final NodeImpl getParent()

getTypeArgumentIndex back to summary

public Integer getTypeArgumentIndex()

Implements jakarta.validation.Path.PropertyNode.getTypeArgumentIndex, jakarta.validation.Path.BeanNode.getTypeArgumentIndex, jakarta.validation.Path.ContainerElementNode.getTypeArgumentIndex.

Returns:Integer

Doc from jakarta.validation.Path.PropertyNode.getTypeArgumentIndex.

the index of the type argument affected by the violated constraint, if contained in a generic container type such as Optional, List or Map, null otherwise

Annotations

@Override

getValue

back to summary

public Object getValue()

Implements org.hibernate.validator.path.PropertyNode.getValue, org.hibernate.validator.path.ContainerElementNode.getValue.

Returns:Object

Doc from org.hibernate.validator.path.PropertyNode.getValue.

Returns the value of the bean property represented by this node.

Annotations

@Override

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

includeTypeParameterInformation	back to summary
private static boolean includeTypeParameterInformation(Class<?> containerClass, Integer typeArgumentIndex)

isInIterable back to summary

public final boolean isInIterable()

Implements jakarta.validation.Path.Node.isInIterable.

Returns:boolean

Doc from jakarta.validation.Path.Node.isInIterable.

true if the node represents an object contained in a multi-valued container such as Iterable or Map or an array, false otherwise

Annotations

@Override

isIterable	back to summary
public final boolean isIterable()

makeIterable	back to summary
public static NodeImpl makeIterable(NodeImpl node)

makeIterableAndSetIndex	back to summary
public static NodeImpl makeIterableAndSetIndex(NodeImpl node, Integer index)

makeIterableAndSetMapKey	back to summary
public static NodeImpl makeIterableAndSetMapKey(NodeImpl node, Object key)

setPropertyValue	back to summary
public static NodeImpl setPropertyValue(NodeImpl node, Object value)

setTypeParameter	back to summary
public static NodeImpl setTypeParameter(NodeImpl node, Class<?> containerClass, Integer typeArgumentIndex)

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Implements jakarta.validation.Path.Node.toString.

Doc from jakarta.validation.Path.Node.toString.

Returns a human-readable representation of this node.

Clients should not rely on any specific structure of the returned value. Instead they should obtain any required information by calling the methods on this interface and its sub-types.

Returns:String

a human-readable representation of this node

Annotations

@Override

public Class NodeImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail