1 /*
2 * $Id: FormChunk.java,v 1.1 2005/11/01 00:22:09 weiju Exp $
3 *
4 * Created on 2005/09/23
5 * Copyright 2005 by Wei-ju Wu
6 *
7 * This file is part of The Z-machine Preservation Project (ZMPP).
8 *
9 * ZMPP is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * ZMPP is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with ZMPP; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23 package org.zmpp.iff;
24
25 import java.util.Iterator;
26
27 /***
28 * FormChunk is the wrapper chunk for all other chunks.
29 *
30 * @author Wei-ju Wu
31 * @version 1.0
32 */
33 public interface FormChunk extends Chunk {
34
35 /***
36 * Returns the sub id.
37 *
38 * @return the sub id
39 */
40 byte[] getSubId();
41
42 /***
43 * Returns an iterator of chunks contained in this form chunk.
44 *
45 * @return the enumeration of sub chunks
46 */
47 Iterator<Chunk> getSubChunks();
48
49 /***
50 * Returns the chunk with the specified id.
51 *
52 * @param id the id
53 * @return the chunk with the specified id or null if it does not exist
54 */
55 Chunk getSubChunk(byte[] id);
56 }