Modifier and Type	Class and Description
public static class	JacksonInject.Value Helper class used to contain information from a single `JacksonInject` annotation, as well as to provide possible overrides from non-annotation sources.

Modifier and Type	Method and Description
public OptBoolean	Returns: `OptBoolean#TRUE` to enable use of value from input instead of injected value, if available; `OptBoolean#FALSE` if injected value will always be used regardless of input. useInput() Whether matching value from input (if any) is used for annotated property or not; if disabled (`OptBoolean.FALSE`), input value (if any) will be ignored; otherwise it will override injected value.
public String	Returns: Logical id of the value to inject value() Logical id of the value to inject; if not specified (or specified as empty String), will use id based on declared type of property.

useInput	back to summary
public OptBoolean useInput() Whether matching value from input (if any) is used for annotated property or not; if disabled (`OptBoolean.FALSE`), input value (if any) will be ignored; otherwise it will override injected value. Default is `OptBoolean.DEFAULT`, which translates to `OptBoolean.TRUE`: this is for backwards compatibility (2.8 and earlier always allow binding input value). Returns:OptBoolean `OptBoolean#TRUE` to enable use of value from input instead of injected value, if available; `OptBoolean#FALSE` if injected value will always be used regardless of input. Since 2.9

value	back to summary
public String value() Logical id of the value to inject; if not specified (or specified as empty String), will use id based on declared type of property. Returns:String Logical id of the value to inject

com.fasterxml.jackson.annotation back to summary

public Class JacksonInject.Value

Class Inheritance

extends Object
implements JacksonAnnotationValue<JacksonInject>, Serializable

java.lang.Object
com.fasterxml.jackson.annotation.JacksonInject.Value

All Implemented Interfaces

java.io.Serializable, com.fasterxml.jackson.annotation.JacksonAnnotationValue

Helper class used to contain information from a single JacksonInject annotation, as well as to provide possible overrides from non-annotation sources.

Since: 2.9

Field Summary

Modifier and Type	Field and Description
protected final Object	_id Id to use to access injected value; if `null`, "default" name, derived from accessor will be used.
protected final Boolean	_useInput
protected static final JacksonInject.Value	EMPTY
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
protected	Value(Object id, Boolean useInput)

Method Summary

Modifier and Type	Method and Description
private static boolean	_empty(Object id, Boolean useInput)
public static JacksonInject.Value	construct(Object id, Boolean useInput)
public static JacksonInject.Value	empty()
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static JacksonInject.Value	forId(Object id)
public static JacksonInject.Value	from(JacksonInject src)
public Object	getId()
public Boolean	getUseInput()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	hasId()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public Class<JacksonInject>	valueFor() Implements com.fasterxml.jackson.annotation.JacksonAnnotationValue.valueFor. Introspection method that may be used to find actual annotation that may be used as the source for value instance.
public boolean	willUseInput(boolean defaultSetting)
public JacksonInject.Value	withId(Object id)
public JacksonInject.Value	withUseInput(Boolean useInput)

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

Field Detail

_id	back to summary
protected final Object _id Id to use to access injected value; if `null`, "default" name, derived from accessor will be used.

_useInput	back to summary
protected final Boolean _useInput

EMPTY	back to summary
protected static final JacksonInject.Value EMPTY

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

Value	back to summary
protected Value(Object id, Boolean useInput)

Method Detail

_empty	back to summary
private static boolean _empty(Object id, Boolean useInput)

construct	back to summary
public static JacksonInject.Value construct(Object id, Boolean useInput)

empty	back to summary
public static JacksonInject.Value empty()

equals back to summary

equals	back to summary
public boolean equals(Object o) 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 o: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 o)

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

o: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

forId	back to summary
public static JacksonInject.Value forId(Object id)

from	back to summary
public static JacksonInject.Value from(JacksonInject src)

getId	back to summary
public Object getId()

getUseInput	back to summary
public Boolean getUseInput()

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 this 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 this 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

hasId	back to summary
public boolean hasId()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

valueFor	back to summary
public Class<JacksonInject> valueFor() Implements com.fasterxml.jackson.annotation.JacksonAnnotationValue.valueFor. Doc from com.fasterxml.jackson.annotation.JacksonAnnotationValue.valueFor. Introspection method that may be used to find actual annotation that may be used as the source for value instance. Returns:Class<JacksonInject> Annotation class for which instances of this value class are created Annotations @Override

valueFor

back to summary

public Class<JacksonInject> valueFor()

Implements com.fasterxml.jackson.annotation.JacksonAnnotationValue.valueFor.

Doc from com.fasterxml.jackson.annotation.JacksonAnnotationValue.valueFor.

Introspection method that may be used to find actual annotation that may be used as the source for value instance.

Returns:Class<JacksonInject>

Annotation class for which instances of this value class are created

Annotations

@Override

willUseInput	back to summary
public boolean willUseInput(boolean defaultSetting)

withId	back to summary
public JacksonInject.Value withId(Object id)

withUseInput	back to summary
public JacksonInject.Value withUseInput(Boolean useInput)

public @Interface JacksonInject

Nested and Inner Type Summary

Method Summary

Method Detail

public Class JacksonInject.Value

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail