1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
/* * The contents of this file are subject to the terms * of the Common Development and Distribution License * (the "License"). You may not use this file except * in compliance with the License. * * You can obtain a copy of the license at * https://jaxp.dev.java.net/CDDLv1.0.html. * See the License for the specific language governing * permissions and limitations under the License. * * When distributing Covered Code, include this CDDL * HEADER in each file and include the License file at * https://jaxp.dev.java.net/CDDLv1.0.html * If applicable add the following below this CDDL HEADER * with the fields enclosed by brackets "[]" replaced with * your own identifying information: Portions Copyright * [year] [name of copyright owner] */ /* * $Id: XMLEntityReader.java,v 1.3 2005/11/03 17:02:21 jeffsuttor Exp $ * @(#)OutputKeys.java 1.23 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved. */ 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. * <p>All the fields in this class are read-only.</p> * * @see <a href="http://www.w3.org/TR/xslt#output"> * section 16 of the XSL Transformations (XSLT) W3C Recommendation</a> */ 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" | <var>expanded name</var>. * * <p>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}.</p> * * @see <a href="http://www.w3.org/TR/xslt#output"> * section 16 of the XSL Transformations (XSLT) W3C Recommendation</a> */ public static final String METHOD = "method"; /** * version = <var>nmtoken</var>. * * <p><code>version</code> specifies the version of the output * method.</p> * <p>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.</p> * @see <a href="http://www.w3.org/TR/xslt#output"> * section 16 of the XSL Transformations (XSLT) W3C Recommendation</a> */ public static final String VERSION = "version"; /** * encoding = <var>string</var>. * * <p><code>encoding</code> 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 <code>charset</code> registered with the Internet * Assigned Numbers Authority <a href="http://www.iana.org/">[IANA]</a>, * <a href="http://www.ietf.org/rfc/rfc2278.txt">[RFC2278]</a> * or start with <code>X-</code>.</p> * @see <a href="http://www.w3.org/TR/xslt#output"> * section 16 of the XSL Transformations (XSLT) W3C Recommendation</a> */ public static final String ENCODING = "encoding"; /** * omit-xml-declaration = "yes" | "no". * * <p><code>omit-xml-declaration</code> specifies whether the XSLT * processor should output an XML declaration; the value must be * <code>yes</code> or <code>no</code>.</p> * @see <a href="http://www.w3.org/TR/xslt#output"> * section 16 of the XSL Transformations (XSLT) W3C Recommendation</a> */ public static final String OMIT_XML_DECLARATION = "omit-xml-declaration"; /** * standalone = "yes" | "no". * * <p><code>standalone</code> specifies whether the Transformer * should output a standalone document declaration; the value must be * <code>yes</code> or <code>no</code>.</p> * @see <a href="http://www.w3.org/TR/xslt#output"> * section 16 of the XSL Transformations (XSLT) W3C Recommendation</a> */ public static final String STANDALONE = "standalone"; /** * doctype-public = <var>string</var>. * <p>See the documentation for the {@link #DOCTYPE_SYSTEM} property * for a description of what the value of the key should be.</p> * * @see <a href="http://www.w3.org/TR/xslt#output"> * section 16 of the XSL Transformations (XSLT) W3C Recommendation</a> */ public static final String DOCTYPE_PUBLIC = "doctype-public"; /** * doctype-system = <var>string</var>. * <p><code>doctype-system</code> specifies the system identifier * to be used in the document type declaration.</p> * <p>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.</p> * <p>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.</p> * * <p><code>doctype-system</code> specifies the system identifier * to be used in the document type declaration.</p> * @see <a href="http://www.w3.org/TR/xslt#output"> * section 16 of the XSL Transformations (XSLT) W3C Recommendation</a> */ public static final String DOCTYPE_SYSTEM = "doctype-system"; /** * cdata-section-elements = <var>expanded names</var>. * * <p><code>cdata-section-elements</code> 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}.</p> * * @see <a href="http://www.w3.org/TR/xslt#output"> * section 16 of the XSL Transformations (XSLT) W3C Recommendation.</a> */ public static final String CDATA_SECTION_ELEMENTS = "cdata-section-elements"; /** * indent = "yes" | "no". * * <p><code>indent</code> specifies whether the Transformer may * add additional whitespace when outputting the result tree; the value * must be <code>yes</code> or <code>no</code>. </p> * @see <a href="http://www.w3.org/TR/xslt#output"> * section 16 of the XSL Transformations (XSLT) W3C Recommendation</a> */ public static final String INDENT = "indent"; /** * media-type = <var>string</var>. * * <p><code>media-type</code> specifies the media type (MIME * content type) of the data that results from outputting the result * tree. The <code>charset</code> parameter should not be specified * explicitly; instead, when the top-level media type is * <code>text</code>, a <code>charset</code> parameter should be added * according to the character encoding actually used by the output * method. </p> * @see <a href="http://www.w3.org/TR/xslt#output">s * ection 16 of the XSL Transformations (XSLT) W3C Recommendation</a> */ public static final String MEDIA_TYPE = "media-type"; }