|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.passage.RestrictionType
public abstract class RestrictionType
Types of Passage Restrictions.
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. |
Licence
,
Serialized FormField Summary | |
---|---|
static RestrictionType |
BOOK
Blurring is restricted to the book. |
static RestrictionType |
CHAPTER
Blurring is restricted to the chapter |
private static RestrictionType |
defaultBlurRestriction
A default restriction type for blurring. |
private String |
name
The name of the PassageListType |
private static int |
nextObj
|
static RestrictionType |
NONE
There is no restriction on blurring. |
private int |
obj
|
private static RestrictionType[] |
VALUES
|
Constructor Summary | |
---|---|
RestrictionType(String name)
Simple ctor |
Method Summary | |
---|---|
abstract VerseRange |
blur(Verse verse,
int blurDown,
int blurUp)
Blur a verse the specified amount. |
abstract VerseRange |
blur(VerseRange range,
int blurDown,
int blurUp)
Blur a verse range the specified amount. |
boolean |
equals(Object o)
Prevent subclasses from overriding canonical identity based Object methods |
static RestrictionType |
fromInteger(int i)
Lookup method to convert from an integer |
static RestrictionType |
fromString(String name)
Lookup method to convert from a String |
static int |
getBlurRestriction()
The default Blur settings. |
static RestrictionType |
getDefaultBlurRestriction()
The default Blur settings. |
int |
hashCode()
Prevent subclasses from overriding canonical identity based Object methods |
abstract boolean |
isSameScope(Verse start,
Verse end)
Are the two verses in the same scope. |
(package private) Object |
readResolve()
|
static void |
setBlurRestriction(int value)
The default Blur settings. |
int |
toInteger()
Get an integer representation for this RestrictionType |
abstract VerseRange |
toRange(Verse verse,
int count)
Create a range from the verse having the specified number of verses. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final RestrictionType NONE
public static final RestrictionType BOOK
public static final RestrictionType CHAPTER
private static RestrictionType defaultBlurRestriction
private String name
private static int nextObj
private final int obj
private static final RestrictionType[] VALUES
Constructor Detail |
---|
public RestrictionType(String name)
Method Detail |
---|
public abstract boolean isSameScope(Verse start, Verse end)
start
- the first verseend
- the second verse
public abstract VerseRange blur(VerseRange range, int blurDown, int blurUp)
range
- blurDown
- blurUp
-
public abstract VerseRange blur(Verse verse, int blurDown, int blurUp)
verse
- blurDown
- blurUp
-
public abstract VerseRange toRange(Verse verse, int count)
verse
- count
-
public int toInteger()
public static RestrictionType fromString(String name)
public static RestrictionType fromInteger(int i)
public final boolean equals(Object o)
equals
in class Object
Object.equals(java.lang.Object)
public final int hashCode()
hashCode
in class Object
Object.hashCode()
public String toString()
toString
in class Object
public static void setBlurRestriction(int value)
value
- The new default blur settingpublic static int getBlurRestriction()
public static RestrictionType getDefaultBlurRestriction()
Object readResolve()
|
Copyright ? 2003-2004 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |