javax.xml.transform.OutputKeys Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// $Id: OutputKeys.java 569994 2007-08-27 04:28:57Z mrglavas $
package javax.xml.transform;
/**
* Provides string constants that can be used to set
* output properties for a Transformer, or to retrieve
* output properties from a Transformer or Templates object.
* All the fields in this class are read-only.
*
* @see
* section 16 of the XSL Transformations (XSLT) W3C Recommendation
*/
public class OutputKeys {
/**
* Default constructor is private on purpose. This class is
* only for static variable access, and should never be constructed.
*/
private OutputKeys() { }
/**
* method = "xml" | "html" | "text" | expanded name.
*
* The value of the method property identifies the overall method that
* should be used for outputting the result tree. Other non-namespaced
* values may be used, such as "xhtml", but, if accepted, the handling
* of such values is implementation defined. If any of the method values
* are not accepted and are not namespace qualified,
* then {@link javax.xml.transform.Transformer#setOutputProperty}
* or {@link javax.xml.transform.Transformer#setOutputProperties} will
* throw a {@link java.lang.IllegalArgumentException}.
*
* @see
* section 16 of the XSL Transformations (XSLT) W3C Recommendation
*/
public static final String METHOD = "method";
/**
* version = nmtoken.
*
* version specifies the version of the output
* method.
* When the output method is "xml", the version value specifies the
* version of XML to be used for outputting the result tree. The default
* value for the xml output method is 1.0. When the output method is
* "html", the version value indicates the version of the HTML.
* The default value for the xml output method is 4.0, which specifies
* that the result should be output as HTML conforming to the HTML 4.0
* Recommendation [HTML]. If the output method is "text", the version
* property is ignored.
* @see
* section 16 of the XSL Transformations (XSLT) W3C Recommendation
*/
public static final String VERSION = "version";
/**
* encoding = string.
*
* encoding specifies the preferred character
* encoding that the Transformer should use to encode sequences of
* characters as sequences of bytes. The value of the encoding property should be
* treated case-insensitively. The value must only contain characters in
* the range #x21 to #x7E (i.e., printable ASCII characters). The value
* should either be a charset registered with the Internet
* Assigned Numbers Authority [IANA],
* [RFC2278] or start with X-.
* @see
* section 16 of the XSL Transformations (XSLT) W3C Recommendation
*/
public static final String ENCODING = "encoding";
/**
* omit-xml-declaration = "yes" | "no".
*
* omit-xml-declaration specifies whether the XSLT
* processor should output an XML declaration; the value must be
* yes or no.
* @see
* section 16 of the XSL Transformations (XSLT) W3C Recommendation
*/
public static final String OMIT_XML_DECLARATION = "omit-xml-declaration";
/**
* standalone = "yes" | "no".
*
* standalone specifies whether the Transformer
* should output a standalone document declaration; the value must be
* yes or no.
* @see
* section 16 of the XSL Transformations (XSLT) W3C Recommendation
*/
public static final String STANDALONE = "standalone";
/**
* doctype-public = string.
* See the documentation for the {@link #DOCTYPE_SYSTEM} property
* for a description of what the value of the key should be.
*
* @see
* section 16 of the XSL Transformations (XSLT) W3C Recommendation
*/
public static final String DOCTYPE_PUBLIC = "doctype-public";
/**
* doctype-system = string.
* doctype-system specifies the system identifier
* to be used in the document type declaration.
* If the doctype-system property is specified, the xml output method
* should output a document type declaration immediately before the first
* element. The name following <!DOCTYPE should be the name of the first
* element. If doctype-public property is also specified, then the xml
* output method should output PUBLIC followed by the public identifier
* and then the system identifier; otherwise, it should output SYSTEM
* followed by the system identifier. The internal subset should be empty.
* The value of the doctype-public property should be ignored unless the doctype-system
* property is specified.
* If the doctype-public or doctype-system properties are specified,
* then the html output method should output a document type declaration
* immediately before the first element. The name following <!DOCTYPE
* should be HTML or html. If the doctype-public property is specified,
* then the output method should output PUBLIC followed by the specified
* public identifier; if the doctype-system property is also specified,
* it should also output the specified system identifier following the
* public identifier. If the doctype-system property is specified but
* the doctype-public property is not specified, then the output method
* should output SYSTEM followed by the specified system identifier.
*
* doctype-system specifies the system identifier
* to be used in the document type declaration.
* @see
* section 16 of the XSL Transformations (XSLT) W3C Recommendation
*/
public static final String DOCTYPE_SYSTEM = "doctype-system";
/**
* cdata-section-elements = expanded names.
*
* cdata-section-elements specifies a whitespace delimited
* list of the names of elements whose text node children should be output
* using CDATA sections. Note that these names must use the format
* described in the section Qualfied Name Representation in
* {@link javax.xml.transform}.
*
* @see
* section 16 of the XSL Transformations (XSLT) W3C Recommendation.
*/
public static final String CDATA_SECTION_ELEMENTS =
"cdata-section-elements";
/**
* indent = "yes" | "no".
*
* indent specifies whether the Transformer may
* add additional whitespace when outputting the result tree; the value
* must be yes or no.
* @see
* section 16 of the XSL Transformations (XSLT) W3C Recommendation
*/
public static final String INDENT = "indent";
/**
* media-type = string.
*
* media-type specifies the media type (MIME
* content type) of the data that results from outputting the result
* tree. The charset parameter should not be specified
* explicitly; instead, when the top-level media type is
* text, a charset parameter should be added
* according to the character encoding actually used by the output
* method.
* @see
* section 16 of the XSL Transformations (XSLT) W3C Recommendation
*/
public static final String MEDIA_TYPE = "media-type";
}