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

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 637
9c07ef4934dd
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

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

mercurial