org.codehaus.stax2.typed.TypedArrayDecoder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of stax2-api

Stax2 API is an extension to basic Stax 1.0 API that adds significant new functionality, such as full-featured bi-direction validation interface and high-performance Typed Access API.

There is a newer version: 4.2.2

Show newest version

package org.codehaus.stax2.typed;

/**
 * Base class that defines decoder used for decoding multiple
 * elements of an array type. Implementations typically use
 * an embedded instance of {@link TypedValueDecoder} for
 * decoding individual values.
 *
 * Set of concrete implementations is included in the reference
 * implementation of the Typed Access API.
 *
 * @author Tatu Saloranta
 *
 * @since 3.0
 */
public abstract class TypedArrayDecoder
{
    /**
     * Method called to decode single (element) value that given textual
     * input contains  and store it in result array.
     *
     * @return True if decoding is complete, that is, no more
     *   elements can be added to contained array
     */
    public abstract boolean decodeValue(String input) throws IllegalArgumentException;

    public abstract boolean decodeValue(char[] buffer, int start, int end) throws IllegalArgumentException;

    /**
     * @return Number of elements decoded and contained
     */
    public abstract int getCount();

    public abstract boolean hasRoom();
}