DiffNode

java.lang.Object
- com.fr.common.diff.node.DiffNode

```
public class DiffNode
extends java.lang.Object
```
Represents a part of an object. It could be the object itself, one of its properties, an item in a collection or a map entry. A node may have one parent node and any number of children. It also provides methods to read and write the property represented by this node on any object of the same type as the original object. Last but not least, a node knows how the associated property has changed compared to the base object.

作者:

Daniel Bechler

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`DiffNode.State` The state of a `DiffNode` representing the difference between two objects.
`static interface`	`DiffNode.Visitor` Visitor to traverse a node graph.

字段概要

字段
限定符和类型字段和说明

static DiffNode ROOT

字段
限定符和类型	字段和说明
`static DiffNode`	`ROOT`

构造器概要

构造器
构造器和说明

DiffNode(DiffNode parentNode, Accessor accessor)

DiffNode(DiffNode parentNode, Accessor accessor, java.lang.Class<?> valueType)

构造器
构造器和说明
`DiffNode(DiffNode parentNode, Accessor accessor)`
`DiffNode(DiffNode parentNode, Accessor accessor, java.lang.Class<?> valueType)`

方法概要

方法
限定符和类型	方法和说明
`void`	`addCategories(java.util.Collection<java.lang.String> additionalCategories)`
`void`	`addChild(DiffNode node)` Adds a child to this node and sets this node as its parent node.
`java.lang.Object`	`canonicalGet(java.lang.Object target)`
`void`	`canonicalSet(java.lang.Object target, java.lang.Object value)`
`void`	`canonicalUnset(java.lang.Object target)`
`int`	`childCount()`
`boolean`	`equals(java.lang.Object o)`
`java.lang.Object`	`get(java.lang.Object target)`
`java.util.Set<java.lang.String>`	`getCategories()` Returns an unmodifiable `Set` of `String` with the categories of this node.
`DiffNode`	`getChild(ElementSelector elementSelector)` Retrieve a child that matches the given path element relative to this node.
`DiffNode`	`getChild(java.util.List<ElementSelector> selectors)` Retrieve a child that matches the given path element relative to this node.
`DiffNode`	`getChild(NodePath nodePath)` Retrieve a child that matches the given absolute path, starting from the current node.
`DiffNode`	`getChild(java.lang.String propertyName)` Retrieve a child with the given property name relative to this node.
`DiffNode`	`getCircleStartNode()`
`NodePath`	`getCircleStartPath()`
`ElementSelector`	`getElementSelector()`
`<T extends java.lang.annotation.Annotation> T`	`getFieldAnnotation(java.lang.Class<T> annotationClass)`
`java.util.Set<java.lang.annotation.Annotation>`	`getFieldAnnotations()` If this node represents a bean property this method returns all annotations of its field.
`DiffNode`	`getParentNode()`
`NodePath`	`getPath()`
`<T extends java.lang.annotation.Annotation> T`	`getPropertyAnnotation(java.lang.Class<T> annotationClass)`
`java.util.Set<java.lang.annotation.Annotation>`	`getPropertyAnnotations()` If this node represents a bean property this method returns all annotations of its getter.
`java.lang.String`	`getPropertyName()` If this node represents a bean property, this method will simply return its name.
`DiffNode.State`	`getState()`
`java.lang.Class<?>`	`getValueType()`
`TypeInfo`	`getValueTypeInfo()`
`boolean`	`hasChanges()`
`boolean`	`hasChildren()`
`int`	`hashCode()`
`boolean`	`isAdded()` Convenience method for `getState() == DiffNode.State.ADDED`
`boolean`	`isChanged()` Convenience method for `getState() == DiffNode.State.CHANGED`
`boolean`	`isCircular()` Convenience method for `getState() == DiffNode.State.CIRCULAR`
`boolean`	`isExcluded()` 已过时。 This method was a shortcut to extract the "exclude" flag from the ObjectDiffProperty annotation. Since we found a better way to do that, it is not needed anymore and will be removed in future versions. The name is also misleading. It implies that here lies the truth about the exclusion, but only the InclusionService can tell for sure. This flag is just only little piece of the puzzle.
`boolean`	`isIgnored()` Convenience method for `getState() == DiffNode.State.IGNORED`
`boolean`	`isPropertyAware()` Returns `true` when this node represents a bean property and can therefore be queried for property specific information like annotations or property types.
`boolean`	`isRemoved()` Convenience method for `getState() == DiffNode.State.REMOVED`
`boolean`	`isRootNode()`
`boolean`	`isUntouched()` Convenience method for `getState() == DiffNode.State.UNTOUCHED`
`boolean`	`matches(NodePath path)`
`static DiffNode`	`newRootNode()`
`static DiffNode`	`newRootNodeWithType(java.lang.Class<?> valueType)`
`void`	`set(java.lang.Object target, java.lang.Object value)`
`void`	`setChildIdentityStrategy(IdentityStrategy identityStrategy)`
`void`	`setCircleStartNode(DiffNode circleStartNode)`
`void`	`setCircleStartPath(NodePath circularStartPath)`
`protected void`	`setParentNode(DiffNode parentNode)` Sets the parent node.
`void`	`setState(DiffNode.State state)`
`void`	`setType(java.lang.Class<?> aClass)` Allows to explicity set the type of this node.
`void`	`setValueTypeInfo(TypeInfo typeInfo)`
`java.lang.String`	`toString()`
`void`	`unset(java.lang.Object target)`
`void`	`visit(DiffNode.Visitor visitor)` Visit this and all child nodes.
`protected void`	`visit(DiffNode.Visitor visitor, Visit visit)`
`void`	`visitChildren(DiffNode.Visitor visitor)` Visit all child nodes but not this one.
`void`	`visitParents(DiffNode.Visitor visitor)`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - ROOT
```
public static final DiffNode ROOT
```
- 构造器详细资料
  - DiffNode
```
public DiffNode(DiffNode parentNode,
        Accessor accessor,
        java.lang.Class<?> valueType)
```
  - DiffNode
```
public DiffNode(DiffNode parentNode,
        Accessor accessor)
```
- 方法详细资料
  - setChildIdentityStrategy
```
public void setChildIdentityStrategy(IdentityStrategy identityStrategy)
```
  - newRootNode
```
public static DiffNode newRootNode()
```
  - newRootNodeWithType
```
public static DiffNode newRootNodeWithType(java.lang.Class<?> valueType)
```
  - getState
```
public DiffNode.State getState()
```
    返回:
    The state of this node.
  - setState
```
public void setState(DiffNode.State state)
```
    参数:
    state - The state of this node.
  - matches
```
public boolean matches(NodePath path)
```
  - hasChanges
```
public boolean hasChanges()
```
  - isAdded
```
public final boolean isAdded()
```
    Convenience method for getState() == DiffNode.State.ADDED
  - isChanged
```
public final boolean isChanged()
```
    Convenience method for getState() == DiffNode.State.CHANGED
  - isRemoved
```
public final boolean isRemoved()
```
    Convenience method for getState() == DiffNode.State.REMOVED
  - isUntouched
```
public final boolean isUntouched()
```
    Convenience method for getState() == DiffNode.State.UNTOUCHED
  - isCircular
```
public boolean isCircular()
```
    Convenience method for getState() == DiffNode.State.CIRCULAR
  - getPath
```
public NodePath getPath()
```
    返回:
    The absolute property path from the object root up to this node.
  - getElementSelector
```
public ElementSelector getElementSelector()
```
  - getValueType
```
public java.lang.Class<?> getValueType()
```
    返回:
    Returns the type of the property represented by this node, or null if unavailable.
  - setType
```
public final void setType(java.lang.Class<?> aClass)
```
    Allows to explicity set the type of this node. This will overshadow the type returned by getValueTypeInfo() as well as the one returned by the accessor.
    
    参数:
    aClass - The type of the value represented by this node.
  - getValueTypeInfo
```
public TypeInfo getValueTypeInfo()
```
  - setValueTypeInfo
```
public void setValueTypeInfo(TypeInfo typeInfo)
```
  - hasChildren
```
public boolean hasChildren()
```
    返回:
    true if this node has children.
  - childCount
```
public int childCount()
```
  - getChild
```
public DiffNode getChild(java.lang.String propertyName)
```
    Retrieve a child with the given property name relative to this node.
    
    参数:
    propertyName - The name of the property represented by the child node.
    
    返回:
    The requested child node or null.
  - getChild
```
public DiffNode getChild(ElementSelector elementSelector)
```
    Retrieve a child that matches the given path element relative to this node.
    
    参数:
    elementSelector - The path element of the child node to get.
    
    返回:
    The requested child node or null.
  - getChild
```
public DiffNode getChild(NodePath nodePath)
```
    Retrieve a child that matches the given absolute path, starting from the current node.
    
    参数:
    nodePath - The path from the object root to the requested child node.
    
    返回:
    The requested child node or null.
  - getChild
```
public DiffNode getChild(java.util.List<ElementSelector> selectors)
```
    Retrieve a child that matches the given path element relative to this node.
    
    参数:
    selectors - The path element of the child node to get.
    
    返回:
    The requested child node or null.
  - addChild
```
public void addChild(DiffNode node)
```
    Adds a child to this node and sets this node as its parent node.
    
    参数:
    node - The node to add.
  - visit
```
public final void visit(DiffNode.Visitor visitor)
```
    Visit this and all child nodes.
    
    参数:
    visitor - The visitor to use.
  - visit
```
protected final void visit(DiffNode.Visitor visitor,
         Visit visit)
```
  - visitChildren
```
public final void visitChildren(DiffNode.Visitor visitor)
```
    Visit all child nodes but not this one.
    
    参数:
    visitor - The visitor to use.
  - visitParents
```
public final void visitParents(DiffNode.Visitor visitor)
```
  - getFieldAnnotations
```
public java.util.Set<java.lang.annotation.Annotation> getFieldAnnotations()
```
    If this node represents a bean property this method returns all annotations of its field.
    Only works for fields having a name that matches the name derived from the getter.
    
    返回:
    The annotations of the field, or an empty set if there is no field with the name derived from the getter.
  - getFieldAnnotation
```
public <T extends java.lang.annotation.Annotation> T getFieldAnnotation(java.lang.Class<T> annotationClass)
```
    类型参数:
    T -
    参数:
    annotationClass - the annotation we are looking for
    
    返回:
    The given annotation of the field, or null if not annotated or if there is no field with the name derived from the getter.
  - getPropertyAnnotations
```
public java.util.Set<java.lang.annotation.Annotation> getPropertyAnnotations()
```
    If this node represents a bean property this method returns all annotations of its getter.
    
    返回:
    A set of annotations of this nodes property getter or an empty set.
  - getPropertyAnnotation
```
public <T extends java.lang.annotation.Annotation> T getPropertyAnnotation(java.lang.Class<T> annotationClass)
```
  - getPropertyName
```
public java.lang.String getPropertyName()
```
    If this node represents a bean property, this method will simply return its name. Otherwise it will return the property name of its closest bean property representing ancestor. This way intermediate nodes like those representing collection, map or array items will be semantically tied to their container objects.
    That is especially useful for inclusion and exclusion rules. For example, when a List is explicitly included by property name, it would be weird if the inclusion didn't also apply to its items.
  - isPropertyAware
```
public final boolean isPropertyAware()
```
    Returns true when this node represents a bean property and can therefore be queried for property specific information like annotations or property types. But there will also be nodes that represent collection items, map entries, etc. In those cases this method will return false.
  - isRootNode
```
public final boolean isRootNode()
```
  - isIgnored
```
public final boolean isIgnored()
```
    Convenience method for getState() == DiffNode.State.IGNORED
  - isExcluded
```
@Deprecated
public boolean isExcluded()
```
    已过时。 This method was a shortcut to extract the "exclude" flag from the ObjectDiffProperty annotation. Since we found a better way to do that, it is not needed anymore and will be removed in future versions. The name is also misleading. It implies that here lies the truth about the exclusion, but only the InclusionService can tell for sure. This flag is just only little piece of the puzzle.
    
    另请参阅:
    TypePropertyAnnotationInclusionResolver
  - getCategories
```
public final java.util.Set<java.lang.String> getCategories()
```
    Returns an unmodifiable Set of String with the categories of this node.
    
    返回:
    an unmodifiable Set of String with the categories of this node
  - getParentNode
```
public DiffNode getParentNode()
```
    返回:
    The parent node, if any.
  - setParentNode
```
protected final void setParentNode(DiffNode parentNode)
```
    Sets the parent node.
    
    参数:
    parentNode - The parent of this node. May be null, if this is a root node.
  - get
```
public java.lang.Object get(java.lang.Object target)
```
  - set
```
public void set(java.lang.Object target,
       java.lang.Object value)
```
  - unset
```
public void unset(java.lang.Object target)
```
  - canonicalGet
```
public java.lang.Object canonicalGet(java.lang.Object target)
```
  - canonicalSet
```
public void canonicalSet(java.lang.Object target,
                java.lang.Object value)
```
  - canonicalUnset
```
public void canonicalUnset(java.lang.Object target)
```
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - addCategories
```
public void addCategories(java.util.Collection<java.lang.String> additionalCategories)
```
  - getCircleStartPath
```
public NodePath getCircleStartPath()
```
    返回:
    Returns the path to the first node in the hierarchy that represents the same object instance as this one. (Only if isCircular() returns true.
  - setCircleStartPath
```
public void setCircleStartPath(NodePath circularStartPath)
```
  - getCircleStartNode
```
public DiffNode getCircleStartNode()
```
  - setCircleStartNode
```
public void setCircleStartNode(DiffNode circleStartNode)
```

类 DiffNode

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

ROOT

构造器详细资料

DiffNode

DiffNode

方法详细资料

setChildIdentityStrategy

newRootNode

newRootNodeWithType

getState

setState

matches

hasChanges

isAdded

isChanged

isRemoved

isUntouched

isCircular

getPath

getElementSelector

getValueType

setType

getValueTypeInfo

setValueTypeInfo

hasChildren

childCount

getChild

getChild

getChild

getChild

addChild

visit

visit

visitChildren

visitParents

getFieldAnnotations

getFieldAnnotation

getPropertyAnnotations

getPropertyAnnotation

getPropertyName

isPropertyAware

isRootNode

isIgnored

isExcluded

getCategories

getParentNode

setParentNode

get

set

unset

canonicalGet

canonicalSet

canonicalUnset

hashCode

equals

toString

addCategories

getCircleStartPath

setCircleStartPath

getCircleStartNode

setCircleStartNode