PersistableDefault (SAFS API DOCUMENT)

java.lang.Object
- org.safs.persist.PersistableDefault

All Implemented Interfaces:

Persistable, Printable

Direct Known Subclasses:

AuthorizationServer, AutoItRs.DefaultRecognizable, Content, OAuth2, Parameter, PersistTest.MyPersistable, Request, Response, SimpleAuth, SSOAuth
```
public abstract class PersistableDefault
extends java.lang.Object
implements Persistable, Printable
```
Author:

Lei Wang

Field Summary

Fields
Modifier and Type	Field and Description
`protected static boolean`	`DEFAULT_MATCH_ALL_FIELD_MODIFIERS`
`protected static java.lang.String`	`DEFAULT_VALUE`
`protected boolean`	`enabled`
`protected static java.lang.String`	`FAILED_RETRIEVE_VALUE`
`protected java.util.Map<java.lang.String,java.lang.String>`	`fieldNameToPersistKeyMap` a cache holding the Map of (fieldName, persistKey)
`protected int`	`ignoredFiledModifiers` The field's modifiers to check to tell if this field will be ignored; The check depends also on `matchAllFieldModifiers`. The filed's modifiers is a combination of bits, such as Modifier.FINAL \| Modifier.STATIC etc. If `matchAllFieldModifiers` is true, then ignore the filed if the it's modifiers fit all bits set in `ignoredFiledModifiers`. Otherwise, ignore the filed if the it's modifiers fit one of bits set in `ignoredFiledModifiers`.
`protected boolean`	`matchAllFieldModifiers` If it is true, then ignore the filed if it's modifiers fit all bits set in `ignoredFiledModifiers`.
`protected static int`	`MODIFIER_CONSTANT`
`protected static int`	`MODIFIER_NONE`
`protected Persistable`	`parent`
`protected java.util.Map<java.lang.String,java.lang.Object>`	`persistKeyToFieldValueMap` a cache holding the Map of (persistKey, fieldValue)
`protected int`	`tabulation`
`protected int`	`threshold`
`protected boolean`	`thresholdEnabled`
`protected static java.lang.String`	`UNKNOWN_VALUE`

Fields inherited from interface org.safs.persist.Persistable
CONTAINER_ELEMENT

Fields inherited from interface org.safs.Printable
DATA_BIGGER_THAN_THRESHOLD

Constructor Summary

Constructors
Modifier	Constructor and Description
	`PersistableDefault()`
`protected`	`PersistableDefault(int ignoredFiledModifiers)` Construct a PersistableDefault with modifier to filter the field for persisting.
`protected`	`PersistableDefault(int ignoredFiledModifiers, boolean matchAllFieldModifiers)` Construct a PersistableDefault with modifier to filter the field for persisting.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` If The parameter obj is also a Persistable.
`java.util.Map<java.lang.String,java.lang.Object>`	`getContents()` This method use Java reflection to get the value of the field defined in `getPersitableFields()`.
`java.util.Map<java.lang.String,java.lang.Object>`	`getContents(java.util.Map<java.lang.String,java.lang.String> elementAlternativeValues, java.util.Set<java.lang.String> ignoredFields, boolean includeContainer)` Turn the Persistable hierarchical contents Map (`Persistable.getContents()`) into a flat-key Map.
`java.lang.Object`	`getField(java.lang.String persistKey)` Get the field's value of this Persistable object according to the persist-key. The field name can be got from `Persistable.getPersitableFields()` according to the persist-key, then the value will be got of that field.
`java.lang.String`	`getFlatKey()` A Persistable object can contain other Persistable objects, it is an hierarchical structure.
`Persistable`	`getParent()`
`java.util.Map<java.lang.String,java.lang.String>`	`getPersitableFields()` This default implementation get all the declared fields `Class.getDeclaredFields()` and put their name as 'fieldName' and 'persistKey' into the 'persistableFields Map'.
`int`	`getTabulation()`
`static java.lang.String`	`getTagName(java.lang.String className)` Convert a full qualified class name into a tag name.
`int`	`getThreshold()`
`protected boolean`	`ignoreFieldForPersist(java.lang.reflect.Field field)`
`boolean`	`isEnabled()` Tell us if this object will be persisted or not.
`boolean`	`isIgnoredContentCache()`
`boolean`	`isThresholdEnabled()` If enabled, then the data bigger than the 'threshold' will not be printed out.
`void`	`setEnabled(boolean enabled)` Sometimes, we don't want to persist an object, we disable it.
`boolean`	`setField(java.lang.String persistKey, java.lang.Object value)` Set the field's value of this Persistable object to the persist-key. The field name can be got from `Persistable.getPersitableFields()` according to the persist-key, then the value will be set to that field.
`void`	`setIgnoredContentCache(boolean ignoredContentCache)`
`void`	`setParent(Persistable parent)` Persistable object can contain Persistable object to form a tree-like structure. When defining a Persistable class, it is important to this method in the setter of Persistable-field to make sure that the `Persistor` and `Verifier` can work correctly.
`void`	`setTabulation(int tabulation)`
`void`	`setThreshold(int threshold)`
`void`	`setThresholdEnabled(boolean thresholdEnabled)` Enable/disable the "threshold ability". If enabled, then the data bigger than the 'threshold' will not be printed out.
`java.lang.String`	`toString()`

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

- Field Detail
  - UNKNOWN_VALUE
```
protected static final java.lang.String UNKNOWN_VALUE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_VALUE
```
protected static final java.lang.String DEFAULT_VALUE
```
    See Also:
    
    Constant Field Values
  - FAILED_RETRIEVE_VALUE
```
protected static final java.lang.String FAILED_RETRIEVE_VALUE
```
    See Also:
    
    Constant Field Values
  - fieldNameToPersistKeyMap
```
protected java.util.Map<java.lang.String,java.lang.String> fieldNameToPersistKeyMap
```
    a cache holding the Map of (fieldName, persistKey)
  - persistKeyToFieldValueMap
```
protected java.util.Map<java.lang.String,java.lang.Object> persistKeyToFieldValueMap
```
    a cache holding the Map of (persistKey, fieldValue)
  - enabled
```
protected boolean enabled
```
  - parent
```
protected Persistable parent
```
  - tabulation
```
protected int tabulation
```
  - threshold
```
protected int threshold
```
  - thresholdEnabled
```
protected boolean thresholdEnabled
```
  - MODIFIER_NONE
```
protected static final int MODIFIER_NONE
```
    See Also:
    
    Constant Field Values
  - MODIFIER_CONSTANT
```
protected static final int MODIFIER_CONSTANT
```
    See Also:
    
    Constant Field Values
  - ignoredFiledModifiers
```
protected int ignoredFiledModifiers
```
    The field's modifiers to check to tell if this field will be ignored; The check depends also on matchAllFieldModifiers.
    The filed's modifiers is a combination of bits, such as Modifier.FINAL | Modifier.STATIC etc.
    If matchAllFieldModifiers is true, then ignore the filed if the it's modifiers fit all bits set in ignoredFiledModifiers.
    Otherwise, ignore the filed if the it's modifiers fit one of bits set in ignoredFiledModifiers.
    
    See Also:
    
    matchAllFieldModifiers
  - DEFAULT_MATCH_ALL_FIELD_MODIFIERS
```
protected static final boolean DEFAULT_MATCH_ALL_FIELD_MODIFIERS
```
    See Also:
    
    Constant Field Values
  - matchAllFieldModifiers
```
protected boolean matchAllFieldModifiers
```
    If it is true, then ignore the filed if it's modifiers fit all bits set in ignoredFiledModifiers. Otherwise, ignore the filed if the it's modifiers fit one of bits set in ignoredFiledModifiers.
    
    See Also:
    
    ignoredFiledModifiers
- Constructor Detail
  - PersistableDefault
```
public PersistableDefault()
```
  - PersistableDefault
```
protected PersistableDefault(int ignoredFiledModifiers)
```
    Construct a PersistableDefault with modifier to filter the field for persisting.
```
 Note:
 This constructor is protected, and it is suggested to call it
 in a constructor without parameter to keep the consistency between "pickle" and "unpickle".
 If user makes it public in a child class and create a Persistable object with it,
 then inconsistency may happen between "pickle" and "unpickle", because "unpickle" uses
 the constructor without parameter, which is different than this one.
 
```
    Parameters:
    
    ignoredFiledModifiers - int, the modifier used to filter the field for persisting.
    
    See Also:
    
    ignoredFiledModifiers
  - PersistableDefault
```
protected PersistableDefault(int ignoredFiledModifiers,
                             boolean matchAllFieldModifiers)
```
    Construct a PersistableDefault with modifier to filter the field for persisting.
```
 Note:
 This constructor is protected, and it is suggested to call it
 in a constructor without parameter to keep the consistency between "pickle" and "unpickle".
 If user makes it public in a child class and create a Persistable object with it,
 then inconsistency may happen between "pickle" and "unpickle", because "unpickle" uses
 the constructor without parameter, which is different than this one.
 
```
    Parameters:
    
    ignoredFiledModifiers - int, the modifier used to filter the field for persisting.
    
    matchAllFieldModifiers - boolean, to match all bits or one of bits set in 'ignoredFiledModifiers'.
    
    See Also:
    
    ignoredFiledModifiers
- Method Detail
  - getPersitableFields
```
public java.util.Map<java.lang.String,java.lang.String> getPersitableFields()
```
    This default implementation get all the declared fields Class.getDeclaredFields() and put their name as 'fieldName' and 'persistKey' into the 'persistableFields Map'. But if ignoreFieldForPersist(Field) returns true, then that field will not get into 'persistableFields Map'.
    
    Specified by:
    
    getPersitableFields in interface Persistable
    
    Returns:
    
    Map, a Map containing a pair(fieldName, persistKey) to persist.
    
    See Also:
    
    ignoreFieldForPersist(Field)
  - ignoreFieldForPersist
```
protected boolean ignoreFieldForPersist(java.lang.reflect.Field field)
```
    Parameters:
    
    field - Field, the field to test.
    
    Returns:
    
    boolean if true, then the field should be ignored when persisting.
    
    See Also:
    
    getPersitableFields()
  - getContents
```
public java.util.Map<java.lang.String,java.lang.Object> getContents()
```
    This method use Java reflection to get the value of the field defined in getPersitableFields().
    
    Specified by:
    
    getContents in interface Persistable
    
    Returns:
    
    Map, a Map containing a pair(persistKey, fieldValue) to persist.
  - getField
```
public java.lang.Object getField(java.lang.String persistKey)
```
    Description copied from interface: Persistable
    
    Get the field's value of this Persistable object according to the persist-key.
    The field name can be got from Persistable.getPersitableFields() according to the persist-key, then the value will be got of that field.
    
    Specified by:
    
    getField in interface Persistable
    
    Parameters:
    
    persistKey - String, the persist-key (it can be tag-name in XML, key-string in JSON etc.). refer to Persistable.getPersitableFields().
  - setField
```
public boolean setField(java.lang.String persistKey,
                        java.lang.Object value)
```
    Description copied from interface: Persistable
    
    Set the field's value of this Persistable object to the persist-key.
    The field name can be got from Persistable.getPersitableFields() according to the persist-key, then the value will be set to that field.
    
    Specified by:
    
    setField in interface Persistable
    
    Parameters:
    
    persistKey - String, the persist-key (it can be tag-name in XML, key-string in JSON etc.). refer to Persistable.getPersitableFields().
    
    value - Object, the value to set
    
    Returns:
    
    boolean true if successful.
  - isEnabled
```
public boolean isEnabled()
```
    Description copied from interface: Persistable
    
    Tell us if this object will be persisted or not.
    
    Specified by:
    
    isEnabled in interface Persistable
    
    Returns:
    
    boolean, if true, this object will be persisted; otherwise, will not.
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Description copied from interface: Persistable
    
    Sometimes, we don't want to persist an object, we disable it.
    
    Specified by:
    
    setEnabled in interface Persistable
    
    Parameters:
    
    enabled - boolean, if true, this object will be persisted; otherwise, will not.
  - setParent
```
public void setParent(Persistable parent)
```
    Description copied from interface: Persistable
    
    Persistable object can contain Persistable object to form a tree-like structure.
    When defining a Persistable class, it is important to this method in the setter of Persistable-field to make sure that the Persistor and Verifier can work correctly.
    
    Specified by:
    
    setParent in interface Persistable
    
    Parameters:
    
    parent - Persistable,
  - getParent
```
public Persistable getParent()
```
    Specified by:
    
    getParent in interface Persistable
    
    Returns:
    
    Persistable, the parent Persistable object; null if it doesn't have.
  - getTagName
```
public static java.lang.String getTagName(java.lang.String className)
```
    Convert a full qualified class name into a tag name.
    
    Parameters:
    
    className - String the full qualified class name.
    
    Returns:
    
    String the tag name used in the persistence materials like XML, JSON, Properties files.
  - getFlatKey
```
public java.lang.String getFlatKey()
```
    Description copied from interface: Persistable
    
    A Persistable object can contain other Persistable objects, it is an hierarchical structure. This flat-key is supposed to represent each Persistable object uniquely.
    
    Specified by:
    
    getFlatKey in interface Persistable
    
    Returns:
    
    String, the flat key representing this Persistable object.
    
    See Also:
    
    #getContents(Map, Set)
  - getContents
```
public java.util.Map<java.lang.String,java.lang.Object> getContents(java.util.Map<java.lang.String,java.lang.String> elementAlternativeValues,
                                                                    java.util.Set<java.lang.String> ignoredFields,
                                                                    boolean includeContainer)
```
    Description copied from interface: Persistable
    
    Turn the Persistable hierarchical contents Map (Persistable.getContents()) into a flat-key Map.
    Specified by:
    
    getContents in interface Persistable
    
    Parameters:
    
    elementAlternativeValues - Map,in, contains pairs(elementName, alternativeValue), which will be used to set the value for a certain element.
    ignoredFields - Set, out, it will hold the fields (of Persistable and its children) to be ignored. This Set should be initialized an provided from outside. The field is expressed as a flat key
    
    If this Set contains a field 'Response.Request', then all its children will be ignored, such as: Response.Request.Headers Response.Request.MessageBody ...
    includeContainer - boolean, in, if the Persistable Object itself should be considered as part of the whole contents.
    For example, if we have a Persistable Response object, it contains some fields as its contents, these fields could be Response.Headers, Response.ID etc. But does "Response" itself should be put into the contents Map as a key? The answer depends on the needs.
    
    Returns:
    Map, the actual contents of Persistable and those of its children. They are pairs of (flatKey, content) such as
    (Response.ID, "FFE3543545JLFS") (Response.Headers, "{Date=Tue, 06 DEC 2016 03:08:12 GMT}") (Response.Request.Headers, "{Content-Length=4574, Via=1.1 inetgw38 (squid)}")
  - setThreshold
```
public void setThreshold(int threshold)
```
    Specified by:
    
    setThreshold in interface Printable
    
    Parameters:
    
    threshold - int, the size of the data too big to print.
  - getThreshold
```
public int getThreshold()
```
    Specified by:
    
    getThreshold in interface Printable
    
    Returns:
    
    int, the size of the data too big to print.
  - isThresholdEnabled
```
public boolean isThresholdEnabled()
```
    Description copied from interface: Printable
    
    If enabled, then the data bigger than the 'threshold' will not be printed out. Otherwise, it will be printed out.
    
    Specified by:
    
    isThresholdEnabled in interface Printable
    
    Returns:
    
    boolean, If "threshold ability" is enabled.
  - setThresholdEnabled
```
public void setThresholdEnabled(boolean thresholdEnabled)
```
    Description copied from interface: Printable
    
    Enable/disable the "threshold ability".
    If enabled, then the data bigger than the 'threshold' will not be printed out. Otherwise, it will be printed out.
    
    Specified by:
    
    setThresholdEnabled in interface Printable
  - getTabulation
```
public int getTabulation()
```
    Specified by:
    
    getTabulation in interface Printable
    
    Returns:
    
    int, The number of tabulation to print before the actual message.
  - setTabulation
```
public void setTabulation(int tabulation)
```
    Specified by:
    
    setTabulation in interface Printable
    
    Parameters:
    
    tabulation - int, The number of tabulation to print before the actual message.
  - isIgnoredContentCache
```
public boolean isIgnoredContentCache()
```
  - setIgnoredContentCache
```
public void setIgnoredContentCache(boolean ignoredContentCache)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    If
    - The parameter obj is also a Persistable.
    - The size of getPersitableFields() are same
    - The values of each field from getPersitableFields() are same
    then they will be considered as equal.
    Overrides:
    
    equals in class java.lang.Object

Class PersistableDefault

Field Summary

Fields inherited from interface org.safs.persist.Persistable

Fields inherited from interface org.safs.Printable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNKNOWN_VALUE

DEFAULT_VALUE

FAILED_RETRIEVE_VALUE

fieldNameToPersistKeyMap

persistKeyToFieldValueMap

enabled

parent

tabulation

threshold

thresholdEnabled

MODIFIER_NONE

MODIFIER_CONSTANT

ignoredFiledModifiers

DEFAULT_MATCH_ALL_FIELD_MODIFIERS

matchAllFieldModifiers

Constructor Detail

PersistableDefault

PersistableDefault

PersistableDefault

Method Detail

getPersitableFields

ignoreFieldForPersist

getContents

getField

setField

isEnabled

setEnabled

setParent

getParent

getTagName

getFlatKey

getContents

setThreshold

getThreshold

isThresholdEnabled

setThresholdEnabled

getTabulation

setTabulation

isIgnoredContentCache

setIgnoredContentCache

toString

equals