Top Description Inners Methods
com.fasterxml.jackson.annotation

public @Interface JsonIncludeProperties

extends Annotation
Annotations
@Target:ANNOTATION_TYPE, TYPE, METHOD, CONSTRUCTOR, FIELD
@Retention:RUNTIME
@JacksonAnnotation
Imports
java.lang.annotation.*, java.util.*
Annotation that can be used to either only include serialization of properties (during serialization), or only include processing of JSON properties read (during deserialization).

Example: 

// to only include specified fields from being serialized or deserialized
// (i.e. only include in JSON output; or being set even if they were included)
@JsonIncludeProperties({ "internalId", "secretKey" })

Annotation can be applied both to classes and to properties. If used for both, actual set will be union of all includes: that is, you can only add properties to include, not remove or override. So you can not remove properties to include using per-property annotation.

Since
2.12

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
JsonIncludeProperties.Value

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

Method Summary

Modifier and TypeMethod and Description
public String[]
value()

Names of properties to include.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public String[] value()

Names of properties to include.

com.fasterxml.jackson.annotation back to summary

public Class JsonIncludeProperties.Value

extends Object
implements JacksonAnnotationValue<JsonIncludeProperties>, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, com.fasterxml.jackson.annotation.JacksonAnnotationValue
Helper class used to contain information from a single JsonIncludeProperties annotation, as well as to provide possible overrides from non-annotation sources.
Since
2.12

Field Summary

Modifier and TypeField and Description
protected final Set<String>
_included

Name of the properties to include.

protected static final JsonIncludeProperties.Value
ALL

Default instance has no explicitly included fields

private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
protected
Value(Set<String> included)

Method Summary

Modifier and TypeMethod and Description
private static Set<String>
_asSet(String[] v)

private static boolean
_equals(Set<String> a, Set<String> b)

public static JsonIncludeProperties.Value
all()

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 JsonIncludeProperties.Value
from(JsonIncludeProperties src)

public Set<String>

Returns:

Names included, if any, possibly empty; null for "not defined"
getIncluded()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public Class<JsonIncludeProperties>
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 JsonIncludeProperties.Value
withOverrides(JsonIncludeProperties.Value overrides)

Mutant factory method to override the current value with an another, merging the included fields so that only entries that exist in both original and override set are included, taking into account that "undefined" Values do not count ("undefined" meaning that getIncluded() returns null).

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

_includedback to summary
protected final Set<String> _included

Name of the properties to include. Null means that all properties are included, empty means none.

ALLback to summary
protected static final JsonIncludeProperties.Value ALL

Default instance has no explicitly included fields

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Valueback to summary
protected Value(Set<String> included)

Method Detail

_asSetback to summary
private static Set<String> _asSet(String[] v)
_equalsback to summary
private static boolean _equals(Set<String> a, Set<String> b)
allback to summary
public static JsonIncludeProperties.Value all()
equalsback 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
fromback to summary
public static JsonIncludeProperties.Value from(JsonIncludeProperties src)
getIncludedback to summary
public Set<String> getIncluded()
Returns:Set<String>

Names included, if any, possibly empty; null for "not defined"

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
valueForback to summary
public Class<JsonIncludeProperties> 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<JsonIncludeProperties>

Annotation class for which instances of this value class are created

Annotations
@Override
withOverridesback to summary
public JsonIncludeProperties.Value withOverrides(JsonIncludeProperties.Value overrides)

Mutant factory method to override the current value with an another, merging the included fields so that only entries that exist in both original and override set are included, taking into account that "undefined" Values do not count ("undefined" meaning that getIncluded() returns null). So: overriding with "undefined" returns original Value as-is; overriding an "undefined" Value returns override Value as-is.