org.crosswire.jsword.book.sword
Class BlockType

java.lang.Object
  extended by org.crosswire.jsword.book.sword.BlockType
All Implemented Interfaces:
Serializable

public abstract class BlockType
extends Object
implements Serializable

Data about Block types.

Distribution Licence:
JSword is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
The License is available on the internet here, or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
The copyright to this program is held by it's authors.

Version:
$Id: BlockType.java,v 1.3 2005/01/24 23:29:45 dmsmith Exp $
Author:
Joe Walker [joe at eireneh dot com], DM Smith [dmsmith555 at yahoo dot com]
See Also:
Licence, Serialized Form

Field Summary
static BlockType BLOCK_BOOK
          The level of compression is the Book
static BlockType BLOCK_CHAPTER
          The level of compression is the Book
static BlockType BLOCK_VERSE
          The level of compression is the Book
private  String name
          The name of the BlockType
private static int nextObj
           
private  int obj
           
private static BlockType[] VALUES
           
 
Constructor Summary
BlockType(String name)
          Simple ctor
 
Method Summary
 boolean equals(Object o)
          Prevent subclasses from overriding canonical identity based Object methods
static BlockType fromInteger(int i)
          Lookup method to convert from an integer
static BlockType fromString(String name)
          Lookup method to convert from a String
(package private) abstract  char getIndicator()
          Return a character indicating the kind of blocking.
 int hashCode()
          Prevent subclasses from overriding canonical identity based Object methods
(package private)  Object readResolve()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

BLOCK_BOOK

public static final BlockType BLOCK_BOOK
The level of compression is the Book


BLOCK_CHAPTER

public static final BlockType BLOCK_CHAPTER
The level of compression is the Book


BLOCK_VERSE

public static final BlockType BLOCK_VERSE
The level of compression is the Book


name

private String name
The name of the BlockType


nextObj

private static int nextObj

obj

private final int obj

VALUES

private static final BlockType[] VALUES
Constructor Detail

BlockType

public BlockType(String name)
Simple ctor

Method Detail

getIndicator

abstract char getIndicator()
Return a character indicating the kind of blocking. This is used in the names of compressed sword modules.

Returns:
the indicator

fromString

public static BlockType fromString(String name)
Lookup method to convert from a String


fromInteger

public static BlockType fromInteger(int i)
Lookup method to convert from an integer


equals

public final boolean equals(Object o)
Prevent subclasses from overriding canonical identity based Object methods

Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)

hashCode

public final int hashCode()
Prevent subclasses from overriding canonical identity based Object methods

Overrides:
hashCode in class Object
See Also:
Object.hashCode()

toString

public String toString()
Overrides:
toString in class Object

readResolve

Object readResolve()

Copyright ? 2003-2004