org.apache.xml.serializer

Class OutputPropertiesFactory

public final class OutputPropertiesFactory extends Object

This class is a factory to generate a set of default properties of key/value pairs that are used to create a serializer through the factory {@link SerializerFactory SerilizerFactory}. The properties generated by this factory may be modified to non-default values before the SerializerFactory is used to create a Serializer.

The given output types supported are "xml", "text", and "html". These type strings can be obtained from the {@link Method Method} class in this package.

Other constants defined in this class are the non-standard property keys that can be used to set non-standard property values on a java.util.Properties object that is used to create or configure a serializer. Here are the non-standard keys:

See Also: SerializerFactory Method Serializer

Field Summary
static StringS_BUILTIN_EXTENSIONS_UNIVERSAL
This is not a public API.
static StringS_BUILTIN_OLD_EXTENSIONS_UNIVERSAL
The old built-in extension namespace, this is not a public API.
static intS_BUILTIN_OLD_EXTENSIONS_UNIVERSAL_LEN
This is not a public API, it is only public because it is used by outside of this package, it is the length of the old built-in extension namespace.
static StringS_KEY_CONTENT_HANDLER
This non-standard property key is used to set the name of the fully qualified Java class that implements the ContentHandler interface.
static StringS_KEY_ENTITIES
This non-standard property key is used to specify the name of the property file that specifies character to entity reference mappings.
static StringS_KEY_INDENT_AMOUNT
The non-standard property key to use to set the number of whitepaces to indent by, per indentation level, if indent="yes".
static StringS_KEY_LINE_SEPARATOR
The non-standard property key to use to set the number of whitepaces to indent by, per indentation level, if indent="yes".
static StringS_OMIT_META_TAG
This non-standard property key is used to set a value of "yes" if the META tag should be omitted where it would otherwise be supplied.
static StringS_USE_URL_ESCAPING
This non-standard property key is used to set a value of "yes" if the href values for HTML serialization should use %xx escaping.
Method Summary
static PropertiesgetDefaultMethodProperties(String method)
Creates an empty OutputProperties with the property key/value defaults specified by a property file.

Field Detail

S_BUILTIN_EXTENSIONS_UNIVERSAL

public static final String S_BUILTIN_EXTENSIONS_UNIVERSAL
This is not a public API. This is the built-in extensions namespace, reexpressed in {namespaceURI} syntax suitable for prepending to a localname to produce a "universal name".

S_BUILTIN_OLD_EXTENSIONS_UNIVERSAL

public static final String S_BUILTIN_OLD_EXTENSIONS_UNIVERSAL
The old built-in extension namespace, this is not a public API.

S_BUILTIN_OLD_EXTENSIONS_UNIVERSAL_LEN

public static final int S_BUILTIN_OLD_EXTENSIONS_UNIVERSAL_LEN
This is not a public API, it is only public because it is used by outside of this package, it is the length of the old built-in extension namespace.

S_KEY_CONTENT_HANDLER

public static final String S_KEY_CONTENT_HANDLER
This non-standard property key is used to set the name of the fully qualified Java class that implements the ContentHandler interface. Fully qualified name of class with a default constructor that implements the ContentHandler interface, where the result tree events will be sent to.

S_KEY_ENTITIES

public static final String S_KEY_ENTITIES
This non-standard property key is used to specify the name of the property file that specifies character to entity reference mappings.

S_KEY_INDENT_AMOUNT

public static final String S_KEY_INDENT_AMOUNT
The non-standard property key to use to set the number of whitepaces to indent by, per indentation level, if indent="yes".

S_KEY_LINE_SEPARATOR

public static final String S_KEY_LINE_SEPARATOR
The non-standard property key to use to set the number of whitepaces to indent by, per indentation level, if indent="yes".

S_OMIT_META_TAG

public static final String S_OMIT_META_TAG
This non-standard property key is used to set a value of "yes" if the META tag should be omitted where it would otherwise be supplied.

S_USE_URL_ESCAPING

public static final String S_USE_URL_ESCAPING
This non-standard property key is used to set a value of "yes" if the href values for HTML serialization should use %xx escaping.

Method Detail

getDefaultMethodProperties

public static final Properties getDefaultMethodProperties(String method)
Creates an empty OutputProperties with the property key/value defaults specified by a property file. The method argument is used to construct a string of the form output_[method].properties (for instance, output_html.properties). The output_xml.properties file is always used as the base.

Anything other than 'text', 'xml', and 'html', will use the output_xml.properties file.

Parameters: method non-null reference to method name.

Returns: Properties object that holds the defaults for the given method.

Copyright © 2005 Apache XML Project. All Rights Reserved.