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.poifs.storage;
57   
58   import java.io.IOException;
59   
60   /**
61    * Interface for lists of blocks that are mapped by block allocation
62    * tables
63    *
64    * @author Marc Johnson (mjohnson at apache dot org
65    */
66   
67   public interface BlockList
68   {
69   
70       /**
71        * remove the specified block from the list
72        *
73        * @param index the index of the specified block; if the index is
74        *              out of range, that's ok
75        */
76   
77       public void zap(final int index);
78   
79       /**
80        * remove and return the specified block from the list
81        *
82        * @param index the index of the specified block
83        *
84        * @return the specified block
85        *
86        * @exception IOException if the index is out of range or has
87        *            already been removed
88        */
89   
90       public ListManagedBlock remove(final int index)
91           throws IOException;
92   
93       /**
94        * get the blocks making up a particular stream in the list. The
95        * blocks are removed from the list.
96        *
97        * @param startBlock the index of the first block in the stream
98        *
99        * @return the stream as an array of correctly ordered blocks
100       *
101       * @exception IOException if blocks are missing
102       */
103  
104      public ListManagedBlock [] fetchBlocks(final int startBlock)
105          throws IOException;
106  
107      /**
108       * set the associated BlockAllocationTable
109       *
110       * @param bat the associated BlockAllocationTable
111       *
112       * @exception IOException
113       */
114  
115      public void setBAT(final BlockAllocationTableReader bat)
116          throws IOException;
117  }   // end public interface BlockList
118  
119