/*

 * Copyright (c) 1997, 2013, 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.

 */

/*

 * @(#)SharedInputStream.java 1.2 02/03/27

 */

package com.sun.xml.internal.messaging.saaj.packaging.mime.internet;

import java.io.InputStream;

import java.io.OutputStream;

// SAAJ doesn't utilize this, but I think it should.

/**

 * An InputStream that is backed by data that can be shared by multiple

 * readers may implement this interface.  This allows users of such an

 * InputStream to determine the current positionin the InputStream, and

 * to create new InputStreams representing a subset of the data in the

 * original InputStream.  The new InputStream will access the same

 * underlying data as the original, without copying the data.

 *

 * @version 1.2, 02/03/27

 * @author  Bill Shannon

 * @since JavaMail 1.2

 */

public interface SharedInputStream {

    /**

     * Return the current position in the InputStream, as an

     * offset from the beginning of the InputStream.

     *

     * @return  the current position

     */

    public long getPosition();

    /**

     * Return a new InputStream representing a subset of the data

     * from this InputStream, starting at <code>start</code> (inclusive)

     * up to <code>end</code> (exclusive).  <code>start</code> must be

     * non-negative.  If <code>end</code> is -1, the new stream ends

     * at the same place as this stream.  The returned InputStream

     * will also implement the SharedInputStream interface.

     *

     * @param   start   the starting position

     * @param   end     the ending position + 1

     * @return          the new stream

     */

    public InputStream newStream(long start, long end);

    /**

     * Writes the specified region to another {@link OutputStream}.

     */

    public void writeTo(long start,long end, OutputStream out);

}