src/share/jaxws_classes/com/sun/xml/internal/ws/streaming/Attributes.java

Thu, 31 Aug 2017 15:18:52 +0800

author
aoqi
date
Thu, 31 Aug 2017 15:18:52 +0800
changeset 637
9c07ef4934dd
parent 368
0989ad8c0860
parent 0
373ffda63c9a
permissions
-rw-r--r--

merge

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package com.sun.xml.internal.ws.streaming;
aoqi@0 27
aoqi@0 28 import javax.xml.namespace.QName;
aoqi@0 29
aoqi@0 30 /**
aoqi@0 31 * <p> The Attributes interface is essentially a version of the
aoqi@0 32 * org.xml.sax.Attributes interface modified to use the JAX-WS QName class.</p>
aoqi@0 33 *
aoqi@0 34 * <p> Although namespace declarations can appear in the attribute list, the
aoqi@0 35 * actual values of the local name and URI properties are
aoqi@0 36 * implementation-specific. </p>
aoqi@0 37 *
aoqi@0 38 * <p> Applications that need to iterate through all the attributes can use the
aoqi@0 39 * {@link #isNamespaceDeclaration} method to identify namespace declarations
aoqi@0 40 * and skip them. </p>
aoqi@0 41 *
aoqi@0 42 * <p> Also, the URI property of an attribute will never be null. The value
aoqi@0 43 * "" (empty string) is used for the URI of non-qualified attributes. </p>
aoqi@0 44 *
aoqi@0 45 * @author WS Development Team
aoqi@0 46 */
aoqi@0 47 public interface Attributes {
aoqi@0 48
aoqi@0 49 /**
aoqi@0 50 * Return the number of attributes in the list.
aoqi@0 51 *
aoqi@0 52 */
aoqi@0 53 public int getLength();
aoqi@0 54
aoqi@0 55 /**
aoqi@0 56 * Return true if the attribute at the given index is a namespace
aoqi@0 57 * declaration.
aoqi@0 58 *
aoqi@0 59 * <p> Implementations are encouraged to optimize this method by taking into
aoqi@0 60 * account their internal representations of attributes. </p>
aoqi@0 61 *
aoqi@0 62 */
aoqi@0 63 public boolean isNamespaceDeclaration(int index);
aoqi@0 64
aoqi@0 65 /**
aoqi@0 66 * Look up an attribute's QName by index.
aoqi@0 67 *
aoqi@0 68 */
aoqi@0 69 public QName getName(int index);
aoqi@0 70
aoqi@0 71 /**
aoqi@0 72 * Look up an attribute's URI by index.
aoqi@0 73 *
aoqi@0 74 */
aoqi@0 75 public String getURI(int index);
aoqi@0 76
aoqi@0 77 /**
aoqi@0 78 * Look up an attribute's local name by index.
aoqi@0 79 * If attribute is a namespace declaration, result
aoqi@0 80 * is expected including "xmlns:".
aoqi@0 81 */
aoqi@0 82 public String getLocalName(int index);
aoqi@0 83
aoqi@0 84 /**
aoqi@0 85 * Look up an attribute's prefix by index.
aoqi@0 86 *
aoqi@0 87 */
aoqi@0 88 public String getPrefix(int index);
aoqi@0 89
aoqi@0 90 /**
aoqi@0 91 * Look up an attribute's value by index.
aoqi@0 92 *
aoqi@0 93 */
aoqi@0 94 public String getValue(int index);
aoqi@0 95
aoqi@0 96 /**
aoqi@0 97 * Look up the index of an attribute by QName.
aoqi@0 98 *
aoqi@0 99 */
aoqi@0 100 public int getIndex(QName name);
aoqi@0 101
aoqi@0 102 /**
aoqi@0 103 * Look up the index of an attribute by URI and local name.
aoqi@0 104 *
aoqi@0 105 */
aoqi@0 106 public int getIndex(String uri, String localName);
aoqi@0 107
aoqi@0 108 /**
aoqi@0 109 * Look up the index of an attribute by local name.
aoqi@0 110 *
aoqi@0 111 */
aoqi@0 112 public int getIndex(String localName);
aoqi@0 113
aoqi@0 114 /**
aoqi@0 115 * Look up the value of an attribute by QName.
aoqi@0 116 *
aoqi@0 117 */
aoqi@0 118 public String getValue(QName name);
aoqi@0 119
aoqi@0 120 /**
aoqi@0 121 * Look up the value of an attribute by URI and local name.
aoqi@0 122 *
aoqi@0 123 */
aoqi@0 124 public String getValue(String uri, String localName);
aoqi@0 125
aoqi@0 126 /**
aoqi@0 127 * Look up the value of an attribute by local name.
aoqi@0 128 *
aoqi@0 129 */
aoqi@0 130 public String getValue(String localName);
aoqi@0 131 }

mercurial