1/*
2 * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package javax.xml.stream.events;
27
28import javax.xml.namespace.QName;
29
30/**
31 * An interface that contains information about an attribute.  Attributes are reported
32 * as a set of events accessible from a StartElement.  Other applications may report
33 * Attributes as first-order events, for example as the results of an XPath expression.
34 *
35 * @version 1.0
36 * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
37 * @see StartElement
38 * @since 1.6
39 */
40public interface Attribute extends XMLEvent {
41
42  /**
43   * Returns the QName for this attribute
44   */
45  QName getName();
46
47  /**
48   * Gets the normalized value of this attribute
49   */
50  public String getValue();
51
52  /**
53   * Gets the type of this attribute, default is
54   * the String "CDATA"
55   * @return the type as a String, default is "CDATA"
56   */
57  public String getDTDType();
58
59  /**
60   * A flag indicating whether this attribute was actually
61   * specified in the start-tag of its element, or was defaulted from the schema.
62   * @return returns true if this was specified in the start element
63   */
64  public boolean isSpecified();
65
66}
67