Top Description Fields Constructors Methods
tools.jackson.databind.introspect

public Class VisibilityChecker

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
com.fasterxml.jackson.annotation.JsonAutoDetect, .JsonAutoDetect.Visibility, .PropertyAccessor

Interface for object used for determine which property elements (methods, fields, constructors) can be auto-detected, with respect to their visibility modifiers.

Field Summary

Modifier and TypeField and Description
protected final JsonAutoDetect.Visibility
protected final JsonAutoDetect.Visibility
protected final JsonAutoDetect.Visibility
protected final JsonAutoDetect.Visibility
protected final JsonAutoDetect.Visibility
protected final JsonAutoDetect.Visibility
protected static final VisibilityChecker
protected static final VisibilityChecker
ALL_PUBLIC_EXCEPT_CREATORS

Visibility settings needed to support auto-discovery of non-private Records.

protected static final VisibilityChecker
DEFAULT

This is the canonical base instance, configured with default visibility values

private static final long

Constructor Summary

AccessConstructor and Description
public
VisibilityChecker(JsonAutoDetect
Annotations to use for determining minimum visibility levels
ann
)

Constructor used for building instance that has minumum visibility levels as indicated by given annotation instance

public
VisibilityChecker(JsonAutoDetect.Visibility field, JsonAutoDetect.Visibility getter, JsonAutoDetect.Visibility isGetter, JsonAutoDetect.Visibility setter, JsonAutoDetect.Visibility creator, JsonAutoDetect.Visibility scalarConstructor)

Constructor that allows directly specifying minimum visibility levels to use

public
VisibilityChecker(JsonAutoDetect.Visibility
level to use for all property types
v
)

Constructor that will assign given visibility value for all properties.

Method Summary

Modifier and TypeMethod and Description
private JsonAutoDetect.Visibility
protected VisibilityChecker
_with(JsonAutoDetect.Visibility f, JsonAutoDetect.Visibility g, JsonAutoDetect.Visibility isG, JsonAutoDetect.Visibility s, JsonAutoDetect.Visibility cr, JsonAutoDetect.Visibility scalarCr)

Method that can be used for merging default values from `this` instance with specified overrides; and either return `this` if overrides had no effect (that is, result would be equal), or a new instance with merged visibility settings.

public static VisibilityChecker
public static VisibilityChecker
public static VisibilityChecker
public static VisibilityChecker
public boolean
equals(Object o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public boolean
isCreatorVisible(AnnotatedMember m)

Method for checking whether given creator (other than "scalar constructor", see isScalarConstructorVisible) is auto-detectable as Creator, with respect to its visibility (not considering signature, just visibility)

public boolean
isFieldVisible(AnnotatedField f)

Method for checking whether given field is auto-detectable as property, with respect to its visibility (not considering method signature or name, just visibility)

public boolean
isGetterVisible(AnnotatedMethod m)

Method for checking whether given method is auto-detectable as regular getter, with respect to its visibility (not considering method signature or name, just visibility)

public boolean
isIsGetterVisible(AnnotatedMethod m)

Method for checking whether given method is auto-detectable as is-getter, with respect to its visibility (not considering method signature or name, just visibility)

public boolean
isScalarConstructorVisible(AnnotatedMember m)

Method for checking whether given single-scalar-argument constructor is auto-detectable as delegating Creator, with respect to its visibility (not considering signature, just visibility)

public boolean
isSetterVisible(AnnotatedMethod m)

Method for checking whether given method is auto-detectable as setter, with respect to its visibility (not considering method signature or name, just visibility)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public VisibilityChecker
with(JsonAutoDetect.Visibility v)

Builder method that will create and return an instance that has specified Visibility value to use for all property elements.

public VisibilityChecker
withCreatorVisibility(JsonAutoDetect.Visibility v)

Builder method that will return a checker instance that has specified minimum visibility level for creator methods (constructors, factory methods)

public VisibilityChecker
withFieldVisibility(JsonAutoDetect.Visibility v)

Builder method that will return a checker instance that has specified minimum visibility level for fields.

public VisibilityChecker
withGetterVisibility(JsonAutoDetect.Visibility v)

Builder method that will return a checker instance that has specified minimum visibility level for regular ("getXxx") getters.

public VisibilityChecker
withIsGetterVisibility(JsonAutoDetect.Visibility v)

Builder method that will return a checker instance that has specified minimum visibility level for "is-getters" ("isXxx").

public VisibilityChecker
public VisibilityChecker
public VisibilityChecker
withSetterVisibility(JsonAutoDetect.Visibility v)

Builder method that will return a checker instance that has specified minimum visibility level for setters.

public VisibilityChecker
withVisibility(PropertyAccessor method, JsonAutoDetect.Visibility v)

Builder method that will create and return an instance that has specified Visibility value to use for specified property.

Inherited from java.lang.Object:
clonefinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

_creatorMinLevelback to summary
protected final JsonAutoDetect.Visibility _creatorMinLevel
_fieldMinLevelback to summary
protected final JsonAutoDetect.Visibility _fieldMinLevel
_getterMinLevelback to summary
protected final JsonAutoDetect.Visibility _getterMinLevel
_isGetterMinLevelback to summary
protected final JsonAutoDetect.Visibility _isGetterMinLevel
_scalarConstructorMinLevelback to summary
protected final JsonAutoDetect.Visibility _scalarConstructorMinLevel
_setterMinLevelback to summary
protected final JsonAutoDetect.Visibility _setterMinLevel
ALL_PUBLICback to summary
protected static final VisibilityChecker ALL_PUBLIC
ALL_PUBLIC_EXCEPT_CREATORSback to summary
protected static final VisibilityChecker ALL_PUBLIC_EXCEPT_CREATORS

Visibility settings needed to support auto-discovery of non-private Records.

Since
3.0
DEFAULTback to summary
protected static final VisibilityChecker DEFAULT

This is the canonical base instance, configured with default visibility values

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

VisibilityCheckerback to summary
public VisibilityChecker(JsonAutoDetect ann)

Constructor used for building instance that has minumum visibility levels as indicated by given annotation instance

Parameters
ann:JsonAutoDetect

Annotations to use for determining minimum visibility levels

VisibilityCheckerback to summary
public VisibilityChecker(JsonAutoDetect.Visibility field, JsonAutoDetect.Visibility getter, JsonAutoDetect.Visibility isGetter, JsonAutoDetect.Visibility setter, JsonAutoDetect.Visibility creator, JsonAutoDetect.Visibility scalarConstructor)

Constructor that allows directly specifying minimum visibility levels to use

VisibilityCheckerback to summary
public VisibilityChecker(JsonAutoDetect.Visibility v)

Constructor that will assign given visibility value for all properties.

Parameters
v:JsonAutoDetect.Visibility

level to use for all property types

Method Detail

_defaultOrOverrideback to summary
private JsonAutoDetect.Visibility _defaultOrOverride(JsonAutoDetect.Visibility defaults, JsonAutoDetect.Visibility override)
_withback to summary
protected VisibilityChecker _with(JsonAutoDetect.Visibility f, JsonAutoDetect.Visibility g, JsonAutoDetect.Visibility isG, JsonAutoDetect.Visibility s, JsonAutoDetect.Visibility cr, JsonAutoDetect.Visibility scalarCr)

Method that can be used for merging default values from `this` instance with specified overrides; and either return `this` if overrides had no effect (that is, result would be equal), or a new instance with merged visibility settings.

allPublicExceptCreatorsInstanceback to summary
public static VisibilityChecker allPublicExceptCreatorsInstance()
allPublicInstanceback to summary
public static VisibilityChecker allPublicInstance()
constructback to summary
public static VisibilityChecker construct(JsonAutoDetect.Value vis)
defaultInstanceback to summary
public static VisibilityChecker defaultInstance()
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.

Annotations
@Override
isCreatorVisibleback to summary
public boolean isCreatorVisible(AnnotatedMember m)

Method for checking whether given creator (other than "scalar constructor", see isScalarConstructorVisible) is auto-detectable as Creator, with respect to its visibility (not considering signature, just visibility)

isFieldVisibleback to summary
public boolean isFieldVisible(AnnotatedField f)

Method for checking whether given field is auto-detectable as property, with respect to its visibility (not considering method signature or name, just visibility)

isGetterVisibleback to summary
public boolean isGetterVisible(AnnotatedMethod m)

Method for checking whether given method is auto-detectable as regular getter, with respect to its visibility (not considering method signature or name, just visibility)

isIsGetterVisibleback to summary
public boolean isIsGetterVisible(AnnotatedMethod m)

Method for checking whether given method is auto-detectable as is-getter, with respect to its visibility (not considering method signature or name, just visibility)

isScalarConstructorVisibleback to summary
public boolean isScalarConstructorVisible(AnnotatedMember m)

Method for checking whether given single-scalar-argument constructor is auto-detectable as delegating Creator, with respect to its visibility (not considering signature, just visibility)

Since
3.0
isSetterVisibleback to summary
public boolean isSetterVisible(AnnotatedMethod m)

Method for checking whether given method is auto-detectable as setter, with respect to its visibility (not considering method signature or name, just visibility)

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override
withback to summary
public VisibilityChecker with(JsonAutoDetect.Visibility v)

Builder method that will create and return an instance that has specified Visibility value to use for all property elements. Typical usage would be something like:

  mapper.setVisibilityChecker(
     mapper.getVisibilityChecker().with(Visibility.NONE));
(which would basically disable all auto-detection)
withCreatorVisibilityback to summary
public VisibilityChecker withCreatorVisibility(JsonAutoDetect.Visibility v)

Builder method that will return a checker instance that has specified minimum visibility level for creator methods (constructors, factory methods)

withFieldVisibilityback to summary
public VisibilityChecker withFieldVisibility(JsonAutoDetect.Visibility v)

Builder method that will return a checker instance that has specified minimum visibility level for fields.

withGetterVisibilityback to summary
public VisibilityChecker withGetterVisibility(JsonAutoDetect.Visibility v)

Builder method that will return a checker instance that has specified minimum visibility level for regular ("getXxx") getters.

withIsGetterVisibilityback to summary
public VisibilityChecker withIsGetterVisibility(JsonAutoDetect.Visibility v)

Builder method that will return a checker instance that has specified minimum visibility level for "is-getters" ("isXxx").

withOverridesback to summary
public VisibilityChecker withOverrides(JsonAutoDetect.Value vis)
withScalarConstructorVisibilityback to summary
public VisibilityChecker withScalarConstructorVisibility(JsonAutoDetect.Visibility v)
Since
3.0
withSetterVisibilityback to summary
public VisibilityChecker withSetterVisibility(JsonAutoDetect.Visibility v)

Builder method that will return a checker instance that has specified minimum visibility level for setters.

withVisibilityback to summary
public VisibilityChecker withVisibility(PropertyAccessor method, JsonAutoDetect.Visibility v)

Builder method that will create and return an instance that has specified Visibility value to use for specified property. Typical usage would be:

  mapper.setVisibilityChecker(
     mapper.getVisibilityChecker().withVisibility(JsonMethod.FIELD, Visibility.ANY));
(which would basically enable auto-detection for all member fields)