Class VisibilityChecker.Std
java.lang.Object
org.codehaus.jackson.map.introspect.VisibilityChecker.Std
- All Implemented Interfaces:
VisibilityChecker<VisibilityChecker.Std>
- Enclosing interface:
VisibilityChecker<T extends VisibilityChecker<T>>
public static class VisibilityChecker.Std
extends Object
implements VisibilityChecker<VisibilityChecker.Std>
Default standard implementation is purely based on visibility
modifier of given class members, and its configured minimum
levels.
Implemented using "builder" (aka "Fluid") 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.
Note on JsonAutoDetect
annotation: it is used to
access default minimum visibility access definitions.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.codehaus.jackson.map.introspect.VisibilityChecker
VisibilityChecker.Std
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final JsonAutoDetect.Visibility
protected final JsonAutoDetect.Visibility
protected final JsonAutoDetect.Visibility
protected final JsonAutoDetect.Visibility
protected final JsonAutoDetect.Visibility
protected static final VisibilityChecker.Std
This is the canonical base instance, configured with default visibility values -
Constructor Summary
ConstructorsConstructorDescriptionStd
(JsonAutoDetect ann) Constructor used for building instance that has minumum visibility levels as indicated by given annotation instanceCostructor 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
Modifier and TypeMethodDescriptionstatic VisibilityChecker.Std
boolean
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
boolean
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
boolean
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
boolean
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
boolean
Method for checking whether given method is auto-detectable as setter, with respect to its visibility (not considering method signature or name, just visibility)boolean
toString()
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.Builder method that will create and return an instance that has specifiedJsonAutoDetect.Visibility
value to use for all property elements.Builder method that will return a checker instance that has specified minimum visibility level for creator methods (constructors, factory methods)Builder method that will return a checker instance that has specified minimum visibility level for fields.Builder method that will return a checker instance that has specified minimum visibility level for regular ("getXxx") getters.Builder method that will return a checker instance that has specified minimum visibility level for "is-getters" ("isXxx").Builder method that will return a checker instance that has specified minimum visibility level for setters.withVisibility
(JsonMethod method, JsonAutoDetect.Visibility v) Builder method that will create and return an instance that has specifiedJsonAutoDetect.Visibility
value to use for specified property.
-
Field Details
-
DEFAULT
This is the canonical base instance, configured with default visibility values -
_getterMinLevel
-
_isGetterMinLevel
-
_setterMinLevel
-
_creatorMinLevel
-
_fieldMinLevel
-
-
Constructor Details
-
Std
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
Costructor that will assign given visibility value for all properties.- Parameters:
v
- level to use for all property types- Since:
- 1.9
-
-
Method Details
-
defaultInstance
-
with
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>
-
with
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
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
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
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
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
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
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
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
- Specified by:
isCreatorVisible
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
isFieldVisible
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
- Specified by:
isFieldVisible
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
isGetterVisible
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
- Specified by:
isGetterVisible
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
isIsGetterVisible
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
- Specified by:
isIsGetterVisible
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
isSetterVisible
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
- Specified by:
isSetterVisible
in interfaceVisibilityChecker<VisibilityChecker.Std>
-
toString
-