Class VisibilityChecker.Std
- java.lang.Object
-
- com.fasterxml.jackson.databind.introspect.VisibilityChecker.Std
-
- All Implemented Interfaces:
VisibilityChecker<VisibilityChecker.Std>
,java.io.Serializable
- Enclosing interface:
- VisibilityChecker<T extends VisibilityChecker<T>>
public static class VisibilityChecker.Std extends java.lang.Object implements VisibilityChecker<VisibilityChecker.Std>, java.io.Serializable
Default standard implementation is purely based on visibility modifier of given class members, and its configured minimum levels. Implemented using "builder" (or "Fluent") pattern, whereas instances are immutable, and configuration is achieved by chainable factory methods. As a result, type is declared is funky recursive generic type, to allow for sub-classing of build methods with property type co-variance.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.introspect.VisibilityChecker
VisibilityChecker.Std
-
-
Constructor Summary
Constructors Constructor Description Std(JsonAutoDetect ann)
Constructor used for building instance that has minumum visibility levels as indicated by given annotation instanceStd(JsonAutoDetect.Visibility v)
Constructor that will assign given visibility value for all properties.Std(JsonAutoDetect.Visibility getter, JsonAutoDetect.Visibility isGetter, JsonAutoDetect.Visibility setter, JsonAutoDetect.Visibility creator, JsonAutoDetect.Visibility field)
Constructor that allows directly specifying minimum visibility levels to use
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VisibilityChecker.Std
allPublicInstance()
static VisibilityChecker.Std
construct(JsonAutoDetect.Value vis)
static VisibilityChecker.Std
defaultInstance()
boolean
isCreatorVisible(AnnotatedMember m)
boolean
isCreatorVisible(java.lang.reflect.Member m)
Method for checking whether given method is auto-detectable as Creator, with respect to its visibility (not considering method signature or name, just visibility)boolean
isFieldVisible(AnnotatedField f)
boolean
isFieldVisible(java.lang.reflect.Field 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)boolean
isGetterVisible(AnnotatedMethod m)
boolean
isGetterVisible(java.lang.reflect.Method 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)boolean
isIsGetterVisible(AnnotatedMethod m)
boolean
isIsGetterVisible(java.lang.reflect.Method 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)boolean
isSetterVisible(AnnotatedMethod m)
boolean
isSetterVisible(java.lang.reflect.Method 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)java.lang.String
toString()
VisibilityChecker.Std
with(JsonAutoDetect ann)
Builder method that will return an instance that has same settings as this instance has, except for values that given annotation overrides.VisibilityChecker.Std
with(JsonAutoDetect.Visibility v)
Builder method that will create and return an instance that has specifiedJsonAutoDetect.Visibility
value to use for all property elements.VisibilityChecker.Std
withCreatorVisibility(JsonAutoDetect.Visibility v)
Builder method that will return a checker instance that has specified minimum visibility level for creator methods (constructors, factory methods)VisibilityChecker.Std
withFieldVisibility(JsonAutoDetect.Visibility v)
Builder method that will return a checker instance that has specified minimum visibility level for fields.VisibilityChecker.Std
withGetterVisibility(JsonAutoDetect.Visibility v)
Builder method that will return a checker instance that has specified minimum visibility level for regular ("getXxx") getters.VisibilityChecker.Std
withIsGetterVisibility(JsonAutoDetect.Visibility v)
Builder method that will return a checker instance that has specified minimum visibility level for "is-getters" ("isXxx").VisibilityChecker.Std
withOverrides(JsonAutoDetect.Value vis)
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.VisibilityChecker.Std
withSetterVisibility(JsonAutoDetect.Visibility v)
Builder method that will return a checker instance that has specified minimum visibility level for setters.VisibilityChecker.Std
withVisibility(PropertyAccessor method, JsonAutoDetect.Visibility v)
Builder method that will create and return an instance that has specifiedJsonAutoDetect.Visibility
value to use for specified property.
-
-
-
Constructor Detail
-
Std
public Std(JsonAutoDetect ann)
Constructor used for building instance that has minumum visibility levels as indicated by given annotation instance- Parameters:
ann
- Annotations to use for determining minimum visibility levels
-
Std
public Std(JsonAutoDetect.Visibility getter, JsonAutoDetect.Visibility isGetter, JsonAutoDetect.Visibility setter, JsonAutoDetect.Visibility creator, JsonAutoDetect.Visibility field)
Constructor that allows directly specifying minimum visibility levels to use
-
Std
public Std(JsonAutoDetect.Visibility v)
Constructor that will assign given visibility value for all properties.- Parameters:
v
- level to use for all property types
-
-
Method Detail
-
defaultInstance
public static VisibilityChecker.Std defaultInstance()
- Returns:
- Instance with default settings: "public" for getters/is-getters, fields; "any" for setters and legacy 1-arg constructors
-
allPublicInstance
public static VisibilityChecker.Std allPublicInstance()
- Returns:
- Instance with all visibility levels set to "public"
- Since:
- 2.13
-
construct
public static VisibilityChecker.Std construct(JsonAutoDetect.Value vis)
- Since:
- 2.9
-
with
public VisibilityChecker.Std with(JsonAutoDetect ann)
Description copied from interface:VisibilityChecker
Builder method that will return an instance that has same settings as this instance has, except for values that given annotation overrides.- Specified by:
with
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
withOverrides
public VisibilityChecker.Std withOverrides(JsonAutoDetect.Value vis)
Description copied from interface:VisibilityChecker
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.- Specified by:
withOverrides
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
with
public VisibilityChecker.Std with(JsonAutoDetect.Visibility v)
Description copied from interface:VisibilityChecker
Builder method that will create and return an instance that has specifiedJsonAutoDetect.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)- Specified by:
with
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
withVisibility
public VisibilityChecker.Std withVisibility(PropertyAccessor method, JsonAutoDetect.Visibility v)
Description copied from interface:VisibilityChecker
Builder method that will create and return an instance that has specifiedJsonAutoDetect.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)- Specified by:
withVisibility
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
withGetterVisibility
public VisibilityChecker.Std withGetterVisibility(JsonAutoDetect.Visibility v)
Description copied from interface:VisibilityChecker
Builder method that will return a checker instance that has specified minimum visibility level for regular ("getXxx") getters.- Specified by:
withGetterVisibility
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
withIsGetterVisibility
public VisibilityChecker.Std withIsGetterVisibility(JsonAutoDetect.Visibility v)
Description copied from interface:VisibilityChecker
Builder method that will return a checker instance that has specified minimum visibility level for "is-getters" ("isXxx").- Specified by:
withIsGetterVisibility
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
withSetterVisibility
public VisibilityChecker.Std withSetterVisibility(JsonAutoDetect.Visibility v)
Description copied from interface:VisibilityChecker
Builder method that will return a checker instance that has specified minimum visibility level for setters.- Specified by:
withSetterVisibility
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
withCreatorVisibility
public VisibilityChecker.Std withCreatorVisibility(JsonAutoDetect.Visibility v)
Description copied from interface:VisibilityChecker
Builder method that will return a checker instance that has specified minimum visibility level for creator methods (constructors, factory methods)- Specified by:
withCreatorVisibility
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
withFieldVisibility
public VisibilityChecker.Std withFieldVisibility(JsonAutoDetect.Visibility v)
Description copied from interface:VisibilityChecker
Builder method that will return a checker instance that has specified minimum visibility level for fields.- Specified by:
withFieldVisibility
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
isCreatorVisible
public boolean isCreatorVisible(java.lang.reflect.Member m)
Description copied from interface:VisibilityChecker
Method for checking whether given method is auto-detectable as Creator, with respect to its visibility (not considering method signature or name, just visibility)- Specified by:
isCreatorVisible
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
isCreatorVisible
public boolean isCreatorVisible(AnnotatedMember m)
- Specified by:
isCreatorVisible
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
isFieldVisible
public boolean isFieldVisible(java.lang.reflect.Field f)
Description copied from interface:VisibilityChecker
Method for checking whether given field is auto-detectable as property, with respect to its visibility (not considering method signature or name, just visibility)- Specified by:
isFieldVisible
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
isFieldVisible
public boolean isFieldVisible(AnnotatedField f)
- Specified by:
isFieldVisible
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
isGetterVisible
public boolean isGetterVisible(java.lang.reflect.Method m)
Description copied from interface:VisibilityChecker
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)- Specified by:
isGetterVisible
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
isGetterVisible
public boolean isGetterVisible(AnnotatedMethod m)
- Specified by:
isGetterVisible
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
isIsGetterVisible
public boolean isIsGetterVisible(java.lang.reflect.Method m)
Description copied from interface:VisibilityChecker
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)- Specified by:
isIsGetterVisible
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
isIsGetterVisible
public boolean isIsGetterVisible(AnnotatedMethod m)
- Specified by:
isIsGetterVisible
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
isSetterVisible
public boolean isSetterVisible(java.lang.reflect.Method m)
Description copied from interface:VisibilityChecker
Method for checking whether given method is auto-detectable as setter, with respect to its visibility (not considering method signature or name, just visibility)- Specified by:
isSetterVisible
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
isSetterVisible
public boolean isSetterVisible(AnnotatedMethod m)
- Specified by:
isSetterVisible
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-