aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.org.jvnet.mimepull;
aoqi@0: 
aoqi@0: import java.nio.ByteBuffer;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  * @author Jitendra Kotamraju
aoqi@0:  */
aoqi@0: interface Data {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * size of the chunk given by the parser
aoqi@0:      *
aoqi@0:      * @return size of the chunk
aoqi@0:      */
aoqi@0:     int size();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * TODO: should the return type be ByteBuffer ??
aoqi@0:      * Return part's partial data. The data is read only.
aoqi@0:      *
aoqi@0:      * @return a byte array which contains {#size()} bytes. The returned
aoqi@0:      *         array may be larger than {#size()} bytes and contains data
aoqi@0:      *         from offset 0.
aoqi@0:      */
aoqi@0:     byte[] read();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Write this partial data to a file
aoqi@0:      *
aoqi@0:      * @param file to which the data needs to be written
aoqi@0:      * @return file pointer before the write operation(at which the data is
aoqi@0:      *         written from)
aoqi@0:      */
aoqi@0:     long writeTo(DataFile file);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Factory method to create a Data. The implementation could
aoqi@0:      * be file based one or memory based one.
aoqi@0:      *
aoqi@0:      * @param dataHead start of the linked list of data objects
aoqi@0:      * @param buf contains partial content for a part
aoqi@0:      * @return Data
aoqi@0:      */
aoqi@0:     Data createNext(DataHead dataHead, ByteBuffer buf);
aoqi@0: }