Config (selenium tests framework 4.0.3 API)

java.lang.Object
- com.seleniumtests.xmldog.Config

All Implemented Interfaces:

XMLDogConstants
```
public class Config
extends Object
implements XMLDogConstants
```
Config class containing configuration information about the XMLDog Application including the XML parser.
configuration

Attach Config when instantiating XMLDog to provide your own configuration

Attributes for the Element Node to be excluded during comparison and Only the Attributes
to be used to compare the Element Nodes can be specified.

Elements to be ignored during the comparison can also be specified

Unique attributes for Element Nodes can be specified which will be used to identify matching
Element Nodes

Field Summary
- Fields inherited from interface com.seleniumtests.xmldog.XMLDogConstants
  APP_NAME, DEBUG, EVENT_NODE_IDENTICAL, EVENT_NODE_MISMATCH, EVENT_NODE_SIMILAR

Constructor Summary

Constructors
Constructor and Description

Config()
Default Constructor.

Constructors
Constructor and Description
`Config()` Default Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addExcludedAttribute(String elementName, String attrName)` Adds Attribute to be excluded in the Element comparison.
`void`	`addExcludedAttributes(String elementName, List attrNames)` Adds Attributes to be excluded in the Element comparison.
`void`	`addExcludedElement(String elementName)` Adds Element name to the excluded Elements Set.
`void`	`addIncludedAttribute(String elementName, String attrName)` Adds Attribute to be included in the Element comparison.
`void`	`addIncludedAttributes(String elementName, List attrNames)` Adds Attributes to be included in the Element comparison.
`void`	`addUniqueAttribute(String elementName, String attrName)` Add Unique Attribute to the Element which will force Elements to be identical.
`boolean`	`applyEListToSiblings()` Checks if EList entries apply to the siblings or not.
`Map`	`getExcludedAttributesMap()` Gets excluded Attributes Map.
`Set`	`getExcludedElementsSet()` Gets excluded Elements Map.
`Map`	`getIncludedAttributesMap()` Gets included Attributes Map.
`Map`	`getUniqueAttributeMap()` Gets unique Attributes Map.
`Map`	`getXPathEList()` Gets Elist containing XPath.
`boolean`	`includesNodeValuesInXPath()`
`boolean`	`isCustomDifference()` Checks if Custom Difference is turned on.
`boolean`	`isDetailedMode()` Checks if XMLDog is working in the detailed mode.
`boolean`	`isExpandingEntityRefs()` Checks if XMLDog is expanding Entity References in the Documents.
`boolean`	`isIgnoringComments()` Checks if XMLDog is ignoring comments.
`boolean`	`isIgnoringOrder()` Gets IgnoringOrder flag.
`boolean`	`isIgnoringWhitespace()` Gets IgnoringWhitespace flag.
`boolean`	`isNamespaceAware()` Gets Namespace aware flag.
`boolean`	`isValidating()` Gets Validating flag.
`boolean`	`isXPathEListEnabled()` Checks if XPath elist is enabled.
`Map`	`loadXPathEList(String filename)` Loads XPath EList.
`static void`	`log(String msg)` Prints msg to System.out.
`static void`	`log(String msg, Throwable t)` Prints msg and Exception to System.out.
`static void`	`main(String[] args)`
`static String`	`parseRegEx(String line)` Parses input string for the Regular Expression.
`void`	`setApplyEListToSiblings(boolean flag)` Sets the flag indicating whether EList entries should be applied to the siblings of the.
`void`	`setCustomDifference(boolean flag)` Sets Custom difference flag.
`void`	`setDetailedMode(boolean flag)` Sets if XMLDog is in the Detailed mode.
`void`	`setExpandingEntityRefs(boolean flag)` Sets if XMLDog is expanding Entity regferences in the Documents.
`void`	`setIgnoringComments(boolean flag)` Sets flag for ignoring XML Comments.
`void`	`setIgnoringOrder(boolean flag)` Sets IgnoringOrder flag.
`void`	`setIgnoringWhitespace(boolean flag)` Sets IgnoringWhitespace flag.
`void`	`setIncludeNodeValuesInXPath(boolean flag)`
`void`	`setNamespaceAware(boolean flag)` Sets Namespace aware flag.
`void`	`setValidating(boolean flag)` Sets Validating flag.
`void`	`setXPathEListEnabled(boolean flag)` Enables - disables XPath elist.

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

- Constructor Detail
  - Config
```
public Config()
```
    Default Constructor.
- Method Detail
  - setValidating
```
public void setValidating(boolean flag)
```
    Sets Validating flag.
  - isValidating
```
public boolean isValidating()
```
    Gets Validating flag.
  - setIgnoringWhitespace
```
public void setIgnoringWhitespace(boolean flag)
```
    Sets IgnoringWhitespace flag.
  - isIgnoringWhitespace
```
public boolean isIgnoringWhitespace()
```
    Gets IgnoringWhitespace flag.
  - setIgnoringOrder
```
public void setIgnoringOrder(boolean flag)
```
    Sets IgnoringOrder flag.
    
    Set this flag to true if the order in which the elements occur doesnt matter,
    for stricter comparison set it to false
  - isIgnoringOrder
```
public boolean isIgnoringOrder()
```
    Gets IgnoringOrder flag.
    
    This flag is used to determine if order in which elements occur in Golden
    and current Document is ignored
  - setNamespaceAware
```
public void setNamespaceAware(boolean flag)
```
    Sets Namespace aware flag.
  - isNamespaceAware
```
public boolean isNamespaceAware()
```
    Gets Namespace aware flag.
  - setIgnoringComments
```
public void setIgnoringComments(boolean flag)
```
    Sets flag for ignoring XML Comments.
  - isIgnoringComments
```
public boolean isIgnoringComments()
```
    Checks if XMLDog is ignoring comments.
  - setExpandingEntityRefs
```
public void setExpandingEntityRefs(boolean flag)
```
    Sets if XMLDog is expanding Entity regferences in the Documents.
  - isExpandingEntityRefs
```
public boolean isExpandingEntityRefs()
```
    Checks if XMLDog is expanding Entity References in the Documents.
  - setDetailedMode
```
public void setDetailedMode(boolean flag)
```
    Sets if XMLDog is in the Detailed mode.
    
    A Detailed mode forces XMLDog to continue finding the
    differences in the entire Document versus a Non-Detailed mode
    will stop processing the Document as soon as first difference is found.
    
    Use this feature based on the for performance and Application requirements.
  - isDetailedMode
```
public boolean isDetailedMode()
```
    Checks if XMLDog is working in the detailed mode.
  - setIncludeNodeValuesInXPath
```
public void setIncludeNodeValuesInXPath(boolean flag)
```
  - includesNodeValuesInXPath
```
public boolean includesNodeValuesInXPath()
```
  - setCustomDifference
```
public void setCustomDifference(boolean flag)
```
    Sets Custom difference flag.
    If Custom difference is set to true, Differences will be logged identical to
    XMLUnit
    
    See Also:
    DifferenceConstants
  - isCustomDifference
```
public boolean isCustomDifference()
```
    Checks if Custom Difference is turned on.
    If Custom difference is turned on, each Node difference as defined in DifferenceConstants
    will be logged
    
    See Also:
    DifferenceConstants, NodeDetail
  - setApplyEListToSiblings
```
public void setApplyEListToSiblings(boolean flag)
```
    Sets the flag indicating whether EList entries should be applied to the siblings of the.
    same type or not
  - applyEListToSiblings
```
public boolean applyEListToSiblings()
```
    Checks if EList entries apply to the siblings or not.
    
    Returns:
    true if it does, false otherwise
  - addIncludedAttribute
```
public void addIncludedAttribute(String elementName,
                        String attrName)
```
    Adds Attribute to be included in the Element comparison.
  - addIncludedAttributes
```
public void addIncludedAttributes(String elementName,
                         List attrNames)
```
    Adds Attributes to be included in the Element comparison.
  - addExcludedAttribute
```
public void addExcludedAttribute(String elementName,
                        String attrName)
```
    Adds Attribute to be excluded in the Element comparison.
  - addExcludedAttributes
```
public void addExcludedAttributes(String elementName,
                         List attrNames)
```
    Adds Attributes to be excluded in the Element comparison.
  - addUniqueAttribute
```
public void addUniqueAttribute(String elementName,
                      String attrName)
```
    Add Unique Attribute to the Element which will force Elements to be identical.
  - addExcludedElement
```
public void addExcludedElement(String elementName)
```
    Adds Element name to the excluded Elements Set.
  - getExcludedAttributesMap
```
public Map getExcludedAttributesMap()
```
    Gets excluded Attributes Map.
  - getIncludedAttributesMap
```
public Map getIncludedAttributesMap()
```
    Gets included Attributes Map.
  - getUniqueAttributeMap
```
public Map getUniqueAttributeMap()
```
    Gets unique Attributes Map.
  - getExcludedElementsSet
```
public Set getExcludedElementsSet()
```
    Gets excluded Elements Map.
  - setXPathEListEnabled
```
public void setXPathEListEnabled(boolean flag)
```
    Enables - disables XPath elist.
    
    Parameters:
    flag - the boolean flag
  - isXPathEListEnabled
```
public boolean isXPathEListEnabled()
```
    Checks if XPath elist is enabled.
    
    Returns:
    true if elist enabled, false otherwise
  - loadXPathEList
```
public Map loadXPathEList(String filename)
```
    Loads XPath EList.
    
    Elist is a list of XPath expressions to exclude Nodes represented by the XPath expression
    from the comparison
    
    Returns:
    the Map containing all the XPath exclusion entries
  - parseRegEx
```
public static String parseRegEx(String line)
```
    Parses input string for the Regular Expression.
    
    e.g. Line containing Regular Expression for Attribute value
    /emp/[@name="value"]
  - getXPathEList
```
public Map getXPathEList()
```
    Gets Elist containing XPath.
    
    Returns:
    the Set containing XPath Elist
  - log
```
public static void log(String msg)
```
    Prints msg to System.out.
  - log
```
public static void log(String msg,
       Throwable t)
```
    Prints msg and Exception to System.out.
  - main
```
public static void main(String[] args)
```

Class Config

Field Summary

Fields inherited from interface com.seleniumtests.xmldog.XMLDogConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Config

Method Detail

setValidating

isValidating

setIgnoringWhitespace

isIgnoringWhitespace

setIgnoringOrder

isIgnoringOrder

setNamespaceAware

isNamespaceAware

setIgnoringComments

isIgnoringComments

setExpandingEntityRefs

isExpandingEntityRefs

setDetailedMode

isDetailedMode

setIncludeNodeValuesInXPath

includesNodeValuesInXPath

setCustomDifference

isCustomDifference

setApplyEListToSiblings

applyEListToSiblings

addIncludedAttribute

addIncludedAttributes

addExcludedAttribute

addExcludedAttributes

addUniqueAttribute

addExcludedElement

getExcludedAttributesMap

getIncludedAttributesMap

getUniqueAttributeMap

getExcludedElementsSet

setXPathEListEnabled

isXPathEListEnabled

loadXPathEList

parseRegEx

getXPathEList

log

log

main