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

Fri, 04 Oct 2013 16:21:34 +0100

author
mkos
date
Fri, 04 Oct 2013 16:21:34 +0100
changeset 408
b0610cd08440
parent 368
0989ad8c0860
child 637
9c07ef4934dd
permissions
-rw-r--r--

8025054: Update JAX-WS RI integration to 2.2.9-b130926.1035
Reviewed-by: chegar

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

mercurial