public enum RestrictionType extends Enum<RestrictionType>
The GNU Lesser General Public License for details.
Enum Constant and Description |
---|
CHAPTER
Blurring is restricted to the chapter
|
NONE
There is no restriction on blurring.
|
Modifier and Type | Field and Description |
---|---|
private static RestrictionType |
defaultBlurRestriction
A default restriction type for blurring.
|
Modifier and Type | Method and Description |
---|---|
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.
|
public static final RestrictionType NONE
public static final RestrictionType CHAPTER
private static RestrictionType defaultBlurRestriction
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 nameNullPointerException
- if the argument is nullpublic abstract boolean isSameScope(Versification v11n, Verse start, Verse end)
v11n
- the versification to which this reference pertainsstart
- the first verseend
- the second versepublic abstract VerseRange blur(Versification v11n, VerseRange range, int blurDown, int blurUp)
v11n
- the versification to which this reference pertainsrange
- blurDown
- blurUp
- public abstract VerseRange blur(Versification v11n, Verse verse, int blurDown, int blurUp)
v11n
- the versification to which this reference pertainsverse
- blurDown
- blurUp
- public abstract VerseRange toRange(Versification v11n, Verse verse, int count)
v11n
- the versification to which this reference pertainsverse
- count
- public int toInteger()
public static RestrictionType fromString(String name)
name
- public static RestrictionType fromInteger(int i)
i
- public static void setBlurRestriction(int value)
value
- The new default blur settingpublic static int getBlurRestriction()
public static RestrictionType getDefaultBlurRestriction()