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