org.crosswire.jsword.book
Class IndexStatus

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

public class IndexStatus
extends Object
implements Serializable

An Enumeration of the possible types of Book.

NOTE(joe): consider giving each a number (1,2,4,8) and allowing combinations

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: IndexStatus.java,v 1.2 2005/01/24 23:26:59 dmsmith Exp $
Author:
Joe Walker [joe at eireneh dot com]
See Also:
Licence, Serialized Form

Field Summary
static IndexStatus CREATING
          An index is currently being generated for this Book
static IndexStatus DONE
          There is a complete and ready to use search index
private  String name
          The name of the BookType
private static int nextObj
           
private  int obj
           
static IndexStatus SCHEDULED
          This Book has been scheduled for index creation
private static long serialVersionUID
          Serialization ID
static IndexStatus UNDONE
          There is no search index, and no plans to create one
private static IndexStatus[] VALUES
          All the known values
 
Constructor Summary
private IndexStatus(String name)
           
 
Method Summary
 boolean equals(Object o)
          Prevent subclasses from overriding canonical identity based Object methods
static IndexStatus fromInteger(int i)
          Lookup method to convert from an integer
static IndexStatus fromString(String name)
          Lookup method to convert from a String
 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

DONE

public static final IndexStatus DONE
There is a complete and ready to use search index


UNDONE

public static final IndexStatus UNDONE
There is no search index, and no plans to create one


SCHEDULED

public static final IndexStatus SCHEDULED
This Book has been scheduled for index creation


CREATING

public static final IndexStatus CREATING
An index is currently being generated for this Book


VALUES

private static final IndexStatus[] VALUES
All the known values


name

private String name
The name of the BookType


nextObj

private static int nextObj

obj

private final int obj

serialVersionUID

private static final long serialVersionUID
Serialization ID

See Also:
Constant Field Values
Constructor Detail

IndexStatus

private IndexStatus(String name)
Parameters:
name - The name of the BookType
Method Detail

fromString

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


fromInteger

public static IndexStatus 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