View Javadoc

1   /**
2    * JDBM LICENSE v1.00
3    *
4    * Redistribution and use of this software and associated documentation
5    * ("Software"), with or without modification, are permitted provided
6    * that the following conditions are met:
7    *
8    * 1. Redistributions of source code must retain copyright
9    *    statements and notices.  Redistributions must also contain a
10   *    copy of this document.
11   *
12   * 2. Redistributions in binary form must reproduce the
13   *    above copyright notice, this list of conditions and the
14   *    following disclaimer in the documentation and/or other
15   *    materials provided with the distribution.
16   *
17   * 3. The name "JDBM" must not be used to endorse or promote
18   *    products derived from this Software without prior written
19   *    permission of Cees de Groot.  For written permission,
20   *    please contact cg@cdegroot.com.
21   *
22   * 4. Products derived from this Software may not be called "JDBM"
23   *    nor may "JDBM" appear in their names without prior written
24   *    permission of Cees de Groot. 
25   *
26   * 5. Due credit should be given to the JDBM Project
27   *    (http://jdbm.sourceforge.net/).
28   *
29   * THIS SOFTWARE IS PROVIDED BY THE JDBM PROJECT AND CONTRIBUTORS
30   * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
31   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
32   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
33   * CEES DE GROOT OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
34   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
35   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
36   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
37   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
38   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
39   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
40   * OF THE POSSIBILITY OF SUCH DAMAGE.
41   *
42   * Copyright 2000 (C) Cees de Groot. All Rights Reserved.
43   * Contributions are Copyright (C) 2000 by their associated contributors.
44   *
45   * $Id: Magic.java,v 1.1 2000/05/06 00:00:31 boisvert Exp $
46   */
47  
48  package jdbm.recman;
49  
50  /**
51   *  This interface contains magic cookies.
52   */
53  public interface Magic {
54      /** Magic cookie at start of file */
55      public short FILE_HEADER = 0x1350;
56  
57      /** Magic for blocks. They're offset by the block type magic codes. */
58      public short BLOCK = 0x1351;
59  
60      /** Magics for blocks in certain lists. Offset by baseBlockMagic */
61      short FREE_PAGE = 0;
62      short USED_PAGE = 1;
63      short TRANSLATION_PAGE = 2;
64      short FREELOGIDS_PAGE = 3;
65      short FREEPHYSIDS_PAGE = 4;
66  
67      /** Number of lists in a file */
68      public short NLISTS = 5;
69  
70      /**
71       *  Maximum number of blocks in a file, leaving room for a 16 bit
72       *  offset encoded within a long.
73       */
74      long MAX_BLOCKS = 0x7FFFFFFFFFFFL;
75  
76      /** Magic for transaction file */
77      short LOGFILE_HEADER = 0x1360;
78  
79      /** Size of an externalized byte */
80      public short SZ_BYTE = 1;
81      /** Size of an externalized short */
82      public short SZ_SHORT = 2;
83      /** Size of an externalized int */
84      public short SZ_INT = 4;
85      /** Size of an externalized long */
86      public short SZ_LONG = 8;
87  }