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