Thu, 31 Aug 2017 15:18:52 +0800
merge
1 /*
2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
26 /*
27 * @(#)SharedInputStream.java 1.2 02/03/27
28 */
32 package com.sun.xml.internal.messaging.saaj.packaging.mime.internet;
34 import java.io.InputStream;
35 import java.io.OutputStream;
37 // SAAJ doesn't utilize this, but I think it should.
38 /**
39 * An InputStream that is backed by data that can be shared by multiple
40 * readers may implement this interface. This allows users of such an
41 * InputStream to determine the current positionin the InputStream, and
42 * to create new InputStreams representing a subset of the data in the
43 * original InputStream. The new InputStream will access the same
44 * underlying data as the original, without copying the data.
45 *
46 * @version 1.2, 02/03/27
47 * @author Bill Shannon
48 * @since JavaMail 1.2
49 */
51 public interface SharedInputStream {
52 /**
53 * Return the current position in the InputStream, as an
54 * offset from the beginning of the InputStream.
55 *
56 * @return the current position
57 */
58 public long getPosition();
60 /**
61 * Return a new InputStream representing a subset of the data
62 * from this InputStream, starting at <code>start</code> (inclusive)
63 * up to <code>end</code> (exclusive). <code>start</code> must be
64 * non-negative. If <code>end</code> is -1, the new stream ends
65 * at the same place as this stream. The returned InputStream
66 * will also implement the SharedInputStream interface.
67 *
68 * @param start the starting position
69 * @param end the ending position + 1
70 * @return the new stream
71 */
72 public InputStream newStream(long start, long end);
74 /**
75 * Writes the specified region to another {@link OutputStream}.
76 */
77 public void writeTo(long start,long end, OutputStream out);
78 }