public static enum JsonInclude.Include extends Enum<JsonInclude.Include>
JsonInclude
to define which properties
of Java Beans are to be included in serialization.
Note: Jackson 1.x had similarly named ("Inclusion") enumeration included
in JsonSerialize
annotation: it is now deprecated
and this value used instead.
Enum Constant and Description |
---|
ALWAYS
Value that indicates that property is to be always included,
independent of value of the property.
|
NON_DEFAULT
Value that indicates that only properties that have values
that differ from default settings (meaning values they have
when Bean is constructed with its no-arguments constructor)
are to be included.
|
NON_EMPTY
Value that indicates that only properties that have values
that values that are null or what is considered empty are
not to be included.
|
NON_NULL
Value that indicates that only properties with non-null
values are to be included.
|
Modifier and Type | Method and Description |
---|---|
static JsonInclude.Include |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static JsonInclude.Include[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final JsonInclude.Include ALWAYS
public static final JsonInclude.Include NON_NULL
public static final JsonInclude.Include NON_DEFAULT
Map
s, since they have no default values;
and if used, works same as ALWAYS
.public static final JsonInclude.Include NON_EMPTY
Default emptiness is defined for following type:
Collection
s and Map
s,
method isEmpty()
is called;
String
s, length()
is called,
and return value of 0 indicates empty String (note that String.isEmpty()
was added in Java 1.6 and as such can not be used by Jackson
Note that this default handling can be overridden by custom
JsonSerializer
implementation: if method isEmpty()
is overridden, it will be called to see if non-null values are
considered empty (null is always considered empty).
public static JsonInclude.Include[] values()
for (JsonInclude.Include c : JsonInclude.Include.values()) System.out.println(c);
public static JsonInclude.Include valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullCopyright © 2016 JBoss by Red Hat. All rights reserved.