OpenJDK 27 · com.sun.org.apache.xml.internal.serializer.OutputPropertiesFactory

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 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 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:

S_KEY_INDENT_AMOUNT - The non-standard property key to use to set the indentation amount. The "indent" key needs to have a value of "yes", and this properties value is a the number of whitespaces to indent by per indentation level.
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. The output of the serializer will be SAX events sent to this an object of this class.
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. A line in such a file is has the name of the entity and the numeric (base 10) value of the corresponding character, like this one:
quot=34
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.
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.

Field Summary

Modifier and Type	Field and Description
private static Properties	m_html_properties The default properties when method="html".
private static Properties	m_text_properties The default properties when method="text".
private static Properties	m_unknown_properties The properties when method="" for the "unknown" wrapper
private static Properties	m_xml_properties The default properties for all other than html and text.
private static final String[]	PROP_HTML
private static final String[]	PROP_HTML_VALUE
private static final String[]	PROP_TEXT
private static final String[]	PROP_TEXT_VALUE
private static final String[]	PROP_UNKNOWN
private static final String[]	PROP_UNKNOWN_VALUE
private static final String[]	PROP_XML
private static final String[]	PROP_XML_VALUE
public static final String	S_BUILTIN_EXTENSIONS_UNIVERSAL This is not a public API.
private static final String	S_BUILTIN_EXTENSIONS_URL S_BUILTIN_EXTENSIONS_URL is a mnemonic for the XML Namespace (http://xml.apache.org/xalan) predefined to signify Xalan's built-in XSLT Extensions.
public static final String	S_BUILTIN_OLD_EXTENSIONS_UNIVERSAL The old built-in extension namespace, this is not a public API.
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.
private static final String	S_BUILTIN_OLD_EXTENSIONS_URL The old built-in extension url.
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.
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.
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".
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".
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.
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.

Constructor Summary

Access	Constructor and Description
public	OutputPropertiesFactory()

Method Summary

Modifier and Type	Method and Description
public static final Properties	Returns: Properties object that holds the defaults for the given method. getDefaultMethodProperties(String non-null reference to method name. method) Returns a Properties based on the specified method.
private static Properties	initProperties(String[] an array of keys keys, String[] values corresponding to the keys values, Properties Default properties, which may be null. defaults) Initiates the properties

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

m_html_properties	back to summary
private static Properties m_html_properties The default properties when method="html".

m_text_properties	back to summary
private static Properties m_text_properties The default properties when method="text".

m_unknown_properties	back to summary
private static Properties m_unknown_properties The properties when method="" for the "unknown" wrapper

m_xml_properties	back to summary
private static Properties m_xml_properties The default properties for all other than html and text.

PROP_HTML	back to summary
private static final String[] PROP_HTML

PROP_HTML_VALUE	back to summary
private static final String[] PROP_HTML_VALUE

PROP_TEXT	back to summary
private static final String[] PROP_TEXT

PROP_TEXT_VALUE	back to summary
private static final String[] PROP_TEXT_VALUE

PROP_UNKNOWN	back to summary
private static final String[] PROP_UNKNOWN

PROP_UNKNOWN_VALUE	back to summary
private static final String[] PROP_UNKNOWN_VALUE

PROP_XML	back to summary
private static final String[] PROP_XML

PROP_XML_VALUE	back to summary
private static final String[] PROP_XML_VALUE

S_BUILTIN_EXTENSIONS_UNIVERSAL	back to summary
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_EXTENSIONS_URL	back to summary
private static final String S_BUILTIN_EXTENSIONS_URL S_BUILTIN_EXTENSIONS_URL is a mnemonic for the XML Namespace (http://xml.apache.org/xalan) predefined to signify Xalan's built-in XSLT Extensions. When used in stylesheets, this is often bound to the "xalan:" prefix.

S_BUILTIN_OLD_EXTENSIONS_UNIVERSAL	back to summary
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	back to summary
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_BUILTIN_OLD_EXTENSIONS_URL	back to summary
private static final String S_BUILTIN_OLD_EXTENSIONS_URL The old built-in extension url. It is still supported for backward compatibility.

S_KEY_CONTENT_HANDLER	back to summary
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	back to summary
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	back to summary
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	back to summary
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	back to summary
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	back to summary
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.

Constructor Detail

OutputPropertiesFactory	back to summary
public OutputPropertiesFactory()

Method Detail

getDefaultMethodProperties	back to summary
public static final Properties getDefaultMethodProperties(String method) Returns a Properties based on the specified method. The default is xml. Parameters method:String non-null reference to method name. Returns:Properties Properties object that holds the defaults for the given method.

getDefaultMethodProperties

back to summary

public static final Properties getDefaultMethodProperties(String method)

Returns a Properties based on the specified method. The default is xml.

Parameters

method:String: non-null reference to method name.

Returns:Properties

Properties object that holds the defaults for the given method.

initProperties	back to summary
private static Properties initProperties(String[] keys, String[] values, Properties defaults) Initiates the properties Parameters keys:String[] an array of keys values:String[] values corresponding to the keys defaults:Properties Default properties, which may be null.

initProperties