XMLOptions (Plasma Core 2.1.5 API)

All Known Implementing Classes:

DefaultOptions
```
public interface XMLOptions
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getEncoding()` Returns the character encoding
`ErrorHandler`	`getErrorHandler()` Returns the current XML Schema (XSD) validation error handler
`String`	`getRootElementName()` The root element name.
`String`	`getRootElementNamespaceURI()` The root namespace URI.
`String`	`getRootNamespacePrefix()` The desired root namespace prefix.
`org.apache.commons.logging.Log`	`getValidationLog()` Returns the current XML Schema (XSD) validation error log.
`boolean`	`isFailOnValidationError()` Returns whether to propagate XML parser errors encountered when validating an XML document against an associated XML Schema.
`boolean`	`isPrettyPrint()` For XML writer utilities, returns whether to indent and format the XML output.
`boolean`	`isValidate()` Returns whether to perform XML Schema (XSD) validation when reading XML input.
`void`	`setEncoding(String encoding)` Sets the character encoding.
`void`	`setErrorHandler(ErrorHandler handler)` Sets the current XML Schema (XSD) validation error handler
`void`	`setPrettyPrint(boolean prettyPrint)` For XML writer utilities, sets whether to indent and format the XML output.
`void`	`setRootElementName(String rootElementName)` Sets root element name
`void`	`setRootElementNamespaceURI(String rootElementName)` Sets root namespace URI.
`void`	`setRootNamespacePrefix(String rootNamespacePrefix)` Sets desired root namespace prefix.
`void`	`setValidate(boolean validate)` Set whether to perform XML Schema (XSD) validation when reading XML input.
`void`	`setValidationLog(org.apache.commons.logging.Log validationLog)` Sets the current XML Schema (XSD) validation error log

- Method Detail
  - getRootNamespacePrefix
```
String getRootNamespacePrefix()
```
    The desired root namespace prefix.
    
    Returns:
    
    the desired root namespace prefix
  - setRootNamespacePrefix
```
void setRootNamespacePrefix(String rootNamespacePrefix)
```
    Sets desired root namespace prefix.
    
    Parameters:
    
    rootNamespacePrefix - the desired root namespace prefix
  - getRootElementNamespaceURI
```
String getRootElementNamespaceURI()
```
    The root namespace URI.
    
    Returns:
    
    the root namespace URI
  - setRootElementNamespaceURI
```
void setRootElementNamespaceURI(String rootElementName)
```
    Sets root namespace URI.
    
    Parameters:
    
    rootElementName - the root namespace URI
  - getRootElementName
```
String getRootElementName()
```
    The root element name.
    
    Returns:
    
    the root element name
  - setRootElementName
```
void setRootElementName(String rootElementName)
```
    Sets root element name
    
    Parameters:
    
    rootElementName - the root element name
  - isValidate
```
boolean isValidate()
```
    Returns whether to perform XML Schema (XSD) validation when reading XML input. By default, any errors encountered are logged within the context of the parsing utility unless a log is supplied.
    
    Returns:
    
    whether to perform XML Schema (XSD) validation when reading XML input.
    
    See Also:
    
    Log
  - setValidate
```
void setValidate(boolean validate)
```
    Set whether to perform XML Schema (XSD) validation when reading XML input. By default, any errors encountered are logged within the context of the parsing utility unless a log is supplied.
    
    Parameters:
    
    validate - whether to perform XML Schema (XSD) validation
  - getValidationLog
```
org.apache.commons.logging.Log getValidationLog()
```
    Returns the current XML Schema (XSD) validation error log.
    
    Returns:
    
    current XML Schema (XSD) validation error log
  - setValidationLog
```
void setValidationLog(org.apache.commons.logging.Log validationLog)
```
    Sets the current XML Schema (XSD) validation error log
    
    Parameters:
    
    validationLog - the log
  - isFailOnValidationError
```
boolean isFailOnValidationError()
```
    Returns whether to propagate XML parser errors encountered when validating an XML document against an associated XML Schema. Only 'ERROR' and 'FATAL' errors are propagated.
    
    Returns:
    
    whether to propagate XML parser errors encountered when validating an XML document against an associated XML Schema
  - getErrorHandler
```
ErrorHandler getErrorHandler()
```
    Returns the current XML Schema (XSD) validation error handler
    
    Returns:
    
    the current XML Schema (XSD) validation error handler
  - setErrorHandler
```
void setErrorHandler(ErrorHandler handler)
```
    Sets the current XML Schema (XSD) validation error handler
    
    Parameters:
    
    handler - the current XML Schema (XSD) validation error handler
  - getEncoding
```
String getEncoding()
```
    Returns the character encoding
    
    Returns:
    
    the character encoding
  - setEncoding
```
void setEncoding(String encoding)
```
    Sets the character encoding. E.g. ISO-8859-1
    
    Parameters:
    
    encoding - the character encoding
  - isPrettyPrint
```
boolean isPrettyPrint()
```
    For XML writer utilities, returns whether to indent and format the XML output.
    
    Returns:
  - setPrettyPrint
```
void setPrettyPrint(boolean prettyPrint)
```
    For XML writer utilities, sets whether to indent and format the XML output.
    
    Parameters:
    
    prettyPrint - whether to indent and format the XML output

Interface XMLOptions

Method Summary

Method Detail

getRootNamespacePrefix

setRootNamespacePrefix

getRootElementNamespaceURI

setRootElementNamespaceURI

getRootElementName

setRootElementName

isValidate

setValidate

getValidationLog

setValidationLog

isFailOnValidationError

getErrorHandler

setErrorHandler

getEncoding

setEncoding

isPrettyPrint

setPrettyPrint