Modifier and Type	Class and Description
public static class	JsonAutoDetect.Value Helper class used to contain information from a single `JsonIgnoreProperties` annotation, as well as to provide possible overrides from non-annotation sources.
public static enum	JsonAutoDetect.Visibility Enumeration for possible visibility thresholds (minimum visibility) that can be used to limit which methods (and fields) are auto-detected.

Modifier and Type	Method and Description
public JsonAutoDetect.Visibility	creatorVisibility() Minimum visibility required for auto-detecting Creator methods, except for no-argument constructors (which are always detected no matter what).
public JsonAutoDetect.Visibility	fieldVisibility() Minimum visibility required for auto-detecting member fields.
public JsonAutoDetect.Visibility	getterVisibility() Minimum visibility required for auto-detecting regular getter methods.
public JsonAutoDetect.Visibility	isGetterVisibility() Minimum visibility required for auto-detecting is-getter methods.
public JsonAutoDetect.Visibility	setterVisibility() Minimum visibility required for auto-detecting setter methods.

creatorVisibility	back to summary
public JsonAutoDetect.Visibility creatorVisibility() Minimum visibility required for auto-detecting Creator methods, except for no-argument constructors (which are always detected no matter what).

fieldVisibility	back to summary
public JsonAutoDetect.Visibility fieldVisibility() Minimum visibility required for auto-detecting member fields.

getterVisibility	back to summary
public JsonAutoDetect.Visibility getterVisibility() Minimum visibility required for auto-detecting regular getter methods.

isGetterVisibility	back to summary
public JsonAutoDetect.Visibility isGetterVisibility() Minimum visibility required for auto-detecting is-getter methods.

setterVisibility	back to summary
public JsonAutoDetect.Visibility setterVisibility() Minimum visibility required for auto-detecting setter methods.

com.fasterxml.jackson.annotation back to summary

public Class JsonAutoDetect.Value

Class Inheritance

extends Object
implements JacksonAnnotationValue<JsonAutoDetect>, Serializable

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

All Implemented Interfaces

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

Helper class used to contain information from a single JsonIgnoreProperties 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 JsonAutoDetect.Visibility	_creatorVisibility
protected final JsonAutoDetect.Visibility	_fieldVisibility
protected final JsonAutoDetect.Visibility	_getterVisibility
protected final JsonAutoDetect.Visibility	_isGetterVisibility
protected final JsonAutoDetect.Visibility	_setterVisibility
protected static final JsonAutoDetect.Value	DEFAULT Default instance with baseline visibility checking: Only public fields visible Only public getters, is-getters visible All setters (regardless of access) visible Only public Creators visible
private static final JsonAutoDetect.Visibility	DEFAULT_FIELD_VISIBILITY
protected static final JsonAutoDetect.Value	NO_OVERRIDES Empty instance that specifies no overrides, that is, all visibility levels set as `Visibility#DEFAULT`.
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
private	Value(JsonAutoDetect.Visibility fields, JsonAutoDetect.Visibility getters, JsonAutoDetect.Visibility isGetters, JsonAutoDetect.Visibility setters, JsonAutoDetect.Visibility creators)

Method Summary

Modifier and Type	Method and Description
private static boolean	_equals(JsonAutoDetect.Value a, JsonAutoDetect.Value b)
private static JsonAutoDetect.Value	_predefined(JsonAutoDetect.Visibility fields, JsonAutoDetect.Visibility getters, JsonAutoDetect.Visibility isGetters, JsonAutoDetect.Visibility setters, JsonAutoDetect.Visibility creators)
public static JsonAutoDetect.Value	construct(PropertyAccessor acc, JsonAutoDetect.Visibility visibility) Factory method for constructing instance with visibility of specified accessor (or, in case of `ALL`, all of them) set as specified; and the rest (if any) set as `Visibility#DEFAULT`).
public static JsonAutoDetect.Value	construct(JsonAutoDetect.Visibility fields, JsonAutoDetect.Visibility getters, JsonAutoDetect.Visibility isGetters, JsonAutoDetect.Visibility setters, JsonAutoDetect.Visibility creators)
public static JsonAutoDetect.Value	defaultVisibility()
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 JsonAutoDetect.Value	from(JsonAutoDetect src)
public JsonAutoDetect.Visibility	getCreatorVisibility()
public JsonAutoDetect.Visibility	getFieldVisibility()
public JsonAutoDetect.Visibility	getGetterVisibility()
public JsonAutoDetect.Visibility	getIsGetterVisibility()
public JsonAutoDetect.Visibility	getSetterVisibility()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public static JsonAutoDetect.Value	merge(JsonAutoDetect.Value base, JsonAutoDetect.Value overrides)
public static JsonAutoDetect.Value	noOverrides()
protected Object	readResolve()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public Class<JsonAutoDetect>	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 JsonAutoDetect.Value	withCreatorVisibility(JsonAutoDetect.Visibility v)
public JsonAutoDetect.Value	withFieldVisibility(JsonAutoDetect.Visibility v)
public JsonAutoDetect.Value	withGetterVisibility(JsonAutoDetect.Visibility v)
public JsonAutoDetect.Value	withIsGetterVisibility(JsonAutoDetect.Visibility v)
public JsonAutoDetect.Value	withOverrides(JsonAutoDetect.Value overrides)
public JsonAutoDetect.Value	withSetterVisibility(JsonAutoDetect.Visibility v)

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

Field Detail

_creatorVisibility	back to summary
protected final JsonAutoDetect.Visibility _creatorVisibility

_fieldVisibility	back to summary
protected final JsonAutoDetect.Visibility _fieldVisibility

_getterVisibility	back to summary
protected final JsonAutoDetect.Visibility _getterVisibility

_isGetterVisibility	back to summary
protected final JsonAutoDetect.Visibility _isGetterVisibility

_setterVisibility	back to summary
protected final JsonAutoDetect.Visibility _setterVisibility

DEFAULT	back to summary
protected static final JsonAutoDetect.Value DEFAULT Default instance with baseline visibility checking: Only public fields visible Only public getters, is-getters visible All setters (regardless of access) visible Only public Creators visible

DEFAULT

back to summary

protected static final JsonAutoDetect.Value DEFAULT

Default instance with baseline visibility checking:

Only public fields visible
Only public getters, is-getters visible
All setters (regardless of access) visible
Only public Creators visible

DEFAULT_FIELD_VISIBILITY	back to summary
private static final JsonAutoDetect.Visibility DEFAULT_FIELD_VISIBILITY

NO_OVERRIDES	back to summary
protected static final JsonAutoDetect.Value NO_OVERRIDES Empty instance that specifies no overrides, that is, all visibility levels set as `Visibility#DEFAULT`.

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

Value	back to summary
private Value(JsonAutoDetect.Visibility fields, JsonAutoDetect.Visibility getters, JsonAutoDetect.Visibility isGetters, JsonAutoDetect.Visibility setters, JsonAutoDetect.Visibility creators)

Method Detail

_equals	back to summary
private static boolean _equals(JsonAutoDetect.Value a, JsonAutoDetect.Value b)

_predefined	back to summary
private static JsonAutoDetect.Value _predefined(JsonAutoDetect.Visibility fields, JsonAutoDetect.Visibility getters, JsonAutoDetect.Visibility isGetters, JsonAutoDetect.Visibility setters, JsonAutoDetect.Visibility creators)

construct	back to summary
public static JsonAutoDetect.Value construct(PropertyAccessor acc, JsonAutoDetect.Visibility visibility) Factory method for constructing instance with visibility of specified accessor (or, in case of `ALL`, all of them) set as specified; and the rest (if any) set as `Visibility#DEFAULT`).

construct	back to summary
public static JsonAutoDetect.Value construct(JsonAutoDetect.Visibility fields, JsonAutoDetect.Visibility getters, JsonAutoDetect.Visibility isGetters, JsonAutoDetect.Visibility setters, JsonAutoDetect.Visibility creators)

defaultVisibility	back to summary
public static JsonAutoDetect.Value defaultVisibility()

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

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

getCreatorVisibility	back to summary
public JsonAutoDetect.Visibility getCreatorVisibility()

getFieldVisibility	back to summary
public JsonAutoDetect.Visibility getFieldVisibility()

getGetterVisibility	back to summary
public JsonAutoDetect.Visibility getGetterVisibility()

getIsGetterVisibility	back to summary
public JsonAutoDetect.Visibility getIsGetterVisibility()

getSetterVisibility	back to summary
public JsonAutoDetect.Visibility getSetterVisibility()

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

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

merge	back to summary
public static JsonAutoDetect.Value merge(JsonAutoDetect.Value base, JsonAutoDetect.Value overrides)

noOverrides	back to summary
public static JsonAutoDetect.Value noOverrides()

readResolve	back to summary
protected Object readResolve()

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. Returns:String a string representation of the object. Annotations @Override

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.

Returns:String

a string representation of the object.

Annotations

@Override

valueFor	back to summary
public Class<JsonAutoDetect> 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<JsonAutoDetect> Annotation class for which instances of this value class are created Annotations @Override

valueFor

back to summary

public Class<JsonAutoDetect> 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<JsonAutoDetect>

Annotation class for which instances of this value class are created

Annotations

@Override

withCreatorVisibility	back to summary
public JsonAutoDetect.Value withCreatorVisibility(JsonAutoDetect.Visibility v)

withFieldVisibility	back to summary
public JsonAutoDetect.Value withFieldVisibility(JsonAutoDetect.Visibility v)

withGetterVisibility	back to summary
public JsonAutoDetect.Value withGetterVisibility(JsonAutoDetect.Visibility v)

withIsGetterVisibility	back to summary
public JsonAutoDetect.Value withIsGetterVisibility(JsonAutoDetect.Visibility v)

withOverrides	back to summary
public JsonAutoDetect.Value withOverrides(JsonAutoDetect.Value overrides)

withSetterVisibility	back to summary
public JsonAutoDetect.Value withSetterVisibility(JsonAutoDetect.Visibility v)

com.fasterxml.jackson.annotation back to summary

public final Enum JsonAutoDetect.Visibility

Class Inheritance

extends Enum<JsonAutoDetect.Visibility>

java.lang.Object
java.lang.Enum
com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility

Enumeration for possible visibility thresholds (minimum visibility) that can be used to limit which methods (and fields) are auto-detected.

Field Summary

Modifier and Type	Field and Description
public static final JsonAutoDetect.Visibility	ANY Value that means that all kinds of access modifiers are acceptable, from private to public.
public static final JsonAutoDetect.Visibility	DEFAULT Value that indicates that default visibility level (whatever it is, depends on context) is to be used.
public static final JsonAutoDetect.Visibility	NON_PRIVATE Value that means that any other access modifier other than 'private' is considered auto-detectable.
public static final JsonAutoDetect.Visibility	NONE Value that indicates that no access modifiers are auto-detectable: this can be used to explicitly disable auto-detection for specified types.
public static final JsonAutoDetect.Visibility	PROTECTED_AND_PUBLIC Value that means access modifiers 'protected' and 'public' are auto-detectable (and 'private' and "package access" == no modifiers are not)
public static final JsonAutoDetect.Visibility	PUBLIC_ONLY Value to indicate that only 'public' access modifier is considered auto-detectable.

Constructor Summary

Access	Constructor and Description
private	Visibility()

Method Summary

Modifier and Type	Method and Description
public boolean	isVisible(Member m)
public static JsonAutoDetect.Visibility	valueOf(String name)
public static JsonAutoDetect.Visibility[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ANY	back to summary
public static final JsonAutoDetect.Visibility ANY Value that means that all kinds of access modifiers are acceptable, from private to public.

DEFAULT	back to summary
public static final JsonAutoDetect.Visibility DEFAULT Value that indicates that default visibility level (whatever it is, depends on context) is to be used. This usually means that inherited value (from parent visibility settings) is to be used.

NON_PRIVATE	back to summary
public static final JsonAutoDetect.Visibility NON_PRIVATE Value that means that any other access modifier other than 'private' is considered auto-detectable.

NONE	back to summary
public static final JsonAutoDetect.Visibility NONE Value that indicates that no access modifiers are auto-detectable: this can be used to explicitly disable auto-detection for specified types.

PROTECTED_AND_PUBLIC	back to summary
public static final JsonAutoDetect.Visibility PROTECTED_AND_PUBLIC Value that means access modifiers 'protected' and 'public' are auto-detectable (and 'private' and "package access" == no modifiers are not)

PUBLIC_ONLY	back to summary
public static final JsonAutoDetect.Visibility PUBLIC_ONLY Value to indicate that only 'public' access modifier is considered auto-detectable.

Constructor Detail

Visibility	back to summary
private Visibility()

Method Detail

isVisible	back to summary
public boolean isVisible(Member m)

valueOf	back to summary
public static JsonAutoDetect.Visibility valueOf(String name)

values	back to summary
public static JsonAutoDetect.Visibility[] values()

public @Interface JsonAutoDetect

Nested and Inner Type Summary

Method Summary

Method Detail

public Class JsonAutoDetect.Value

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum JsonAutoDetect.Visibility

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail