|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<RestrictionType>
org.crosswire.jsword.passage.RestrictionType
public enum RestrictionType
Types of Passage Blurring Restrictions.
for license details.
The copyright to this program is held by it's authors.
Enum Constant Summary | |
---|---|
CHAPTER
Blurring is restricted to the chapter |
|
NONE
There is no restriction on blurring. |
Field Summary | |
---|---|
private static RestrictionType |
defaultBlurRestriction
A default restriction type for blurring. |
Method Summary | |
---|---|
abstract VerseRange |
blur(Versification v11n,
Verse verse,
int blurDown,
int blurUp)
Blur a verse the specified amount. |
abstract VerseRange |
blur(Versification v11n,
VerseRange range,
int blurDown,
int blurUp)
Blur a verse range the specified amount. |
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. |
abstract boolean |
isSameScope(Versification v11n,
Verse start,
Verse end)
Are the two verses in the same scope. |
static void |
setBlurRestriction(int value)
The default Blur settings. |
int |
toInteger()
Get an integer representation for this RestrictionType |
abstract VerseRange |
toRange(Versification v11n,
Verse verse,
int count)
Create a range from the verse having the specified number of verses. |
static RestrictionType |
valueOf(String name)
Returns the enum constant of this type with the specified name. |
static RestrictionType[] |
values()
Returns an array containing the constants of this enum type, in the order they are declared. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final RestrictionType NONE
public static final RestrictionType CHAPTER
Field Detail |
---|
private static RestrictionType defaultBlurRestriction
Method Detail |
---|
public static RestrictionType[] values()
for (RestrictionType c : RestrictionType.values()) System.out.println(c);
public static RestrictionType valueOf(String name)
name
- the name of the enum constant to be returned.
IllegalArgumentException
- if this enum type has no constant
with the specified name
NullPointerException
- if the argument is nullpublic abstract boolean isSameScope(Versification v11n, Verse start, Verse end)
start
- the first verseend
- the second verse
public abstract VerseRange blur(Versification v11n, VerseRange range, int blurDown, int blurUp)
range
- blurDown
- blurUp
-
public abstract VerseRange blur(Versification v11n, Verse verse, int blurDown, int blurUp)
verse
- blurDown
- blurUp
-
public abstract VerseRange toRange(Versification v11n, Verse verse, int count)
verse
- count
-
public int toInteger()
public static RestrictionType fromString(String name)
public static RestrictionType fromInteger(int i)
public static void setBlurRestriction(int value)
value
- The new default blur settingpublic static int getBlurRestriction()
public static RestrictionType getDefaultBlurRestriction()
|
Copyright ? 2003-2011 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |