enum ConfigEntryType extends Enum<ConfigEntryType>
Originally from: http://sword.sourceforge.net/cgi-bin/twiki/view/Swordapi/ConfFileLayout Then located at: http://www.crosswire.org/ucgi-bin/twiki/view/Swordapi/ConfFileLayout Then located at: http://www.crosswire.org/wiki/index.php/DevTools:Modules Now located at: http://www.crosswire.org/wiki/DevTools:confFiles
Note: This file is organized the same as the latest wiki documentation.
Key characteristics:The GNU Lesser General Public License for details.
Enum Constant and Description |
---|
ABBREVIATION
The short name of this book.
|
ABOUT
Contains RTF that describes the book.
|
BLOCK_COUNT
single value integer, unknown use, some indications that we ought to be
using it
|
BLOCK_TYPE
The level at which compression is applied, BOOK, CHAPTER, or VERSE
|
BOOK_LIST
New.
|
CASE_SENSITIVE_KEYS
The kind of key that a Generic Book uses.
|
CATEGORY
The Category of the book.
|
CIPHER_KEY
If this exists in the conf, then the book is encrypted.
|
COMPRESS_TYPE
The type of compression in use.
|
COPYRIGHT
Informational copyright notice.
|
COPYRIGHT_CONTACT_ADDRESS
Copyright info.
|
COPYRIGHT_CONTACT_EMAIL
Copyright info.
|
COPYRIGHT_CONTACT_NAME
Copyright info.
|
COPYRIGHT_CONTACT_NOTES
Copyright info.
|
COPYRIGHT_DATE
Copyright info.
|
COPYRIGHT_HOLDER
single value string, unknown use
|
COPYRIGHT_NOTES
Copyright info.
|
DATA_PATH
Relative path to the data files, some issues with this
|
DESCRIPTION
The full name of this book
|
DIRECTION
The layout direction of the text in the book.
|
DISPLAY_LEVEL
Display level is used by GenBooks to do auto expansion in the tree.
|
DISTRIBUTION_LICENSE
Copyright info.
|
DISTRIBUTION_NOTES
Copyright info.
|
DISTRIBUTION_SOURCE
Deliberately not in wiki.
|
ENCODING
The character encoding.
|
FEATURE
A Feature describes a characteristic of the Book.
|
FONT
A recommended font to use for the book.
|
GLOBAL_OPTION_FILTER
Global Option Filters are the names of routines in SWORD that can be used
to display the data.
|
GLOSSARY_FROM
Books with a Feature of Glossary are used to map words FROM one language
TO another.
|
GLOSSARY_TO
Books with a Feature of Glossary are used to map words FROM one language
TO another.
|
HISTORY
multiple values starting with History, some sort of change-log.
|
INSTALL_SIZE
The installed size of the book in bytes.
|
KEY_TYPE
The kind of key that a Generic Book uses.
|
LANG
single value string, defaults to en, the language of the book
|
LCSH
Library of Congress Subject Heading.
|
LOCAL_STRIP_FILTER
New.
|
MINIMUM_VERSION
single value version number, lowest sword c++ version that can read this
book JSword does not use this value.
|
MOD_DRV
This indicates how the book was stored.
|
OBSOLETES
A list of prior "initials" for the current book.
|
OSIS_Q_TO_TICK
When false do not show quotation marks for OSIS text that has <q>
elements.
|
OSIS_VERSION
Single value version number, lowest sword c++ version that can read this
book JSword does not use this value.
|
PREFERRED_CSS_XHTML
Names a file in the module's DataPath that should be referenced for the renderer as CSS display controls.
|
SCOPE
New.
|
SEARCH_OPTION
New.
|
SHORT_COPYRIGHT
A one line copyright statement, required by Lockman for NASB
|
SHORT_PROMO
A one line promo statement, required by Lockman for NASB
|
SIGLUM1
SiglumN defines the n-th label for an OSISGlosses.
|
SIGLUM2 |
SIGLUM3 |
SIGLUM4 |
SIGLUM5 |
SOURCE_TYPE
This indicates the kind of markup used for the book.
|
STRONGS_PADDING
Names a file in the module's DataPath that should be referenced for the renderer as CSS display controls.
|
SWORD_VERSION_DATE
The date that this version of the book was last updated.
|
TEXT_SOURCE
Information on where the book's text was obtained.
|
UNLOCK_URL
Contains the URL (a bare URL, not an HTML <a> link) of a web page for unlocking instructions/payment.
|
VERSIFICATION
This indicates the versification of the book, with KJV being the default.
|
VERSION
An informational string indicating the current version of the book.
|
Modifier and Type | Field and Description |
---|---|
private Object |
defaultValue
The default for the ConfigEntryType
|
static String |
DIRECTION_BIDI |
static String |
DIRECTION_LTOR
Constants for direction
|
static String |
DIRECTION_RTOL |
private String |
name
The name of the ConfigEntryType
|
private String[] |
picks
The array of choices.
|
Modifier and Type | Method and Description |
---|---|
boolean |
allowsContinuation()
While most fields are single line or single value, some allow
continuation.
|
boolean |
allowsHTML()
HTML is allowed in a few config entries.
|
boolean |
allowsRTF()
RTF is allowed in a few config entries.
|
Object |
convert(String input)
Convert the string value from the conf into the representation of this
ConfigEntryType.
|
String |
filter(String value)
Modify the value if necessary.
|
static ConfigEntryType |
fromString(String name)
Lookup method to convert from a String
|
Object |
getDefault()
Some ConfigEntryTypes have defaults.
|
protected boolean |
hasChoices()
Some keys can repeat.
|
boolean |
isAllowed(String value)
Determines whether the string is allowed.
|
boolean |
isText()
Some keys can be converted to something other than a string.
|
boolean |
mayRepeat()
Some keys can repeat.
|
String |
toString() |
String |
unconvert(Object internal)
Return the original representation of the object.
|
static ConfigEntryType |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static ConfigEntryType[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final ConfigEntryType DATA_PATH
public static final ConfigEntryType DESCRIPTION
public static final ConfigEntryType MOD_DRV
public static final ConfigEntryType COMPRESS_TYPE
public static final ConfigEntryType BLOCK_TYPE
public static final ConfigEntryType BLOCK_COUNT
public static final ConfigEntryType KEY_TYPE
public static final ConfigEntryType CASE_SENSITIVE_KEYS
public static final ConfigEntryType CIPHER_KEY
public static final ConfigEntryType VERSIFICATION
public static final ConfigEntryType GLOBAL_OPTION_FILTER
public static final ConfigEntryType SIGLUM1
public static final ConfigEntryType SIGLUM2
public static final ConfigEntryType SIGLUM3
public static final ConfigEntryType SIGLUM4
public static final ConfigEntryType SIGLUM5
public static final ConfigEntryType DIRECTION
public static final ConfigEntryType SOURCE_TYPE
public static final ConfigEntryType ENCODING
public static final ConfigEntryType DISPLAY_LEVEL
public static final ConfigEntryType FONT
public static final ConfigEntryType OSIS_Q_TO_TICK
public static final ConfigEntryType FEATURE
public static final ConfigEntryType GLOSSARY_FROM
public static final ConfigEntryType GLOSSARY_TO
public static final ConfigEntryType PREFERRED_CSS_XHTML
public static final ConfigEntryType STRONGS_PADDING
public static final ConfigEntryType ABBREVIATION
public static final ConfigEntryType ABOUT
public static final ConfigEntryType VERSION
public static final ConfigEntryType HISTORY
public static final ConfigEntryType MINIMUM_VERSION
public static final ConfigEntryType CATEGORY
public static final ConfigEntryType LCSH
public static final ConfigEntryType LANG
public static final ConfigEntryType INSTALL_SIZE
public static final ConfigEntryType SWORD_VERSION_DATE
public static final ConfigEntryType OBSOLETES
public static final ConfigEntryType OSIS_VERSION
public static final ConfigEntryType COPYRIGHT
public static final ConfigEntryType COPYRIGHT_HOLDER
public static final ConfigEntryType COPYRIGHT_DATE
public static final ConfigEntryType COPYRIGHT_NOTES
public static final ConfigEntryType COPYRIGHT_CONTACT_NAME
public static final ConfigEntryType COPYRIGHT_CONTACT_NOTES
public static final ConfigEntryType COPYRIGHT_CONTACT_ADDRESS
public static final ConfigEntryType COPYRIGHT_CONTACT_EMAIL
public static final ConfigEntryType SHORT_PROMO
public static final ConfigEntryType SHORT_COPYRIGHT
public static final ConfigEntryType DISTRIBUTION_LICENSE
public static final ConfigEntryType DISTRIBUTION_NOTES
public static final ConfigEntryType TEXT_SOURCE
public static final ConfigEntryType UNLOCK_URL
public static final ConfigEntryType DISTRIBUTION_SOURCE
public static final ConfigEntryType LOCAL_STRIP_FILTER
public static final ConfigEntryType SEARCH_OPTION
public static final ConfigEntryType SCOPE
public static final ConfigEntryType BOOK_LIST
private final String name
private final Object defaultValue
private final String[] picks
public static final String DIRECTION_LTOR
public static final String DIRECTION_RTOL
public static final String DIRECTION_BIDI
public static ConfigEntryType[] values()
for (ConfigEntryType c : ConfigEntryType.values()) System.out.println(c);
public static ConfigEntryType 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 boolean isText()
public boolean isAllowed(String value)
value
- the string to be checkedpublic String filter(String value)
value
- the inputpublic boolean allowsRTF()
public boolean allowsHTML()
public boolean allowsContinuation()
public boolean mayRepeat()
protected boolean hasChoices()
public Object getDefault()
public Object convert(String input)
input
- the text to convertpublic String unconvert(Object internal)
internal
- the object to convertpublic static ConfigEntryType fromString(String name)
name
- the key for the entrypublic String toString()
toString
in class Enum<ConfigEntryType>