1    
2    /* ====================================================================
3     * The Apache Software License, Version 1.1
4     *
5     * Copyright (c) 2002 The Apache Software Foundation.  All rights
6     * reserved.
7     *
8     * Redistribution and use in source and binary forms, with or without
9     * modification, are permitted provided that the following conditions
10    * are met:
11    *
12    * 1. Redistributions of source code must retain the above copyright
13    *    notice, this list of conditions and the following disclaimer.
14    *
15    * 2. Redistributions in binary form must reproduce the above copyright
16    *    notice, this list of conditions and the following disclaimer in
17    *    the documentation and/or other materials provided with the
18    *    distribution.
19    *
20    * 3. The end-user documentation included with the redistribution,
21    *    if any, must include the following acknowledgment:
22    *       "This product includes software developed by the
23    *        Apache Software Foundation (http://www.apache.org/)."
24    *    Alternately, this acknowledgment may appear in the software itself,
25    *    if and wherever such third-party acknowledgments normally appear.
26    *
27    * 4. The names "Apache" and "Apache Software Foundation" and
28    *    "Apache POI" must not be used to endorse or promote products
29    *    derived from this software without prior written permission. For
30    *    written permission, please contact apache@apache.org.
31    *
32    * 5. Products derived from this software may not be called "Apache",
33    *    "Apache POI", nor may "Apache" appear in their name, without
34    *    prior written permission of the Apache Software Foundation.
35    *
36    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47    * SUCH DAMAGE.
48    * ====================================================================
49    *
50    * This software consists of voluntary contributions made by many
51    * individuals on behalf of the Apache Software Foundation.  For more
52    * information on the Apache Software Foundation, please see
53    * <http://www.apache.org/>.
54    */
55   
56   package org.apache.poi.util;
57   
58   import org.apache.poi.util.LittleEndian.BufferUnderrunException;
59   
60   import java.io.*;
61   
62   /**
63    * behavior of a field at a fixed location within a byte array
64    *
65    * @author Marc Johnson (mjohnson at apache dot org
66    */
67   
68   public interface FixedField
69   {
70   
71       /**
72        * set the value from its offset into an array of bytes
73        *
74        * @param data the byte array from which the value is to be read
75        *
76        * @exception ArrayIndexOutOfBoundsException if the offset is out
77        *            of the array's valid index range
78        */
79   
80       public void readFromBytes(byte [] data)
81           throws ArrayIndexOutOfBoundsException;
82   
83       /**
84        * set the value from an InputStream
85        *
86        * @param stream the InputStream from which the value is to be
87        *               read
88        *
89        * @exception BufferUnderrunException if there is not enough data
90        *            available from the InputStream
91        * @exception IOException if an IOException is thrown from reading
92        *            the InputStream
93        */
94   
95       public void readFromStream(InputStream stream)
96           throws IOException, BufferUnderrunException;
97   
98       /**
99        * write the value out to an array of bytes at the appropriate
100       * offset
101       *
102       * @param data the array of bytes to which the value is to be
103       *             written
104       *
105       * @exception ArrayIndexOutOfBoundsException if the offset is out
106       *            of the array's valid index range
107       */
108  
109      public void writeToBytes(byte [] data)
110          throws ArrayIndexOutOfBoundsException;
111  
112      /**
113       * return the value as a String
114       *
115       * @return the value as a String
116       */
117  
118      public String toString();
119  }   // end public interface FixedField
120  
121