com.fasterxml.jackson.annotation.JsonIncludeProperties Maven / Gradle / Ivy
package com.fasterxml.jackson.annotation;
import java.lang.annotation.*;
import 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
*/
@Target({ElementType.ANNOTATION_TYPE, ElementType.TYPE,
ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonIncludeProperties
{
/**
* Names of properties to include.
*/
public String[] value() default {};
/*
/**********************************************************
/* Value class used to enclose information, allow for
/* merging of layered configuration settings.
/**********************************************************
*/
/**
* Helper class used to contain information from a single {@link JsonIncludeProperties}
* annotation, as well as to provide possible overrides from non-annotation sources.
*
* @since 2.12
*/
public static class Value implements JacksonAnnotationValue, java.io.Serializable
{
private static final long serialVersionUID = 1L;
/**
* Default instance has no explicitly included fields
*/
protected final static JsonIncludeProperties.Value ALL = new JsonIncludeProperties.Value(null);
/**
* Name of the properties to include.
* Null means that all properties are included, empty means none.
*/
protected final Set _included;
protected Value(Set included)
{
_included = included;
}
public static JsonIncludeProperties.Value from(JsonIncludeProperties src)
{
if (src == null) {
return ALL;
}
return new Value(_asSet(src.value()));
}
public static JsonIncludeProperties.Value all()
{
return ALL;
}
@Override
public Class valueFor()
{
return JsonIncludeProperties.class;
}
/**
* @return Names included, if any, possibly empty; {@code null} for "not defined"
*/
public Set getIncluded()
{
return _included;
}
/**
* 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" {@link Value}s
* do not count ("undefined" meaning that {@code getIncluded()} returns {@code null}).
* So: overriding with "undefined" returns original {@code Value} as-is; overriding an
* "undefined" {@code Value} returns override {@code Value} as-is.
*/
public JsonIncludeProperties.Value withOverrides(JsonIncludeProperties.Value overrides)
{
final Set otherIncluded;
if (overrides == null || (otherIncluded = overrides.getIncluded()) == null) {
return this;
}
if (_included == null) {
return overrides;
}
HashSet toInclude = new HashSet();
for (String incl : otherIncluded) {
if (_included.contains(incl)) {
toInclude.add(incl);
}
}
return new JsonIncludeProperties.Value(toInclude);
}
@Override
public String toString() {
return String.format("JsonIncludeProperties.Value(included=%s)",
_included);
}
@Override
public int hashCode() {
return (_included == null) ? 0 : _included.size();
}
@Override
public boolean equals(Object o) {
if (o == this) return true;
if (o == null) return false;
return (o.getClass() == getClass()) && _equals(_included, ((Value) o)._included);
}
private static boolean _equals(Set a, Set b)
{
return a == null ? (b == null)
// keep this last just because it can be expensive
: a.equals(b);
}
private static Set _asSet(String[] v)
{
if (v == null || v.length == 0) {
return Collections.emptySet();
}
Set s = new HashSet(v.length);
for (String str : v) {
s.add(str);
}
return s;
}
}
}