net.sf.jsefa.Deserializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsefa-android Show documentation

JSefa (Java Simple exchange format api) is a simple library for stream-based serialization of java objects to XML, CSV, FLR or any other format and back again using an iterator-style interface independent of the serialization format. The mapping between java object types and types of the serialization format (e. g. xml complex element types) can be defined either by annotating the java classes or programmatically using a simple API. The current implementation supports XML, CSV and FLR - for XML it is based on JSR 173.

The newest version!

/*
 * Copyright 2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.sf.jsefa;

import java.io.Reader;

import net.sf.jsefa.common.lowlevel.InputPosition;

/**
 * Iterator-style interface for stream based deserializers.
 * 
 * @author Norman Lahme-Huetig
 */
public interface Deserializer {

    /**
     * Opens a new deserialization stream based on the given reader.
     * 
     * @param reader the reader to base the stream on.
     * @throws DeserializationException
     */
    void open(Reader reader);

    /**
     * Returns true if another object can be deserialized from the stream.
     * 
     * @return true, if another object can be deserialized from the stream, otherwise false.
     * @throws DeserializationException
     */
    boolean hasNext();

    /**
     * Deserializes an object from the stream.
     * 
     * @param  the expected type of the object
     * @return the deserialized object.
     * @throws DeserializationException
     */
     T next();

    /**
     * Closes the deserialization stream. The underlying reader will be closed only if closeReader
     * is true.
     * 
     * @param closeReader if true, the underlying reader will be closed, too.
     * @throws DeserializationException
     */
    void close(boolean closeReader);

    /**
     * Returns information about the current position within the input stream.
     * @return the input position or null if no position information is available
     */
    InputPosition getInputPosition();
}