BeansWrapperConfiguration (FreeMarker 2.3.32 API)

java.lang.Object
- freemarker.ext.beans.BeansWrapperConfiguration

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

BeansWrapperBuilder, DefaultObjectWrapperConfiguration
```
public abstract class BeansWrapperConfiguration
extends java.lang.Object
implements java.lang.Cloneable
```
Holds BeansWrapper configuration settings and defines their defaults. You will not use this abstract class directly, but concrete subclasses like BeansWrapperBuilder and DefaultObjectWrapperBuilder. Unless, you are developing a builder for a custom BeansWrapper subclass.
This class is designed so that its instances can be used as lookup keys in a singleton cache. This is also why this class defines the configuration setting defaults for BeansWrapper, instead of leaving that to BeansWrapper itself. (Because, the default values influence the lookup key, and the singleton needs to be looked up without creating a BeansWrapper instance.) However, because instances are mutable, you should deep-clone it with clone(boolean) before using it as cache key.

Since:

2.3.21

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BeansWrapperConfiguration(Version incompatibleImprovements)` Same as `BeansWrapperConfiguration(Version, false)`.
`protected`	`BeansWrapperConfiguration(Version incompatibleImprovements, boolean isIncompImprsAlreadyNormalized)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.lang.Object`	`clone(boolean deepCloneKey)`
`boolean`	`equals(java.lang.Object obj)` Two `BeansWrapperConfiguration`-s are equal exactly if their classes are identical (`==`), and their field values are equal.
`int`	`getDefaultDateType()`
`boolean`	`getExposeFields()`
`int`	`getExposureLevel()`
`Version`	`getIncompatibleImprovements()`
`MemberAccessPolicy`	`getMemberAccessPolicy()`
`MethodAppearanceFineTuner`	`getMethodAppearanceFineTuner()`
`ObjectWrapper`	`getOuterIdentity()`
`boolean`	`getPreferIndexedReadMethod()`
`boolean`	`getTreatDefaultMethodsAsBeanMembers()`
`boolean`	`getUseModelCache()`
`int`	`hashCode()`
`boolean`	`isSimpleMapWrapper()`
`boolean`	`isStrict()`
`void`	`setDefaultDateType(int defaultDateType)` See `BeansWrapper.setDefaultDateType(int)`.
`void`	`setExposeFields(boolean exposeFields)` See `BeansWrapper.setExposeFields(boolean)`.
`void`	`setExposureLevel(int exposureLevel)` See `BeansWrapper.setExposureLevel(int)`.
`void`	`setMemberAccessPolicy(MemberAccessPolicy memberAccessPolicy)` See `BeansWrapper.setMemberAccessPolicy(MemberAccessPolicy)`.
`void`	`setMethodAppearanceFineTuner(MethodAppearanceFineTuner methodAppearanceFineTuner)` See `BeansWrapper.setMethodAppearanceFineTuner(MethodAppearanceFineTuner)`; additionally, note that currently setting this to non-`null` will disable class introspection cache sharing, unless the value implements `SingletonCustomizer`.
`void`	`setOuterIdentity(ObjectWrapper outerIdentity)` See `BeansWrapper.setOuterIdentity(ObjectWrapper)`, except here the default is `null` that means the `ObjectWrapper` that you will set up with this `BeansWrapperBuilder` object.
`void`	`setPreferIndexedReadMethod(boolean preferIndexedReadMethod)` See `BeansWrapper.setPreferIndexedReadMethod(boolean)`.
`void`	`setSimpleMapWrapper(boolean simpleMapWrapper)` See `BeansWrapper.setSimpleMapWrapper(boolean)`.
`void`	`setStrict(boolean strict)` See `BeansWrapper.setStrict(boolean)`.
`void`	`setTreatDefaultMethodsAsBeanMembers(boolean treatDefaultMethodsAsBeanMembers)` See `BeansWrapper.setTreatDefaultMethodsAsBeanMembers(boolean)`
`void`	`setUseModelCache(boolean useModelCache)` See `BeansWrapper.setUseCache(boolean)` (it means the same).

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BeansWrapperConfiguration
```
protected BeansWrapperConfiguration(Version incompatibleImprovements,
                                    boolean isIncompImprsAlreadyNormalized)
```
    Parameters:
    
    incompatibleImprovements - See the corresponding parameter of BeansWrapper.BeansWrapper(Version). Not null. Note that the version will be normalized to the lowest version where the same incompatible BeansWrapper improvements were already present, so for the returned instance getIncompatibleImprovements() might return a lower version than what you have specified here.
    
    isIncompImprsAlreadyNormalized - Tells if the incompatibleImprovements parameter contains an already normalized value. This parameter meant to be true when the class that extends BeansWrapper needs to add additional breaking versions over those of BeansWrapper. Thus, if this parameter is true, the versions where BeansWrapper had breaking changes must be already factored into the incompatibleImprovements parameter value, as no more normalization will happen. (You can use BeansWrapper.normalizeIncompatibleImprovementsVersion(Version) to discover those.)
    
    Since:
    
    2.3.22
  - BeansWrapperConfiguration
```
protected BeansWrapperConfiguration(Version incompatibleImprovements)
```
    Same as BeansWrapperConfiguration(Version, false).
- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Two BeansWrapperConfiguration-s are equal exactly if their classes are identical (==), and their field values are equal.
    
    Overrides:
    
    equals in class java.lang.Object
  - clone
```
protected java.lang.Object clone(boolean deepCloneKey)
```
  - isSimpleMapWrapper
```
public boolean isSimpleMapWrapper()
```
  - setSimpleMapWrapper
```
public void setSimpleMapWrapper(boolean simpleMapWrapper)
```
    See BeansWrapper.setSimpleMapWrapper(boolean).
  - getPreferIndexedReadMethod
```
public boolean getPreferIndexedReadMethod()
```
    Since:
    
    2.3.27
  - setPreferIndexedReadMethod
```
public void setPreferIndexedReadMethod(boolean preferIndexedReadMethod)
```
    See BeansWrapper.setPreferIndexedReadMethod(boolean). @since 2.3.27
  - getDefaultDateType
```
public int getDefaultDateType()
```
  - setDefaultDateType
```
public void setDefaultDateType(int defaultDateType)
```
    See BeansWrapper.setDefaultDateType(int).
  - getOuterIdentity
```
public ObjectWrapper getOuterIdentity()
```
  - setOuterIdentity
```
public void setOuterIdentity(ObjectWrapper outerIdentity)
```
    See BeansWrapper.setOuterIdentity(ObjectWrapper), except here the default is null that means the ObjectWrapper that you will set up with this BeansWrapperBuilder object.
  - isStrict
```
public boolean isStrict()
```
  - setStrict
```
public void setStrict(boolean strict)
```
    See BeansWrapper.setStrict(boolean).
  - getUseModelCache
```
public boolean getUseModelCache()
```
  - setUseModelCache
```
public void setUseModelCache(boolean useModelCache)
```
    See BeansWrapper.setUseCache(boolean) (it means the same).
  - getIncompatibleImprovements
```
public Version getIncompatibleImprovements()
```
  - getExposureLevel
```
public int getExposureLevel()
```
  - setExposureLevel
```
public void setExposureLevel(int exposureLevel)
```
    See BeansWrapper.setExposureLevel(int).
  - getExposeFields
```
public boolean getExposeFields()
```
  - setExposeFields
```
public void setExposeFields(boolean exposeFields)
```
    See BeansWrapper.setExposeFields(boolean).
  - getMemberAccessPolicy
```
public MemberAccessPolicy getMemberAccessPolicy()
```
  - setMemberAccessPolicy
```
public void setMemberAccessPolicy(MemberAccessPolicy memberAccessPolicy)
```
    See BeansWrapper.setMemberAccessPolicy(MemberAccessPolicy).
  - getTreatDefaultMethodsAsBeanMembers
```
public boolean getTreatDefaultMethodsAsBeanMembers()
```
  - setTreatDefaultMethodsAsBeanMembers
```
public void setTreatDefaultMethodsAsBeanMembers(boolean treatDefaultMethodsAsBeanMembers)
```
    See BeansWrapper.setTreatDefaultMethodsAsBeanMembers(boolean)
  - getMethodAppearanceFineTuner
```
public MethodAppearanceFineTuner getMethodAppearanceFineTuner()
```
  - setMethodAppearanceFineTuner
```
public void setMethodAppearanceFineTuner(MethodAppearanceFineTuner methodAppearanceFineTuner)
```
    See BeansWrapper.setMethodAppearanceFineTuner(MethodAppearanceFineTuner); additionally, note that currently setting this to non-null will disable class introspection cache sharing, unless the value implements SingletonCustomizer.

Class BeansWrapperConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BeansWrapperConfiguration

BeansWrapperConfiguration

Method Detail

hashCode

equals

clone

isSimpleMapWrapper

setSimpleMapWrapper

getPreferIndexedReadMethod

setPreferIndexedReadMethod

getDefaultDateType

setDefaultDateType

getOuterIdentity

setOuterIdentity

isStrict

setStrict

getUseModelCache

setUseModelCache

getIncompatibleImprovements

getExposureLevel

setExposureLevel

getExposeFields

setExposeFields

getMemberAccessPolicy

setMemberAccessPolicy

getTreatDefaultMethodsAsBeanMembers

setTreatDefaultMethodsAsBeanMembers

getMethodAppearanceFineTuner

setMethodAppearanceFineTuner