001: /*
002: * The contents of this file are subject to the terms
003: * of the Common Development and Distribution License
004: * (the "License"). You may not use this file except
005: * in compliance with the License.
006: *
007: * You can obtain a copy of the license at
008: * https://jwsdp.dev.java.net/CDDLv1.0.html
009: * See the License for the specific language governing
010: * permissions and limitations under the License.
011: *
012: * When distributing Covered Code, include this CDDL
013: * HEADER in each file and include the License file at
014: * https://jwsdp.dev.java.net/CDDLv1.0.html If applicable,
015: * add the following below this CDDL HEADER, with the
016: * fields enclosed by brackets "[]" replaced with your
017: * own identifying information: Portions Copyright [yyyy]
018: * [name of copyright owner]
019: */
020: /*
021: * @(#)SharedInputStream.java 1.2 02/03/27
022: */
023:
024: /*
025: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
026: *
027: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
028: *
029: * The contents of this file are subject to the terms of either the GNU
030: * General Public License Version 2 only ("GPL") or the Common Development
031: * and Distribution License("CDDL") (collectively, the "License"). You
032: * may not use this file except in compliance with the License. You can obtain
033: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
034: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
035: * language governing permissions and limitations under the License.
036: *
037: * When distributing the software, include this License Header Notice in each
038: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
039: * Sun designates this particular file as subject to the "Classpath" exception
040: * as provided by Sun in the GPL Version 2 section of the License file that
041: * accompanied this code. If applicable, add the following below the License
042: * Header, with the fields enclosed by brackets [] replaced by your own
043: * identifying information: "Portions Copyrighted [year]
044: * [name of copyright owner]"
045: *
046: * Contributor(s):
047: *
048: * If you wish your version of this file to be governed by only the CDDL or
049: * only the GPL Version 2, indicate your decision by adding "[Contributor]
050: * elects to include this software in this distribution under the [CDDL or GPL
051: * Version 2] license." If you don't indicate a single choice of license, a
052: * recipient has the option to distribute your version of this file under
053: * either the CDDL, the GPL Version 2 or to extend the choice of license to
054: * its licensees as provided above. However, if you add GPL Version 2 code
055: * and therefore, elected the GPL Version 2 license, then the option applies
056: * only if the new code is made subject to such option by the copyright
057: * holder.
058: */
059:
060: package com.sun.xml.messaging.saaj.packaging.mime.internet;
061:
062: import java.io.InputStream;
063: import java.io.OutputStream;
064:
065: // SAAJ doesn't utilize this, but I think it should.
066: /**
067: * An InputStream that is backed by data that can be shared by multiple
068: * readers may implement this interface. This allows users of such an
069: * InputStream to determine the current positionin the InputStream, and
070: * to create new InputStreams representing a subset of the data in the
071: * original InputStream. The new InputStream will access the same
072: * underlying data as the original, without copying the data.
073: *
074: * @version 1.2, 02/03/27
075: * @author Bill Shannon
076: * @since JavaMail 1.2
077: */
078:
079: public interface SharedInputStream {
080: /**
081: * Return the current position in the InputStream, as an
082: * offset from the beginning of the InputStream.
083: *
084: * @return the current position
085: */
086: public long getPosition();
087:
088: /**
089: * Return a new InputStream representing a subset of the data
090: * from this InputStream, starting at <code>start</code> (inclusive)
091: * up to <code>end</code> (exclusive). <code>start</code> must be
092: * non-negative. If <code>end</code> is -1, the new stream ends
093: * at the same place as this stream. The returned InputStream
094: * will also implement the SharedInputStream interface.
095: *
096: * @param start the starting position
097: * @param end the ending position + 1
098: * @return the new stream
099: */
100: public InputStream newStream(long start, long end);
101:
102: /**
103: * Writes the specified region to another {@link OutputStream}.
104: */
105: public void writeTo(long start, long end, OutputStream out);
106: }
|