jaxp/src/java.xml/share/classes/javax/xml/transform/dom/package-info.java
author joehw
Wed, 24 May 2017 14:10:04 -0700
changeset 45359 a55c79938b9c
permissions -rw-r--r--
8180349: Review JAXP Java SE 9 API javadocs Reviewed-by: rriggs, lancea
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
45359
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
     1
/*
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
     2
 * Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved.
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
     4
 *
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    10
 *
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    15
 * accompanied this code).
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    16
 *
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    20
 *
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    23
 * questions.
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    24
 */
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    25
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    26
/**
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    27
 * Provides DOM specific transformation classes.
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    28
 * <p>
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    29
 * The {@link javax.xml.transform.dom.DOMSource} class allows the
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    30
 * client of the implementation of this API to specify a DOM
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    31
 * {@link org.w3c.dom.Node} as the source of the input tree. The model of
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    32
 * how the Transformer deals with the DOM tree in terms of mismatches with the
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    33
 * <A href="http://www.w3.org/TR/xslt#data-model">XSLT data model</A> or
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    34
 * other data models is beyond the scope of this document. Any of the nodes
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    35
 * derived from {@link org.w3c.dom.Node} are legal input.
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    36
 * <p>
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    37
 * The {@link javax.xml.transform.dom.DOMResult} class allows
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    38
 * a {@link org.w3c.dom.Node} to be specified to which result DOM nodes will
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    39
 * be appended. If an output node is not specified, the transformer will use
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    40
 * {@link javax.xml.parsers.DocumentBuilder#newDocument} to create an
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    41
 * output {@link org.w3c.dom.Document} node. If a node is specified, it
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    42
 * should be one of the following: {@link org.w3c.dom.Document},
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    43
 * {@link org.w3c.dom.Element}, or
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    44
 * {@link org.w3c.dom.DocumentFragment}. Specification of any other node
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    45
 * type is implementation dependent and undefined by this API. If the result is a
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    46
 * {@link org.w3c.dom.Document}, the output of the transformation must have
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    47
 * a single element root to set as the document element.
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    48
 * <p>
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    49
 * The {@link javax.xml.transform.dom.DOMLocator} node may be passed
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    50
 * to {@link javax.xml.transform.TransformerException} objects, and
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    51
 * retrieved by trying to cast the result of the
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    52
 * {@link javax.xml.transform.TransformerException#getLocator()} method.
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    53
 * The implementation has no responsibility to use a DOMLocator instead of a
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    54
 * {@link javax.xml.transform.SourceLocator} (though line numbers and the
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    55
 * like do not make much sense for a DOM), so the result of getLocator must always
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    56
 * be tested with an instanceof.
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    57
 *
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    58
 * @since 1.5
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    59
 */
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    60
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    61
package javax.xml.transform.dom;