XmlParser (ff4j-core 1.6.3 API)

java.lang.Object
- org.ff4j.conf.XmlParser

```
public final class XmlParser
extends Object
```
Allow to parse XML files to load Feature.

Author:

Cedrick Lunven (@clunven)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CDATA_END` TAG XML.
`static String`	`CDATA_START` TAG XML.
`static String`	`ERROR_SYNTAX_IN_CONFIGURATION_FILE`
`static String`	`FEATURE_ATT_DESC` TAG XML.
`static String`	`FEATURE_ATT_ENABLE` TAG XML.
`static String`	`FEATURE_ATT_UID` TAG XML.
`static String`	`FEATURE_TAG` TAG XML.
`static String`	`FEATUREGROUP_ATTNAME` TAG XML.
`static String`	`FEATUREGROUP_TAG` TAG XML.
`static String`	`FEATURES_TAG` TAG XML.
`static String`	`FLIPSTRATEGY_ATTCLASS` TAG XML.
`static String`	`FLIPSTRATEGY_PARAMNAME` TAG XML.
`static String`	`FLIPSTRATEGY_PARAMTAG` TAG XML.
`static String`	`FLIPSTRATEGY_PARAMVALUE` TAG XML.
`static String`	`FLIPSTRATEGY_TAG` TAG XML.
`static String`	`PROPERTIES_CUSTOM_TAG` TAG XML.
`static String`	`PROPERTIES_TAG` TAG XML.
`static String`	`PROPERTY_PARAMDESCRIPTION` TAG XML.
`static String`	`PROPERTY_PARAMFIXED_VALUES` TAG XML.
`static String`	`PROPERTY_PARAMNAME` TAG XML.
`static String`	`PROPERTY_PARAMTYPE` TAG XML.
`static String`	`PROPERTY_PARAMVALUE` TAG XML.
`static String`	`PROPERTY_TAG` TAG XML.
`static String`	`SECURITY_ROLE_ATTNAME` TAG XML.
`static String`	`SECURITY_ROLE_TAG` TAG XML.
`static String`	`SECURITY_TAG` TAG XML.

Constructor Summary

Constructors
Constructor and Description

XmlParser()

Constructors
Constructor and Description
`XmlParser()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`escapeXML(String value)` Substitution to create XML.
`InputStream`	`exportAll(Map<String,Feature> mapOfFeatures, Map<String,Property<?>> mapOfProperties)` Create XML output stream with both `Feature` and `PropertyString`.
`InputStream`	`exportAll(XmlConfig conf)` Utility method to export from configuration.
`InputStream`	`exportFeatures(Map<String,Feature> mapOfFeatures)` Create XML output stream from a map of `Feature`.
`InputStream`	`exportProperties(Map<String,Property<?>> mapOfProperties)` Create XML output stream from a map of `PropertyString`.
`static DocumentBuilder`	`getDocumentBuilder()` Build `DocumentBuilder` to parse XML.
`XmlConfig`	`parseConfigurationFile(InputStream in)` Parsing of XML Configuration file.
`Map<String,Feature>`	`parseFeaturesTag(Element featuresTag)` Load map of `Feature` from an inpustream (containing xml text).

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

- Field Detail
  - FEATURES_TAG
```
public static final String FEATURES_TAG
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - FEATURE_TAG
```
public static final String FEATURE_TAG
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - FEATURE_ATT_UID
```
public static final String FEATURE_ATT_UID
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - FEATURE_ATT_DESC
```
public static final String FEATURE_ATT_DESC
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - FEATURE_ATT_ENABLE
```
public static final String FEATURE_ATT_ENABLE
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - FEATUREGROUP_TAG
```
public static final String FEATUREGROUP_TAG
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - FEATUREGROUP_ATTNAME
```
public static final String FEATUREGROUP_ATTNAME
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - FLIPSTRATEGY_TAG
```
public static final String FLIPSTRATEGY_TAG
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - PROPERTIES_TAG
```
public static final String PROPERTIES_TAG
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - PROPERTIES_CUSTOM_TAG
```
public static final String PROPERTIES_CUSTOM_TAG
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_TAG
```
public static final String PROPERTY_TAG
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_PARAMTYPE
```
public static final String PROPERTY_PARAMTYPE
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_PARAMNAME
```
public static final String PROPERTY_PARAMNAME
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_PARAMDESCRIPTION
```
public static final String PROPERTY_PARAMDESCRIPTION
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_PARAMVALUE
```
public static final String PROPERTY_PARAMVALUE
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_PARAMFIXED_VALUES
```
public static final String PROPERTY_PARAMFIXED_VALUES
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - FLIPSTRATEGY_ATTCLASS
```
public static final String FLIPSTRATEGY_ATTCLASS
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - FLIPSTRATEGY_PARAMTAG
```
public static final String FLIPSTRATEGY_PARAMTAG
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - FLIPSTRATEGY_PARAMNAME
```
public static final String FLIPSTRATEGY_PARAMNAME
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - FLIPSTRATEGY_PARAMVALUE
```
public static final String FLIPSTRATEGY_PARAMVALUE
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - SECURITY_TAG
```
public static final String SECURITY_TAG
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - SECURITY_ROLE_TAG
```
public static final String SECURITY_ROLE_TAG
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - SECURITY_ROLE_ATTNAME
```
public static final String SECURITY_ROLE_ATTNAME
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - CDATA_START
```
public static final String CDATA_START
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - CDATA_END
```
public static final String CDATA_END
```
    TAG XML.
    
    See Also:
    
    Constant Field Values
  - ERROR_SYNTAX_IN_CONFIGURATION_FILE
```
public static final String ERROR_SYNTAX_IN_CONFIGURATION_FILE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - XmlParser
```
public XmlParser()
```
- Method Detail
  - parseConfigurationFile
```
public XmlConfig parseConfigurationFile(InputStream in)
```
    Parsing of XML Configuration file.
    
    Parameters:
    
    file - target file
    
    Returns:
    
    features and properties find within file
  - parseFeaturesTag
```
public Map<String,Feature> parseFeaturesTag(Element featuresTag)
```
    Load map of Feature from an inpustream (containing xml text).
    
    Parameters:
    
    in - inpustream with XML text
    
    Returns:
    
    the sorted map of features
    
    Throws:
    
    IOException - exception raised when reading inputstream
  - getDocumentBuilder
```
public static DocumentBuilder getDocumentBuilder()
                                          throws ParserConfigurationException
```
    Build DocumentBuilder to parse XML.
    
    Returns:
    
    current document builder.
    
    Throws:
    
    ParserConfigurationException - error during initialization
  - exportFeatures
```
public InputStream exportFeatures(Map<String,Feature> mapOfFeatures)
                           throws IOException
```
    Create XML output stream from a map of Feature.
    
    Parameters:
    
    mapOfFeatures - map of features
    
    Returns:
    
    streams
    
    Throws:
    
    IOException - error occurs when generating output
  - exportProperties
```
public InputStream exportProperties(Map<String,Property<?>> mapOfProperties)
                             throws IOException
```
    Create XML output stream from a map of PropertyString.
    
    Parameters:
    
    mapOfProperties - map of properties
    
    Returns:
    
    streams
    
    Throws:
    
    IOException - error occurs when generating output
  - exportAll
```
public InputStream exportAll(Map<String,Feature> mapOfFeatures,
                             Map<String,Property<?>> mapOfProperties)
                      throws IOException
```
    Create XML output stream with both Feature and PropertyString.
    
    Parameters:
    
    f - map of features
    
    Returns:
    
    streams
    
    Throws:
    
    IOException - error occurs when generating output
  - exportAll
```
public InputStream exportAll(XmlConfig conf)
                      throws IOException
```
    Utility method to export from configuration.
    
    Parameters:
    
    conf - target configuration
    
    Returns:
    
    target stream
    
    Throws:
    
    IOException - error during marshalling
  - escapeXML
```
public String escapeXML(String value)
```
    Substitution to create XML.
    
    Parameters:
    
    value - target XML
    
    Returns:

Class XmlParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FEATURES_TAG

FEATURE_TAG

FEATURE_ATT_UID

FEATURE_ATT_DESC

FEATURE_ATT_ENABLE

FEATUREGROUP_TAG

FEATUREGROUP_ATTNAME

FLIPSTRATEGY_TAG

PROPERTIES_TAG

PROPERTIES_CUSTOM_TAG

PROPERTY_TAG

PROPERTY_PARAMTYPE

PROPERTY_PARAMNAME

PROPERTY_PARAMDESCRIPTION

PROPERTY_PARAMVALUE

PROPERTY_PARAMFIXED_VALUES

FLIPSTRATEGY_ATTCLASS

FLIPSTRATEGY_PARAMTAG

FLIPSTRATEGY_PARAMNAME

FLIPSTRATEGY_PARAMVALUE

SECURITY_TAG

SECURITY_ROLE_TAG

SECURITY_ROLE_ATTNAME

CDATA_START

CDATA_END

ERROR_SYNTAX_IN_CONFIGURATION_FILE

Constructor Detail

XmlParser

Method Detail

parseConfigurationFile

parseFeaturesTag

getDocumentBuilder

exportFeatures

exportProperties

exportAll

exportAll

escapeXML