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 java.lang.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
JsonAutoDetectannotation: 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
Fields Modifier and Type Field Description protected JsonAutoDetect.Visibility_creatorMinLevelprotected JsonAutoDetect.Visibility_fieldMinLevelprotected JsonAutoDetect.Visibility_getterMinLevelprotected JsonAutoDetect.Visibility_isGetterMinLevelprotected JsonAutoDetect.Visibility_setterMinLevelprotected static VisibilityChecker.StdDEFAULTThis is the canonical base instance, configured with default visibility values
-
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)Costructor 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.StddefaultInstance()booleanisCreatorVisible(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)booleanisCreatorVisible(AnnotatedMember m)booleanisFieldVisible(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)booleanisFieldVisible(AnnotatedField f)booleanisGetterVisible(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)booleanisGetterVisible(AnnotatedMethod m)booleanisIsGetterVisible(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)booleanisIsGetterVisible(AnnotatedMethod m)booleanisSetterVisible(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)booleanisSetterVisible(AnnotatedMethod m)java.lang.StringtoString()VisibilityChecker.Stdwith(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.Stdwith(JsonAutoDetect.Visibility v)Builder method that will create and return an instance that has specifiedJsonAutoDetect.Visibilityvalue to use for all property elements.VisibilityChecker.StdwithCreatorVisibility(JsonAutoDetect.Visibility v)Builder method that will return a checker instance that has specified minimum visibility level for creator methods (constructors, factory methods)VisibilityChecker.StdwithFieldVisibility(JsonAutoDetect.Visibility v)Builder method that will return a checker instance that has specified minimum visibility level for fields.VisibilityChecker.StdwithGetterVisibility(JsonAutoDetect.Visibility v)Builder method that will return a checker instance that has specified minimum visibility level for regular ("getXxx") getters.VisibilityChecker.StdwithIsGetterVisibility(JsonAutoDetect.Visibility v)Builder method that will return a checker instance that has specified minimum visibility level for "is-getters" ("isXxx").VisibilityChecker.StdwithSetterVisibility(JsonAutoDetect.Visibility v)Builder method that will return a checker instance that has specified minimum visibility level for setters.VisibilityChecker.StdwithVisibility(JsonMethod method, JsonAutoDetect.Visibility v)Builder method that will create and return an instance that has specifiedJsonAutoDetect.Visibilityvalue to use for specified property.
-
-
-
Field Detail
-
DEFAULT
protected static final VisibilityChecker.Std DEFAULT
This is the canonical base instance, configured with default visibility values
-
_getterMinLevel
protected final JsonAutoDetect.Visibility _getterMinLevel
-
_isGetterMinLevel
protected final JsonAutoDetect.Visibility _isGetterMinLevel
-
_setterMinLevel
protected final JsonAutoDetect.Visibility _setterMinLevel
-
_creatorMinLevel
protected final JsonAutoDetect.Visibility _creatorMinLevel
-
_fieldMinLevel
protected final JsonAutoDetect.Visibility _fieldMinLevel
-
-
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)
Costructor that will assign given visibility value for all properties.- Parameters:
v- level to use for all property types- Since:
- 1.9
-
-
Method Detail
-
defaultInstance
public static VisibilityChecker.Std defaultInstance()
-
with
public VisibilityChecker.Std with(JsonAutoDetect ann)
Description copied from interface:VisibilityCheckerBuilder method that will return an instance that has same settings as this instance has, except for values that given annotation overrides.- Specified by:
within interfaceVisibilityChecker<VisibilityChecker.Std>
-
with
public VisibilityChecker.Std with(JsonAutoDetect.Visibility v)
Description copied from interface:VisibilityCheckerBuilder method that will create and return an instance that has specifiedJsonAutoDetect.Visibilityvalue 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:
within interfaceVisibilityChecker<VisibilityChecker.Std>
-
withVisibility
public VisibilityChecker.Std withVisibility(JsonMethod method, JsonAutoDetect.Visibility v)
Description copied from interface:VisibilityCheckerBuilder method that will create and return an instance that has specifiedJsonAutoDetect.Visibilityvalue 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:
withVisibilityin interfaceVisibilityChecker<VisibilityChecker.Std>
-
withGetterVisibility
public VisibilityChecker.Std withGetterVisibility(JsonAutoDetect.Visibility v)
Description copied from interface:VisibilityCheckerBuilder method that will return a checker instance that has specified minimum visibility level for regular ("getXxx") getters.- Specified by:
withGetterVisibilityin interfaceVisibilityChecker<VisibilityChecker.Std>
-
withIsGetterVisibility
public VisibilityChecker.Std withIsGetterVisibility(JsonAutoDetect.Visibility v)
Description copied from interface:VisibilityCheckerBuilder method that will return a checker instance that has specified minimum visibility level for "is-getters" ("isXxx").- Specified by:
withIsGetterVisibilityin interfaceVisibilityChecker<VisibilityChecker.Std>
-
withSetterVisibility
public VisibilityChecker.Std withSetterVisibility(JsonAutoDetect.Visibility v)
Description copied from interface:VisibilityCheckerBuilder method that will return a checker instance that has specified minimum visibility level for setters.- Specified by:
withSetterVisibilityin interfaceVisibilityChecker<VisibilityChecker.Std>
-
withCreatorVisibility
public VisibilityChecker.Std withCreatorVisibility(JsonAutoDetect.Visibility v)
Description copied from interface:VisibilityCheckerBuilder method that will return a checker instance that has specified minimum visibility level for creator methods (constructors, factory methods)- Specified by:
withCreatorVisibilityin interfaceVisibilityChecker<VisibilityChecker.Std>
-
withFieldVisibility
public VisibilityChecker.Std withFieldVisibility(JsonAutoDetect.Visibility v)
Description copied from interface:VisibilityCheckerBuilder method that will return a checker instance that has specified minimum visibility level for fields.- Specified by:
withFieldVisibilityin interfaceVisibilityChecker<VisibilityChecker.Std>
-
isCreatorVisible
public boolean isCreatorVisible(java.lang.reflect.Member m)
Description copied from interface:VisibilityCheckerMethod 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:
isCreatorVisiblein interfaceVisibilityChecker<VisibilityChecker.Std>
-
isCreatorVisible
public boolean isCreatorVisible(AnnotatedMember m)
- Specified by:
isCreatorVisiblein interfaceVisibilityChecker<VisibilityChecker.Std>
-
isFieldVisible
public boolean isFieldVisible(java.lang.reflect.Field f)
Description copied from interface:VisibilityCheckerMethod 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:
isFieldVisiblein interfaceVisibilityChecker<VisibilityChecker.Std>
-
isFieldVisible
public boolean isFieldVisible(AnnotatedField f)
- Specified by:
isFieldVisiblein interfaceVisibilityChecker<VisibilityChecker.Std>
-
isGetterVisible
public boolean isGetterVisible(java.lang.reflect.Method m)
Description copied from interface:VisibilityCheckerMethod 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:
isGetterVisiblein interfaceVisibilityChecker<VisibilityChecker.Std>
-
isGetterVisible
public boolean isGetterVisible(AnnotatedMethod m)
- Specified by:
isGetterVisiblein interfaceVisibilityChecker<VisibilityChecker.Std>
-
isIsGetterVisible
public boolean isIsGetterVisible(java.lang.reflect.Method m)
Description copied from interface:VisibilityCheckerMethod 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:
isIsGetterVisiblein interfaceVisibilityChecker<VisibilityChecker.Std>
-
isIsGetterVisible
public boolean isIsGetterVisible(AnnotatedMethod m)
- Specified by:
isIsGetterVisiblein interfaceVisibilityChecker<VisibilityChecker.Std>
-
isSetterVisible
public boolean isSetterVisible(java.lang.reflect.Method m)
Description copied from interface:VisibilityCheckerMethod 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:
isSetterVisiblein interfaceVisibilityChecker<VisibilityChecker.Std>
-
isSetterVisible
public boolean isSetterVisible(AnnotatedMethod m)
- Specified by:
isSetterVisiblein interfaceVisibilityChecker<VisibilityChecker.Std>
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-