1 /*
2 * $Id: Chunk.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 org.zmpp.base.MemoryAccess;
26
27 /***
28 * The basic data structure for an IFF file, a chunk.
29 *
30 * @author Wei-ju Wu
31 * @version 1.0
32 */
33 public interface Chunk {
34
35 /***
36 * The length of an IFF chunk id in bytes.
37 */
38 static final int CHUNK_ID_LENGTH = 4;
39
40 /***
41 * The length of an IFF chunk size word in bytes.
42 */
43 static final int CHUNK_SIZEWORD_LENGTH = 4;
44
45 /***
46 * The chunk header size.
47 */
48 static final int CHUNK_HEADER_LENGTH = CHUNK_ID_LENGTH
49 + CHUNK_SIZEWORD_LENGTH;
50
51 /***
52 * Returns this IFF chunk's id. An id is a 4 byte array.
53 *
54 * @return the id
55 */
56 byte[] getId();
57
58 /***
59 * The chunk data size, excluding id and size word.
60 *
61 * @return the size
62 */
63 int getSize();
64
65 /***
66 * Returns true if this is a valid chunk.
67 *
68 * @return true if valid, false otherwise
69 */
70 boolean isValid();
71
72 /***
73 * Returns a memory access object to the chunk.
74 *
75 * @return the MemoryAccess object
76 */
77 MemoryAccess getMemoryAccess();
78 }