| /* |
| * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Sun designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Sun in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| * CA 95054 USA or visit www.sun.com if you need additional information or |
| * have any questions. |
| * |
| * THIS FILE WAS MODIFIED BY SUN MICROSYSTEMS, INC. |
| */ |
| |
| package com.sun.xml.internal.org.jvnet.fastinfoset.sax; |
| |
| import org.xml.sax.Attributes; |
| |
| |
| /** |
| * Interface for a list of XML attributes that may contain encoding algorithm |
| * data. |
| * <p> |
| * Implementations shall ensure that the {@link Attributes#getValue(int)} method |
| * correctly returns a String object even if the attribute is represented |
| * as algorithm data. |
| * <p> |
| * If an attribute has algorithm data then the {@link #getAlgorithmData} method |
| * shall return a non <code>null</code> value. |
| * |
| * @see com.sun.xml.internal.org.jvnet.fastinfoset.sax.FastInfosetReader |
| * @see org.xml.sax.XMLReader |
| */ |
| public interface EncodingAlgorithmAttributes extends Attributes { |
| |
| /** |
| * Return the URI of the encoding algorithm. |
| * |
| * <p>If the algorithm data corresponds to a built-in encoding algorithm |
| * then the null is returned.</p> |
| * |
| * <p>If the algorithm data corresponds to an application-defined encoding |
| * algorithm then the URI of the algorithm is returned.</p> |
| * |
| * <p>If {@link #getAlgorithmData(int)} returns null then the result of |
| * this method is undefined.<p> |
| * |
| * @param index The attribute index (zero-based). |
| * @return The URI. If the index is out of range then null is returned. |
| */ |
| public String getAlgorithmURI(int index); |
| |
| /** |
| * Return the index of the encoding algorithm. |
| * |
| * <p>If {@link #getAlgorithmData(int)} returns null then the result of |
| * this method is undefined.<p> |
| * |
| * @param index The attribute index (zero-based). |
| * @return The algorithm index. If index is out of range then -1 is returned. |
| * @see com.sun.xml.internal.org.jvnet.fastinfoset.EncodingAlgorithmIndexes |
| */ |
| public int getAlgorithmIndex(int index); |
| |
| /** |
| * Return the data of the encoding algorithm. |
| * |
| * <p>If the algorithm data corresponds to a built-in encoding algorithm |
| * then an Object corresponding to the Java primitive type is returned.</p> |
| * |
| * <p>If the algorithm data corresponds to an application-defined encoding |
| * algorithm then an Object that is an instance of <code>byte[]</code> |
| * is returned if there is no EncodingAlgorithm registered for the |
| * application-defined encoding algorithm URI. Otherwise, an Object produced |
| * from the registeredEncodingAlgorithm is returned.</p> |
| * |
| * <p>If there no encoding algorithm data associated an attribute then |
| * <code>null</code> is returned.<p> |
| * |
| * @param index The attribute index (zero-based). |
| * @return The data. If the index is out of range then null is returned. |
| */ |
| public Object getAlgorithmData(int index); |
| |
| /** |
| * Return the alphabet associated with the attribute value. |
| * |
| * @param index The attribute index (zero-based). |
| * @return The alphabet. |
| * If the index is out of range then null is returned. |
| * If there is is no alphabet then null is returned. |
| */ |
| public String getAlpababet(int index); |
| |
| /** |
| * Return the whether the attribute value should be indexed or not. |
| * |
| * @param index The attribute index (zero-based). |
| * @return True if attribute value should be indexed, otherwise false. |
| */ |
| public boolean getToIndex(int index); |
| } |