src/share/jaxws_classes/com/sun/xml/internal/org/jvnet/mimepull/Data.java

Thu, 31 Aug 2017 15:18:52 +0800

author
aoqi
date
Thu, 31 Aug 2017 15:18:52 +0800
changeset 637
9c07ef4934dd
parent 368
0989ad8c0860
parent 0
373ffda63c9a
permissions
-rw-r--r--

merge

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package com.sun.xml.internal.org.jvnet.mimepull;
aoqi@0 27
aoqi@0 28 import java.nio.ByteBuffer;
aoqi@0 29
aoqi@0 30 /**
aoqi@0 31 * @author Kohsuke Kawaguchi
aoqi@0 32 * @author Jitendra Kotamraju
aoqi@0 33 */
aoqi@0 34 interface Data {
aoqi@0 35
aoqi@0 36 /**
aoqi@0 37 * size of the chunk given by the parser
aoqi@0 38 *
aoqi@0 39 * @return size of the chunk
aoqi@0 40 */
aoqi@0 41 int size();
aoqi@0 42
aoqi@0 43 /**
aoqi@0 44 * TODO: should the return type be ByteBuffer ??
aoqi@0 45 * Return part's partial data. The data is read only.
aoqi@0 46 *
aoqi@0 47 * @return a byte array which contains {#size()} bytes. The returned
aoqi@0 48 * array may be larger than {#size()} bytes and contains data
aoqi@0 49 * from offset 0.
aoqi@0 50 */
aoqi@0 51 byte[] read();
aoqi@0 52
aoqi@0 53 /**
aoqi@0 54 * Write this partial data to a file
aoqi@0 55 *
aoqi@0 56 * @param file to which the data needs to be written
aoqi@0 57 * @return file pointer before the write operation(at which the data is
aoqi@0 58 * written from)
aoqi@0 59 */
aoqi@0 60 long writeTo(DataFile file);
aoqi@0 61
aoqi@0 62 /**
aoqi@0 63 * Factory method to create a Data. The implementation could
aoqi@0 64 * be file based one or memory based one.
aoqi@0 65 *
aoqi@0 66 * @param dataHead start of the linked list of data objects
aoqi@0 67 * @param buf contains partial content for a part
aoqi@0 68 * @return Data
aoqi@0 69 */
aoqi@0 70 Data createNext(DataHead dataHead, ByteBuffer buf);
aoqi@0 71 }

mercurial