jaxp/src/java.xml/share/classes/javax/xml/stream/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
 * <p>
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    28
 * Defines interfaces and classes for the Streaming API for XML (StAX).
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    29
 *
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    30
 * <p>
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    31
 * StAX provides two basic functions: the cursor API allowing users to
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    32
 * read and write XML efficiently, and the event iterator API promoting
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    33
 * ease of use that is event based, easy to extend and pipeline.
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    34
 * The event iterator API is intended to layer on top of the cursor API.
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    35
 *
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 cursor API defines two interfaces: {@link XMLStreamReader}
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    38
 * and {@link XMLStreamWriter}, while the event iterator API defines:
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    39
 * {@link XMLEventReader} and {@link XMLEventWriter}.
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    40
 *
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    41
 * <p>
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    42
 * StAX supports plugability with {@link XMLInputFactory} and
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    43
 * {@link XMLOutputFactory} that define how an implementation is
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    44
 * located through a process as described in the {@link newFactory}
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    45
 * method.
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    46
 *
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    47
 *
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    48
 * @since 1.6
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    49
 */
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    50
a55c79938b9c 8180349: Review JAXP Java SE 9 API javadocs
joehw
parents:
diff changeset
    51
package javax.xml.stream;