Top Description Methods
com.sun.org.apache.xml.internal.serializer

pack-priv Interface XSLOutputAttributes

Known Direct Subinterfaces
com.sun.org.apache.xml.internal.serializer.SerializationHandler
Imports
java.util.List
This interface has methods associated with the XSLT xsl:output attribues specified in the stylesheet that effect the format of the document output. In an XSLT stylesheet these attributes appear for example as: 
<xsl:output method="xml" omit-xml-declaration="no" indent="yes"/>
The xsl:output attributes covered in this interface are: 
version
encoding
omit-xml-declarations
standalone
doctype-public
doctype-system
cdata-section-elements
indent
media-type
The one attribute not covered in this interface is method as this value is implicitly chosen by the serializer that is created, for example ToXMLStream vs. ToHTMLStream or another one. This interface is only used internally within Xalan.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the public identifier to be used in the DOCTYPE declaration in the output document.
getDoctypePublic()

Returns the previously set value of the value to be used as the public identifier in the document type declaration (DTD).

public String

Returns:

the system identifier to be used in the DOCTYPE declaration in the output document.
getDoctypeSystem()

Returns the previously set value of the value to be used as the system identifier in the document type declaration (DTD).

public String

Returns:

the character encoding to be used in the output document.
getEncoding()

public boolean

Returns:

true if the output document should be indented to visually indicate its structure.
getIndent()

public int

Returns:

the number of spaces to indent for each indentation level.
getIndentAmount()

public String

Returns:

the mediatype the media-type or MIME type associated with the output document.
getMediaType()

public boolean

Returns:

true if the XML declaration is to be omitted from the output document.
getOmitXMLDeclaration()

public String

Returns:

The value of the parameter
getOutputProperty(String
The name of the property, which is just the local name if it is in no namespace, but is the URI in curly braces followed by the local name if it is in a namespace, for example:
  • "encoding"
  • "method"
  • "{http://xml.apache.org/xalan}indent-amount"
  • "{http://xml.apache.org/xalan}line-separator"
name)

Get the value for a property that affects seraialization, if a property was set return that value, otherwise return the default value, otherwise return null.

public String

Returns:

The default value of the parameter, or null if there is no default value.
getOutputPropertyDefault(String
The name of the property.
name)

Get the default value for a property that affects seraialization, or null if there is none.

public String

Returns:

a value of "yes" if the standalone delaration is to be included in the output document.
getStandalone()

public String

Returns:

the version of the output format.
getVersion()

public void
setCdataSectionElements(List<String>
pairs of namespace URI and local names that identify elements whose text elements are to be output as CDATA sections. The namespace of the local element must be the given URI to match. The qName is not given because the prefix does not matter, only the namespace URI to which that prefix would map matters, so the prefix itself is not relevant in specifying which elements have their text to be output as CDATA sections.
URI_and_localNames)

Sets the value coming from the xsl:output cdata-section-elements stylesheet property.

public void
setDoctype(String
the system identifier to be used in the DOCTYPE declaration in the output document.
system, String
the public identifier to be used in the DOCTYPE declaration in the output document.
pub)

Set the value coming from the xsl:output doctype-public and doctype-system stylesheet properties

public void
setDoctypePublic(String
the public identifier to be used in the DOCTYPE declaration in the output document.
doctype)

Set the value coming from the xsl:output doctype-public stylesheet attribute.

public void
setDoctypeSystem(String
the system identifier to be used in the DOCTYPE declaration in the output document.
doctype)

Set the value coming from the xsl:output doctype-system stylesheet attribute.

public void
setEncoding(String
the character encoding
encoding)

Sets the character encoding coming from the xsl:output encoding stylesheet attribute.

public void
setIndent(boolean
true if the output document should be indented to visually indicate its structure.
indent)

Sets the value coming from the xsl:output indent stylesheet attribute.

public void
setMediaType(String
the media-type or MIME type associated with the output document.
mediatype)

Sets the value coming from the xsl:output media-type stylesheet attribute.

public void
setOmitXMLDeclaration(boolean
true if the XML declaration is to be omitted from the output document.
b)

Sets the value coming from the xsl:output omit-xml-declaration stylesheet attribute

public void
setOutputProperty(String
The name of the property, which is just the local name if it is in no namespace, but is the URI in curly braces followed by the local name if it is in a namespace, for example:
  • "encoding"
  • "method"
  • "{http://xml.apache.org/xalan}indent-amount"
  • "{http://xml.apache.org/xalan}line-separator"
name, String
The non-default value of the parameter
val)

Set the non-default value for a property that affects seraialization.

public void
setOutputPropertyDefault(String
The name of the property, which is just the local name if it is in no namespace, but is the URI in curly braces followed by the local name if it is in a namespace, for example:
  • "encoding"
  • "method"
  • "{http://xml.apache.org/xalan}indent-amount"
  • "{http://xml.apache.org/xalan}line-separator"
name, String
The default value of the parameter
val)

Set the default value for a property that affects seraialization.

public void
setStandalone(String
a value of "yes" indicates that the standalone delaration is to be included in the output document.
standalone)

Sets the value coming from the xsl:output standalone stylesheet attribute.

public void
setVersion(String
the version of the output format.
version)

Sets the value coming from the xsl:output version attribute.

Method Detail

getDoctypePublicback to summary
public String getDoctypePublic()

Returns the previously set value of the value to be used as the public identifier in the document type declaration (DTD).

Returns:String

the public identifier to be used in the DOCTYPE declaration in the output document.

getDoctypeSystemback to summary
public String getDoctypeSystem()

Returns the previously set value of the value to be used as the system identifier in the document type declaration (DTD).

Returns:String

the system identifier to be used in the DOCTYPE declaration in the output document.

getEncodingback to summary
public String getEncoding()
Returns:String

the character encoding to be used in the output document.

getIndentback to summary
public boolean getIndent()
Returns:boolean

true if the output document should be indented to visually indicate its structure.

getIndentAmountback to summary
public int getIndentAmount()
Returns:int

the number of spaces to indent for each indentation level.

getMediaTypeback to summary
public String getMediaType()
Returns:String

the mediatype the media-type or MIME type associated with the output document.

getOmitXMLDeclarationback to summary
public boolean getOmitXMLDeclaration()
Returns:boolean

true if the XML declaration is to be omitted from the output document.

getOutputPropertyback to summary
public String getOutputProperty(String name)

Get the value for a property that affects seraialization, if a property was set return that value, otherwise return the default value, otherwise return null.

Parameters
name:String

The name of the property, which is just the local name if it is in no namespace, but is the URI in curly braces followed by the local name if it is in a namespace, for example:

  • "encoding"
  • "method"
  • "{http://xml.apache.org/xalan}indent-amount"
  • "{http://xml.apache.org/xalan}line-separator"
Returns:String

The value of the parameter

getOutputPropertyDefaultback to summary
public String getOutputPropertyDefault(String name)

Get the default value for a property that affects seraialization, or null if there is none. It is possible that a non-default value was set for the property, however the value returned by this method is unaffected by any non-default settings.

Parameters
name:String

The name of the property.

Returns:String

The default value of the parameter, or null if there is no default value.

getStandaloneback to summary
public String getStandalone()
Returns:String

a value of "yes" if the standalone delaration is to be included in the output document.

getVersionback to summary
public String getVersion()
Returns:String

the version of the output format.

setCdataSectionElementsback to summary
public void setCdataSectionElements(List<String> URI_and_localNames)

Sets the value coming from the xsl:output cdata-section-elements stylesheet property. This sets the elements whose text elements are to be output as CDATA sections.

Parameters
URI_and_localNames:List<String>

pairs of namespace URI and local names that identify elements whose text elements are to be output as CDATA sections. The namespace of the local element must be the given URI to match. The qName is not given because the prefix does not matter, only the namespace URI to which that prefix would map matters, so the prefix itself is not relevant in specifying which elements have their text to be output as CDATA sections.

setDoctypeback to summary
public void setDoctype(String system, String pub)

Set the value coming from the xsl:output doctype-public and doctype-system stylesheet properties

Parameters
system:String

the system identifier to be used in the DOCTYPE declaration in the output document.

pub:String

the public identifier to be used in the DOCTYPE declaration in the output document.

setDoctypePublicback to summary
public void setDoctypePublic(String doctype)

Set the value coming from the xsl:output doctype-public stylesheet attribute.

Parameters
doctype:String

the public identifier to be used in the DOCTYPE declaration in the output document.

setDoctypeSystemback to summary
public void setDoctypeSystem(String doctype)

Set the value coming from the xsl:output doctype-system stylesheet attribute.

Parameters
doctype:String

the system identifier to be used in the DOCTYPE declaration in the output document.

setEncodingback to summary
public void setEncoding(String encoding)

Sets the character encoding coming from the xsl:output encoding stylesheet attribute.

Parameters
encoding:String

the character encoding

setIndentback to summary
public void setIndent(boolean indent)

Sets the value coming from the xsl:output indent stylesheet attribute.

Parameters
indent:boolean

true if the output document should be indented to visually indicate its structure.

setMediaTypeback to summary
public void setMediaType(String mediatype)

Sets the value coming from the xsl:output media-type stylesheet attribute.

Parameters
mediatype:String

the media-type or MIME type associated with the output document.

setOmitXMLDeclarationback to summary
public void setOmitXMLDeclaration(boolean b)

Sets the value coming from the xsl:output omit-xml-declaration stylesheet attribute

Parameters
b:boolean

true if the XML declaration is to be omitted from the output document.

setOutputPropertyback to summary
public void setOutputProperty(String name, String val)

Set the non-default value for a property that affects seraialization.

Parameters
name:String

The name of the property, which is just the local name if it is in no namespace, but is the URI in curly braces followed by the local name if it is in a namespace, for example:

  • "encoding"
  • "method"
  • "{http://xml.apache.org/xalan}indent-amount"
  • "{http://xml.apache.org/xalan}line-separator"
val:String

The non-default value of the parameter

setOutputPropertyDefaultback to summary
public void setOutputPropertyDefault(String name, String val)

Set the default value for a property that affects seraialization.

Parameters
name:String

The name of the property, which is just the local name if it is in no namespace, but is the URI in curly braces followed by the local name if it is in a namespace, for example:

  • "encoding"
  • "method"
  • "{http://xml.apache.org/xalan}indent-amount"
  • "{http://xml.apache.org/xalan}line-separator"
val:String

The default value of the parameter

setStandaloneback to summary
public void setStandalone(String standalone)

Sets the value coming from the xsl:output standalone stylesheet attribute.

Parameters
standalone:String

a value of "yes" indicates that the standalone delaration is to be included in the output document.

setVersionback to summary
public void setVersion(String version)

Sets the value coming from the xsl:output version attribute.

Parameters
version:String

the version of the output format.