com.fasterxml.jackson.annotation

Class JsonSetter.Value

java.lang.Object

com.fasterxml.jackson.annotation.JsonSetter.Value

All Implemented Interfaces:

JacksonAnnotationValue<JsonSetter>, java.io.Serializable

Enclosing class:

JsonSetter

public static class JsonSetter.Value
extends java.lang.Object
implements JacksonAnnotationValue<JsonSetter>, java.io.Serializable

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

Since:

2.9

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static JsonSetter.Value	construct(Nulls nulls, Nulls contentNulls) Factory method that may be used (although is NOT the recommended way) to construct an instance from a full set of properties.
static JsonSetter.Value	empty() Accessor for default instances which has "empty" settings; that is: Null handling using global defaults, Nulls.DEFAULT.
boolean	equals(java.lang.Object o)
static JsonSetter.Value	forContentNulls(Nulls nulls)
static JsonSetter.Value	forValueNulls(Nulls nulls)
static JsonSetter.Value	forValueNulls(Nulls nulls, Nulls contentNulls)
static JsonSetter.Value	from(JsonSetter src)
Nulls	getContentNulls()
Nulls	getValueNulls()
int	hashCode()
static JsonSetter.Value	merge(JsonSetter.Value base, JsonSetter.Value overrides) Helper method that will try to combine values from two JsonSetter.Value instances, using one as base settings, and the other as overrides to use instead of base values when defined; base values are only use if override does not specify a value (matching value is null or logically missing).
Nulls	nonDefaultContentNulls() Returns same as getContentNulls() unless value would be Nulls.DEFAULT in which case `null` is returned.
Nulls	nonDefaultValueNulls() Returns same as getValueNulls() unless value would be Nulls.DEFAULT in which case `null` is returned.
java.lang.String	toString()
java.lang.Class<JsonSetter>	valueFor() Introspection method that may be used to find actual annotation that may be used as the source for value instance.
JsonSetter.Value	withContentNulls(Nulls nulls)
JsonSetter.Value	withOverrides(JsonSetter.Value overrides) Mutant factory method that merges values of this value with given override values, so that any explicitly defined inclusion in overrides has precedence over settings of this value instance.
JsonSetter.Value	withValueNulls(Nulls nulls)
JsonSetter.Value	withValueNulls(Nulls valueNulls, Nulls contentNulls)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

valueFor

public java.lang.Class<JsonSetter> valueFor()

Description copied from interface: JacksonAnnotationValue

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

Specified by:

valueFor in interface JacksonAnnotationValue<JsonSetter>

Returns:

Annotation class for which instances of this value class are created

from

public static JsonSetter.Value from(JsonSetter src)

construct

public static JsonSetter.Value construct(Nulls nulls,
                                         Nulls contentNulls)

Factory method that may be used (although is NOT the recommended way) to construct an instance from a full set of properties. Most users would be better of starting by empty() instance and using `withXxx`/`withoutXxx` methods, as this factory method may need to be changed if new properties are added in JsonIgnoreProperties annotation.

empty

public static JsonSetter.Value empty()

Accessor for default instances which has "empty" settings; that is:

• Null handling using global defaults, Nulls.DEFAULT.

merge

public static JsonSetter.Value merge(JsonSetter.Value base,
                                     JsonSetter.Value overrides)

Helper method that will try to combine values from two JsonSetter.Value instances, using one as base settings, and the other as overrides to use instead of base values when defined; base values are only use if override does not specify a value (matching value is null or logically missing). Note that one or both of value instances may be `null`, directly; if both are `null`, result will also be `null`; otherwise never null.

forValueNulls

public static JsonSetter.Value forValueNulls(Nulls nulls)

forValueNulls

public static JsonSetter.Value forValueNulls(Nulls nulls,
                                             Nulls contentNulls)

forContentNulls

public static JsonSetter.Value forContentNulls(Nulls nulls)

withOverrides

public JsonSetter.Value withOverrides(JsonSetter.Value overrides)

Mutant factory method that merges values of this value with given override values, so that any explicitly defined inclusion in overrides has precedence over settings of this value instance. If no overrides exist will return this instance; otherwise new JsonSetter.Value with changed inclusion values.

withValueNulls

public JsonSetter.Value withValueNulls(Nulls nulls)

withValueNulls

public JsonSetter.Value withValueNulls(Nulls valueNulls,
                                       Nulls contentNulls)

withContentNulls

public JsonSetter.Value withContentNulls(Nulls nulls)

getValueNulls

public Nulls getValueNulls()

getContentNulls

public Nulls getContentNulls()

nonDefaultValueNulls

public Nulls nonDefaultValueNulls()

Returns same as getValueNulls() unless value would be Nulls.DEFAULT in which case `null` is returned.

nonDefaultContentNulls

public Nulls nonDefaultContentNulls()

Returns same as getContentNulls() unless value would be Nulls.DEFAULT in which case `null` is returned.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object