VerifierToFile (SAFS API DOCUMENT)

java.lang.Object
- org.safs.persist.PersistableChecker
- - org.safs.persist.AbstractVerifier
  - - org.safs.persist.AbstractRuntimeDataVerifier
    - - org.safs.persist.VerifierToFile

All Implemented Interfaces:

Verifier

Direct Known Subclasses:

VerifierToJSONFile, VerifierToPropertiesFile, VerifierToXMLFile
```
public class VerifierToFile
extends AbstractRuntimeDataVerifier
```
Author:

Lei Wang

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map<java.lang.String,java.lang.Object>`	`actualContents` Holding the actual contents to verify, 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)}")
`protected java.util.Set<java.lang.String>`	`checkedFields` Each time a field has been checked, then that field will be put into this Set.
`protected java.util.Map<java.lang.String,java.lang.String>`	`defaultElementValues` Contains pairs of (elementName, alternativeValue), which will be used to set the value for a certain element. It has been instantiated in the constructor `VerifierToFile(RuntimeDataInterface, String)`. It can be initialized in the subclass's constructor.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`expectedContents` Holding the expected contents for verification, 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)}")
`protected java.lang.String`	`filename` The name of file to hold the information of a Persistable object to be verified.
`protected java.util.Set<java.lang.String>`	`ignoredFields` Holding the fields which are ignored.
`protected boolean`	`matchAllFields` If the all the fields of actual object need to match with those in the persistent benchmark. If this is true, all the fields of actual object need to be verified. Otherwise, only the fields specified in the persistent benchmark need to be verified.
`protected boolean`	`matched` This field will contain true if the verification succeed.
`protected java.lang.StringBuilder`	`nonMatchedMessages` It contains the messages indicating the non matched fields.
`protected java.io.Reader`	`reader` The Reader object of the bench file.
`protected boolean`	`valueCaseSensitive` If the field's value needs to be matched case-sensitively
`protected boolean`	`valueContains` If the field's value needs to be matched wholly or partially

Fields inherited from class org.safs.persist.AbstractRuntimeDataVerifier
runtime

Fields inherited from interface org.safs.persist.Verifier
BOOL_MATCH_ALL_FIELDS, BOOL_VALUE_CASESENSITIVE, BOOL_VALUE_CONTAINS

Constructor Summary

Constructors
Constructor and Description

VerifierToFile(RuntimeDataInterface runtime, java.lang.String filename)

Constructors
Constructor and Description
`VerifierToFile(RuntimeDataInterface runtime, java.lang.String filename)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`afterCheck(Persistable persistable, boolean... conditions)` Make the final check.
`protected void`	`beforeCheck(Persistable persistable, boolean... conditions)` Get some variables prepared for verification. Parse the optional parameters It is expected that subclass should override this method to provide values to `expectedContents` and `actualContents`, such as:
`protected void`	`check(Persistable persistable, boolean... conditions)`
`boolean`	`equals(java.lang.Object o)` If they have the same filename, then we consider them equivalent
`PersistenceType`	`getType()` The persistence Type.
`protected boolean`	`isIgnoredFiled(java.lang.String field)` Check if the filed is being ignored at the moment for verification.
`protected void`	`match(java.lang.String field, java.lang.Object expectation)` This method will check a certain filed's value against the `actualContents` After calling, these class fields `matched`, `checkedFields`, and `nonMatchedMessages` may get modified to show the result of verification.
`void`	`verify(Persistable persistable, boolean... conditions)` Verify a Persistable object against the contents stored in a persistence substance.

Methods inherited from class org.safs.persist.PersistableChecker
validate

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

- Field Detail
  - filename
```
protected java.lang.String filename
```
    The name of file to hold the information of a Persistable object to be verified.
  - reader
```
protected java.io.Reader reader
```
    The Reader object of the bench file. It contains the expected values.
  - defaultElementValues
```
protected java.util.Map<java.lang.String,java.lang.String> defaultElementValues
```
    Contains pairs of (elementName, alternativeValue), which will be used to set the value for a certain element.
    It has been instantiated in the constructor VerifierToFile(RuntimeDataInterface, String).
    It can be initialized in the subclass's constructor.
    
    See Also:
    
    Persistable.getContents(Map, Set, boolean), PersistableDefault.getContents(Map, Set, boolean), Persistable.CONTAINER_ELEMENT
  - actualContents
```
protected java.util.Map<java.lang.String,java.lang.Object> actualContents
```
    Holding the actual contents to verify, 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)}")
  - expectedContents
```
protected java.util.Map<java.lang.String,java.lang.Object> expectedContents
```
    Holding the expected contents for verification, 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)}")
  - checkedFields
```
protected java.util.Set<java.lang.String> checkedFields
```
    Each time a field has been checked, then that field will be put into this Set.
    
    See Also:
    
    #match(String, String)
  - ignoredFields
```
protected java.util.Set<java.lang.String> ignoredFields
```
    Holding the fields which are ignored. No need to verify.
    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
 ...
 
```
    See Also:
    
    isIgnoredFiled(String)
  - matchAllFields
```
protected boolean matchAllFields
```
    If the all the fields of actual object need to match with those in the persistent benchmark.
    If this is true, all the fields of actual object need to be verified.
    Otherwise, only the fields specified in the persistent benchmark need to be verified.
  - valueContains
```
protected boolean valueContains
```
    If the field's value needs to be matched wholly or partially
  - valueCaseSensitive
```
protected boolean valueCaseSensitive
```
    If the field's value needs to be matched case-sensitively
  - matched
```
protected boolean matched
```
    This field will contain true if the verification succeed.
  - nonMatchedMessages
```
protected java.lang.StringBuilder nonMatchedMessages
```
    It contains the messages indicating the non matched fields.
- Constructor Detail
  - VerifierToFile
```
public VerifierToFile(RuntimeDataInterface runtime,
                      java.lang.String filename)
```
- Method Detail
  - verify
```
public void verify(Persistable persistable,
                   boolean... conditions)
            throws SAFSException
```
    Description copied from interface: Verifier
    
    Verify a Persistable object against the contents stored in a persistence substance.
    Specified by:
    
    verify in interface Verifier
    
    Overrides:
    
    verify in class AbstractVerifier
    
    Parameters:
    
    persistable - Persistable, the object to verify
    conditions - boolean..., the boolean array to control the verification.
    
    conditions[0] matchAllFields
    conditions[1] valueContains
    conditions[2] valueCaseSensitive
    Throws:
    
    SAFSException - when something wrong happens.
  - beforeCheck
```
protected void beforeCheck(Persistable persistable,
                           boolean... conditions)
                    throws SAFSException,
                           java.io.IOException
```
    Get some variables prepared for verification.
    Parse the optional parameters
    It is expected that subclass should override this method to provide values to expectedContents and actualContents, such as:
```
 
 public void beforeCheck(Persistable persistable, boolean... conditions)  throws SAFSException, IOException{
    super.beforeCheck(persistable, conditions);
    //Fill in Map 'actualContents'
    //Fill in Map 'expectedContents'
 }
 
 
```
    Throws:
    
    SAFSException
    
    java.io.IOException
  - check
```
protected void check(Persistable persistable,
                     boolean... conditions)
              throws SAFSException,
                     java.io.IOException
```
    Throws:
    
    SAFSException
    
    java.io.IOException
  - afterCheck
```
protected void afterCheck(Persistable persistable,
                          boolean... conditions)
                   throws SAFSException,
                          java.io.IOException
```
    Make the final check.
    
    Throws:
    
    SAFSException
    
    java.io.IOException
  - match
```
protected void match(java.lang.String field,
                     java.lang.Object expectation)
```
    This method will check a certain filed's value against the actualContents
    After calling, these class fields matched, checkedFields, and nonMatchedMessages may get modified to show the result of verification.
    
    Parameters:
    
    field - String, the field to check
    
    expectation - Object, the field's expected value.
  - isIgnoredFiled
```
protected boolean isIgnoredFiled(java.lang.String field)
```
    Check if the filed is being ignored at the moment for verification.
```
 If the Set ignoredFields contains a field 'Response.Request',
 then all its children (starting with 'Response.Request') will be ignored, such as:
 Response.Request.Headers
 Response.Request.MessageBody
 ...
 
```
    Parameters:
    
    field - String, the field to check
    
    Returns:
    
    boolean if this field is being ignored.
    
    See Also:
    
    ignoredFields
  - getType
```
public PersistenceType getType()
```
    Description copied from interface: Verifier
    
    The persistence Type.
    
    Returns:
    
    PersistenceType
  - equals
```
public boolean equals(java.lang.Object o)
```
    If they have the same filename, then we consider them equivalent
    
    Overrides:
    
    equals in class java.lang.Object

Class VerifierToFile

Field Summary

Fields inherited from class org.safs.persist.AbstractRuntimeDataVerifier

Fields inherited from interface org.safs.persist.Verifier

Constructor Summary

Method Summary

Methods inherited from class org.safs.persist.PersistableChecker

Methods inherited from class java.lang.Object

Field Detail

filename

reader

defaultElementValues

actualContents

expectedContents

checkedFields

ignoredFields

matchAllFields

valueContains

valueCaseSensitive

matched

nonMatchedMessages

Constructor Detail

VerifierToFile

Method Detail

verify

beforeCheck

check

afterCheck

match

isIgnoredFiled

getType

equals