com.fasterxml.jackson.contrib.jsonpath.util

Class CandidateField

java.lang.Object

com.fasterxml.jackson.contrib.jsonpath.util.CandidateField

public class CandidateField
extends Object

Wraps given field and its annotations (if any) into a more convenient structure. The class also provides additional set of methods for resoloving annotation values as proper Json paths

Constructor Summary

Constructors

Constructor and Description
CandidateField(Field field, Object containingObject) Custom constructor that wraps field and its annotations (if any).

Method Summary

Methods

Modifier and Type	Method and Description
Field	getField()
Object	getFieldValue(Object resultObject) Get field value from a given object.
String	getJsonAnnotationValue(boolean isAbsolutePath) Get annotation value and transform JsonProperty value to a relative JsonPath, if required.
JsonPath	getJsonPathAnnotation()
String	getJsonPathFromField() Get annotation value from either annotation, if exists.
com.fasterxml.jackson.annotation.JsonProperty	getJsonPropertyAnnotation()
boolean	isAppropriateForJsonPathUnmarshalling()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CandidateField

public CandidateField(Field field,
              Object containingObject)

Custom constructor that wraps field and its annotations (if any).

Parameters:

field - field to wrapped

Method Detail

getFieldValue

public Object getFieldValue(Object resultObject)
                     throws IllegalAccessException

Get field value from a given object.

Parameters:

resultObject - object from which value will be taken

Returns:

field value

Throws:

IllegalAccessException - reflection exception

getField

public Field getField()

getJsonPropertyAnnotation

public com.fasterxml.jackson.annotation.JsonProperty getJsonPropertyAnnotation()

getJsonPathAnnotation

public JsonPath getJsonPathAnnotation()

getJsonPathFromField

public String getJsonPathFromField()

Get annotation value from either annotation, if exists. In case that Json annotation is not present, field name will be used on the same way like the field is annotated with JsonProperty.

Returns:

Json path from either annotation or field name, if annotation is missing.

getJsonAnnotationValue

public String getJsonAnnotationValue(boolean isAbsolutePath)

Get annotation value and transform JsonProperty value to a relative JsonPath, if required. In case that either of Json annotations is not present, field name will be used on the same way like the field is annotated with JsonProperty.

Parameters:

isAbsolutePath - if true, @JsonProperty value will be resoloved as relative; otherwise as absolute

Returns:

Json path

isAppropriateForJsonPathUnmarshalling

public boolean isAppropriateForJsonPathUnmarshalling()
                                              throws IllegalAccessException

Throws:

IllegalAccessException