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

changeset 286
f50545b5e2f1
child 368
0989ad8c0860
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/org/jvnet/mimepull/Data.java	Tue Mar 06 16:09:35 2012 -0800
     1.3 @@ -0,0 +1,71 @@
     1.4 +/*
     1.5 + * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package com.sun.xml.internal.org.jvnet.mimepull;
    1.30 +
    1.31 +import java.nio.ByteBuffer;
    1.32 +
    1.33 +/**
    1.34 + * @author Kohsuke Kawaguchi
    1.35 + * @author Jitendra Kotamraju
    1.36 + */
    1.37 +interface Data {
    1.38 +
    1.39 +    /**
    1.40 +     * size of the chunk given by the parser
    1.41 +     *
    1.42 +     * @return size of the chunk
    1.43 +     */
    1.44 +    int size();
    1.45 +
    1.46 +    /**
    1.47 +     * TODO: should the return type be ByteBuffer ??
    1.48 +     * Return part's partial data. The data is read only.
    1.49 +     *
    1.50 +     * @return a byte array which contains {#size()} bytes. The returned
    1.51 +     *         array may be larger than {#size()} bytes and contains data
    1.52 +     *         from offset 0.
    1.53 +     */
    1.54 +    byte[] read();
    1.55 +
    1.56 +    /**
    1.57 +     * Write this partial data to a file
    1.58 +     *
    1.59 +     * @param file to which the data needs to be written
    1.60 +     * @return file pointer before the write operation(at which the data is
    1.61 +     *         written from)
    1.62 +     */
    1.63 +    long writeTo(DataFile file);
    1.64 +
    1.65 +    /**
    1.66 +     * Factory method to create a Data. The implementation could
    1.67 +     * be file based one or memory based one.
    1.68 +     *
    1.69 +     * @param dataHead start of the linked list of data objects
    1.70 +     * @param buf contains partial content for a part
    1.71 +     * @return Data
    1.72 +     */
    1.73 +    Data createNext(DataHead dataHead, ByteBuffer buf);
    1.74 +}

mercurial