org.ebay.datameta.dom.SerialDataSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dom-core Show documentation

Classes needed for DataMeta DOM functionality in JVM; with Java, Scala, Clojure, JRuby and other platforms running on a JVM.

There is a newer version: 1.0.3

Show newest version

package org.ebay.datameta.dom;
/*
 * Copyright (c) 1995, 2007, Oracle and/or its affiliates. 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.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

import java.io.InputStream;

/**
 * Generic serial data source for structured strong-typed table-oriented data, supplies one record after another.
 * No reposition (rewind), no random access.
 * Should word the same for dynamic or partial dynamic schemas if the implementation supports it.
 *
 * @param  Return type, retrieved from the data source.
 * @param  a data source to get the type from, such as {@link InputStream}
 */
public interface SerialDataSource {
    /**
     * Implementor should retrieve next item from the source.
     * @param source the data source to pull the items from.
     * @return the next item from the source, with some special value such as null or a special marker
     * implementation of {@link R} to indicate an end of the stream or any special condition.
     */
    R next(S source);
}