Package org.hibernate.validator.internal.engine.path

Class NodeImpl

java.lang.Object

org.hibernate.validator.internal.engine.path.NodeImpl

All Implemented Interfaces:

Path.BeanNode, Path.ConstructorNode, Path.ContainerElementNode, Path.CrossParameterNode, Path.MethodNode, Path.Node, Path.ParameterNode, Path.PropertyNode, Path.ReturnValueNode, Serializable, ContainerElementNode, PropertyNode

public class NodeImpl
extends Object
implements Path.PropertyNode, Path.MethodNode, Path.ConstructorNode, Path.BeanNode, Path.ParameterNode, Path.ReturnValueNode, Path.CrossParameterNode, Path.ContainerElementNode, PropertyNode, ContainerElementNode, Serializable

Immutable implementation of a Path.Node.

Author:

Hardy Ferentschik, Gunnar Morling, Guillaume Smet

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	CROSS_PARAMETER_NODE_NAME
static String	ITERABLE_ELEMENT_NODE_NAME
static String	LIST_ELEMENT_NODE_NAME
static String	MAP_KEY_NODE_NAME
static String	MAP_VALUE_NODE_NAME
static String	RETURN_VALUE_NODE_NAME

Method Summary

Modifier and Type	Method	Description
<T extends Path.Node> T	as(Class<T> nodeType)	Narrows the type of this node down to the given type.
String	asString()
int	buildHashCode()
static NodeImpl	createBeanNode(NodeImpl parent)
static NodeImpl	createConstructorNode(String name, NodeImpl parent, Class<?>[] parameterTypes)
static NodeImpl	createContainerElementNode(String name, NodeImpl parent)
static NodeImpl	createCrossParameterNode(NodeImpl parent)
static NodeImpl	createMethodNode(String name, NodeImpl parent, Class<?>[] parameterTypes)
static NodeImpl	createParameterNode(String name, NodeImpl parent, int parameterIndex)
static NodeImpl	createPropertyNode(String name, NodeImpl parent)
static NodeImpl	createReturnValue(NodeImpl parent)
boolean	equals(Object obj)
Class<?>	getContainerClass()
Integer	getIndex()
Object	getKey()
ElementKind	getKind()	The kind of element represented by the node.
String	getName()	Returns the name of the element which the node represents: null if it is a leaf node which represents an entity / bean.
int	getParameterIndex()
List<Class<?>>	getParameterTypes()
NodeImpl	getParent()
Integer	getTypeArgumentIndex()
Object	getValue()
int	hashCode()
boolean	isInIterable()
boolean	isIterable()
static NodeImpl	makeIterable(NodeImpl node)
static NodeImpl	makeIterableAndSetIndex(NodeImpl node, Integer index)
static NodeImpl	makeIterableAndSetMapKey(NodeImpl node, Object key)
static NodeImpl	setPropertyValue(NodeImpl node, Object value)
static NodeImpl	setTypeParameter(NodeImpl node, Class<?> containerClass, Integer typeArgumentIndex)
String	toString()	Returns a human-readable representation of this node.

Methods inherited from class java.lang.Object

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

Field Detail

RETURN_VALUE_NODE_NAME

public static final String RETURN_VALUE_NODE_NAME

See Also:

Constant Field Values

CROSS_PARAMETER_NODE_NAME

public static final String CROSS_PARAMETER_NODE_NAME

See Also:

Constant Field Values

ITERABLE_ELEMENT_NODE_NAME

public static final String ITERABLE_ELEMENT_NODE_NAME

See Also:

Constant Field Values

LIST_ELEMENT_NODE_NAME

public static final String LIST_ELEMENT_NODE_NAME

See Also:

Constant Field Values

MAP_KEY_NODE_NAME

public static final String MAP_KEY_NODE_NAME

See Also:

Constant Field Values

MAP_VALUE_NODE_NAME

public static final String MAP_VALUE_NODE_NAME

See Also:

Constant Field Values

Method Detail

createPropertyNode

public static NodeImpl createPropertyNode(String name,
                                          NodeImpl parent)

createContainerElementNode

public static NodeImpl createContainerElementNode(String name,
                                                  NodeImpl parent)

createParameterNode

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

createCrossParameterNode

public static NodeImpl createCrossParameterNode(NodeImpl parent)

createMethodNode

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

createConstructorNode

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

createBeanNode

public static NodeImpl createBeanNode(NodeImpl parent)

createReturnValue

public static NodeImpl createReturnValue(NodeImpl parent)

makeIterable

public static NodeImpl makeIterable(NodeImpl node)

makeIterableAndSetIndex

public static NodeImpl makeIterableAndSetIndex(NodeImpl node,
                                               Integer index)

makeIterableAndSetMapKey

public static NodeImpl makeIterableAndSetMapKey(NodeImpl node,
                                                Object key)

setPropertyValue

public static NodeImpl setPropertyValue(NodeImpl node,
                                        Object value)

setTypeParameter

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

getName

public final String getName()

Description copied from interface: Path.Node

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.

Specified by:

getName in interface Path.Node

Returns:

name of the element which the node represents

isInIterable

public final boolean isInIterable()

Specified by:

isInIterable in interface Path.Node

Returns:

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

isIterable

public final boolean isIterable()

getIndex

public final Integer getIndex()

Specified by:

getIndex in interface Path.Node

Returns:

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

getKey

public final Object getKey()

Specified by:

getKey in interface Path.Node

Returns:

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

getContainerClass

public Class<?> getContainerClass()

Specified by:

getContainerClass in interface Path.BeanNode

Specified by:

getContainerClass in interface Path.ContainerElementNode

Specified by:

getContainerClass in interface Path.PropertyNode

Returns:

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

getTypeArgumentIndex

public Integer getTypeArgumentIndex()

Specified by:

getTypeArgumentIndex in interface Path.BeanNode

Specified by:

getTypeArgumentIndex in interface Path.ContainerElementNode

Specified by:

getTypeArgumentIndex in interface Path.PropertyNode

Returns:

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

getParent

public final NodeImpl getParent()

getKind

public ElementKind getKind()

Description copied from interface: Path.Node

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

• ElementKind.BEAN: Path.BeanNode
• ElementKind.PROPERTY: Path.PropertyNode
• ElementKind.METHOD: Path.MethodNode
• ElementKind.CONSTRUCTOR: Path.ConstructorNode
• ElementKind.PARAMETER: Path.ParameterNode
• ElementKind.CROSS_PARAMETER: Path.CrossParameterNode
• ElementKind.RETURN_VALUE: Path.ReturnValueNode
• ElementKind.CONTAINER_ELEMENT: Path.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();
 [...]
 }
 

Specified by:

getKind in interface Path.Node

Returns:

the ElementKind

as

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

Description copied from interface: Path.Node

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

Specified by:

as in interface Path.Node

Type Parameters:

T - the type to narrow down to

Parameters:

nodeType - class object representing the descriptor type to narrow down to to

Returns:

this node narrowed down to the given type.

getParameterTypes

public List<Class<?>> getParameterTypes()

Specified by:

getParameterTypes in interface Path.ConstructorNode

Specified by:

getParameterTypes in interface Path.MethodNode

Returns:

the list of parameter types

getParameterIndex

public int getParameterIndex()

Specified by:

getParameterIndex in interface Path.ParameterNode

Returns:

the parameter index in the method or constructor definition

getValue

public Object getValue()

Specified by:

getValue in interface ContainerElementNode

Specified by:

getValue in interface PropertyNode

Returns:

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

toString

public String toString()

Description copied from interface: Path.Node

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.

Specified by:

toString in interface Path.Node

Overrides:

toString in class Object

Returns:

a human-readable representation of this node

asString

public final String asString()

buildHashCode

public final int buildHashCode()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object