CodeletBaseConfig (Codelet)

java.lang.Object
- java.lang.Enum<CodeletBaseConfig>
- - com.github.aliteralmind.codelet.CodeletBaseConfig

All Implemented Interfaces:: Serializable, Comparable<CodeletBaseConfig>

public enum CodeletBaseConfig
extends Enum<CodeletBaseConfig>

Immutable, static, and non-template related configuration, used throughout Codelet, as held in a file named codelet.properties. Loading is executed by CodeletBootstrap.

View {@docRoot}/../codelet_config/codelet.properties.)

Codelet: Configuration

See getting started in the Codelet installation instructions.

There are four categories of Codelet global configuration:

Base directories and other
Default templates
Template gaps
Debugging and diagnostics

Codelet: Configuration: Base directories and urls, and other

	Name	Description
	`base_dir_base_dir`	For use in all other "base_dir" config vars, with "${BASE}"
func	`example_class_src_base_dir`	Directory containing the top-most package for the source code of all example classes.
func	`enclosing_class_src_base_dirs`	Comma-separated list of all directories containing the top-most package-directories of all codelet-containing source files.
func	`default_alterers_class_name`	Fully-qualified name of the class that defines alterers used by all pre-built customizers, and are accessible in custom customizers.

Codelet: Configuration: JavaDoc related

Func	Name	Description
`func`	`unique_jd_class_target_init_capacity`	Initial capacity of the map holding the JavaDoc target-class shortcut translators.
`func`	`pkglist_online_attempts_per_url`	How many attempts should be made to retrieve each online package-list? If zero, offline only.
`func`	`pkglist_online_attempt_sleep_mills`	How many milliseconds between each failed attempt?
`func`	`pkglist_if_online_retrieval_fails__warn_crash`	If all online-retrieval attempts fail, should only a warning be logged, or should Codelet stop execution? (Offline package-lists are always retrieved.)
`func`	`pkglist_auto_refresh_offline__yes_no`	When online package-lists are retrieved, should offline package lists be refreshed (or created)?
`func`	`pkglist_offline_name_postfix`	Filename postfix, plus optional dot-extension that follows each offline name.

Codelet: Configuration: Default template files

Func	Name	Description
	`default_template_directory_prefix`	Prepended to all `"default_*_template_path"` values.
func	`default_source_codelet_template_path`	Path to the (source-code) `{@.codelet}` taglet's default template.
func	`default_dot_out_template_path`	Path to the `{@.codelet.out}` taglet's default template.
func	`default_file_textlet_template_path`	Path to the default template used for the `{@.file.textlet}` taglet's default template.
func	`default_and_out_template_path`	Path to the `{@.codelet.and.out}` taglet's default template.
func	`user_template_base_dir`	Directory in which any custom (user-created) templates are stored.

Codelet: Configuration: Template gaps

Func	Name	Description
func	`gap_name_prefix_char`	Character placed immediately before all template gap names.
	`gap_name_postfix_char`	Character placed immediately after gap names.
	`gap_literal_prefix_char`	Literal representation of the prefix char, for use in between texts.
	`gap_literal_name_postfix_char`	Literal representation of the postfix char, for use in between texts.
func	`user_extra_gaps_class`	Fully-qualified name of the class that defines extra gaps that can be placed in Codelet templates.

Codelet: Configuration: Debugging and diagnostics

Func	Name	Description
func	`global_debugging__off_12345`	Amount that information that should be logged in every taglet-call
func	`debug_to__console_path`	If debugging is on, where should it be written to?
func	`list_type__black_white_off`	For ignoring all codelets in a single file, or in an entire package.
	`list_case__ignore_require_system`	When comparing class names against the black/white list, how should case be considered?.
	`comma_delimited_proper_list`	List of wildcard matches that determine which files or packages should be recognized.
	`comma_delimited_override_list`	List of wildcard matches that trump those in the "proper"-list.
`func`	`if_alteration_not_made_crash__yes_no`	If a customizer attempts to make an alteration, but cannot (such as when the find-what text is not found in the example code), should a crash occur, in addition to the warning?

Since:: 0.1.0
Author:: Copyright (C) 2014, Jeff Epstein (aliteralmind __DASH__ github __AT__ yahoo __DOT__ com), dual-licensed under the LGPL (version 3.0 or later) or the ASL (version 2.0). See source code for details. http://codelet.aliteralmind.com, https://github.com/aliteralmind/codelet

Enum Constant Summary

Enum Constants
Enum Constant and Description

INSTANCE

Enum Constants
Enum Constant and Description
`INSTANCE`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALTERATION_NOT_MADE_CRASH` If a customizer attempts to make an alteration, but cannot (such as when the find-what text is not found in the example code), should a crash occur, in addition to the warning?--Name is `"if_alteration_not_made_crash__yes_no"`.
`static String`	`AUTO_UPDATE_OFFLINE_PACKAGE_LISTS` When online package-lists are retrieved, should offline package lists be refreshed (or created)?--Name is `"pkglist_auto_refresh_offline__yes_no"`.
`static String`	`BASE_DIR_BASE_DIR` For use in all other "base_dir" config vars, with "${BASE}"--Name is `"base_dir_base_dir"`.
`static String`	`BLACK_WHITE_LIST_CASE` When comparing class names against the black/white list, how should case be considered?--Name is `"list_case__ignore_require_system"`.
`static String`	`BLACK_WHITE_LIST_TYPE` For ignoring all codelets in a single file, or in an entire package--Name is `"list_type__black_white_off"`.
`static String`	`BLACK_WHITE_OVERRIDE_LIST` List of wildcard matches that trump those in the "proper"-list--Name is `"comma_delimited_proper_list"`.
`static String`	`BLACK_WHITE_PROPER_LIST` List of wildcard matches that determine which files or packages should be recognized--Name is `"comma_delimited_proper_list"`.
`static String`	`DEBUG_DESTINATION` When debugging is on, where should output be written to?--Name is `"debug_to__console_path"`.
`static String`	`DEFAULT_ALTERERS_CLASS_NAME` Fully-qualified name of the class that defines alterers used by all pre-built customizers, and are accessible in custom customizers--Name is `"default_alterers_class_name"`.
`static String`	`DEFAULT_AND_OUT_TMPL_PATH` Path to the default template used for `{@.codelet.and.out}` taglets--Name is `"default_and_out_template_path"`.
`static String`	`DEFAULT_DOT_OUT_TMPL_PATH` Path to the default template used for `{@.codelet.out}` taglets--Name is `"default_dot_out_template_path"`.
`static String`	`DEFAULT_FILE_TEXT_TMPL_PATH` Path to the default template used for `{@.file.textlet}` taglets--Name is `"default_file_textlet_template_path"`.
`static int`	`DEFAULT_JD_TARGET_CLASS_MAP_INIT_CAPACITY` Default value for `unique_jd_class_target_init_capacity` when not provided--Equal to `100`.
`static int`	`DEFAULT_ONLINE_PKGLST_ATTEMPTS` Default value for `pkglist_online_attempts_per_url` when not provided--Equal to `5`.
`static int`	`DEFAULT_ONLINE_PKGLST_SLEEP_MILLS` Default value for `pkglist_online_attempts_per_url` when not provided--Equal to `500`.
`static String`	`DEFAULT_SRC_CODE_TMPL_PATH` Path to the default template used for (source-code) `{@.codelet}` taglets--Name is `"default_source_codelet_template_path"`.
`static String`	`DEFAULT_TPML_DIR_PREFIX` Prepended to all `"default_*_template_path"` values--Name is `"default_template_directory_prefix"`.
`static String`	`ENCLOSING_CLASS_SRC_BASE_DIRS` Comma-separated list of all directories containing the top-most package-directory of all codelet-containing source files--Name is `"enclosing_class_src_base_dirs"`.
`static String`	`EXAMPLE_CLASS_SRC_BASE_DIR` Directory containing the top-most package for the source code of all example classes--Name is `"example_class_src_base_dir"`.
`static String`	`GAP_NAME_LITERAL_POSTFIX` Literal representation of the postfix char, for use in between texts--Name is `"gap_literal_name_postfix_char"`.
`static String`	`GAP_NAME_LITERAL_PREFIX` Literal representation of the prefix char, for use in between texts--Name is `"gap_literal_prefix_char"`.
`static String`	`GAP_NAME_POSTFIX_CHAR` Character placed immediately after gap names--Name is `"gap_name_postfix_char"`.
`static String`	`GAP_NAME_PREFIX_CHAR` Character placed immediately before gap names--Name is `"gap_name_prefix_char"`.
`static String`	`GLOBAL_DEBUG_LEVEL` Amount that information that should be logged in every taglet-call--Name is `"global_debugging__off_12345"`.
`static String`	`OFFLINE_PACKAGE_LIST_DIR_NAME` Name of the sub-directory in which the offline versions of external library `"package-list"` files are stored--Equal to `"offline_package_lists"`.
`static String`	`PKGLIST_OFFLINE_NAME_POSTFIX` Filename postfix, plus optional dot-extension that follows each offline name.--Name is `"pkglist_offline_name_postfix"`.
`static String`	`PKGLIST_ONLINE_ATTEMPT_COUNT` How many attempts should be made to retrieve each online package-list? If zero, offline only--Name is `"pkglist_online_attempts_per_url"`.
`static String`	`PKGLIST_ONLINE_ATTEMPT_SLEEP_MILLS` How many milliseconds between each failed attempt?--Name is `"pkglist_online_attempt_sleep_mills"`.
`static String`	`PKGLIST_ONLINE_FAILS_BEHAVIOR` If all online-retrieval attempts fail, should only a warning be logged, or should Codelet stop execution? (Offline package-lists are always retrieved)--Name is `"pkglist_if_online_retrieval_fails__warn_crash"`.
`static String`	`UNIQUE_JD_CLASS_TARGET_INIT_CAPACITY` Initial capacity of the map holding the JavaDoc target-class shortcut translators--Name is `"unique_jd_class_target_init_capacity"`.
`static String`	`USER_EXTRA_GAPS_CLASS_NAME` Fully-qualified name of the class that defines extra gaps that can be placed in Codelet templates--Name is `"user_extra_gaps_class"`.
`static String`	`USER_TEMPLATE_BASE_DIR` Directory in which any custom (user-created) templates are stored--Name is `"user_template_base_dir"`.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`debug(Object message)` Write a message to the debugging output.
`static void`	`debugAndToConsole(CodeletInstance instance, Object message)` Write a message to the console and, if debugging is both on and not to the console, writes it via the debug outputter as well.
`static void`	`debugln(Object message)` Write a message to the debugging output.
`static void`	`debuglnAndToConsole(CodeletInstance instance, Object message)` Write a message to the console and, if debugging is both on and not to the console, writes it via the debug outputter as well.
`static boolean`	`doAutoUpdateOfflinePackageLists()` When online `package-list`s are retrieved, should offline package lists be refreshed (or created)?
`static boolean`	`doCrashIfAlterationNotMade()` If a customizer attempts to make an alteration, but cannot (such as when the find-what text is not found in the example code), what should happen?.
`static boolean`	`doCrashIfOnlinePackageListFailure()` If all online-retrieval attempts fail, should only a warning be logged, or should Codelet stop execution? (Offline package-lists are always retrieved.)
`static boolean`	`doDebugToConsole()` Is debugging output being written to the console?.
`static AllOnlineOfflineDocRoots`	`getAllJavaDocRoots()` All external JavaDoc doc roots, for creating links.
`static FilenameBlackWhiteList`	`getBlackWhiteList()` For determining which codelets should be processed or ignored.
`static String`	`getCustomTemplateDir()` The directory in which any custom (user-created) templates are stored.
`static Appendable`	`getDebugApblIfOn(CodeletInstance instance)` If debugging is on, get an appendable.
`static Appendable`	`getDebugApblIfOn(CodeletInstance instance, String name)` If a named debuggers active, get an appendable.
`static Appendable`	`getDebugApblIfOn(int min_level, CodeletInstance instance)` If debugging is on and at least a certain level, get an appendable.
`static TextAppenter`	`getDebugAptr()` The debugging outputter.
`static TextAppenter`	`getDebugAptrIfOn(CodeletInstance instance)` If debugging is on, get an appenter.
`static TextAppenter`	`getDebugAptrIfOn(CodeletInstance instance, String name)` If a named debuggers active, get an appenter.
`static TextAppenter`	`getDebugAptrIfOn(int min_level, CodeletInstance instance)` If debugging is on and at least a certain level, get an appenter.
`static DefaultAlterGetter`	`getDefaultAlterGetter()` When not using a custom customizer (when using none, or a pre-made processor) how many spaces should all tabs be replaced with?.
`static String`	`getDefaultConsoleOutTemplatePath()` Path to the default template used for `{@.codelet.out}` taglets.
`static String`	`getDefaultFileTextTemplatePath()` Path to the default template used for `{@.file.textlet}` taglets.
`static String`	`getDefaultSourceAndOutTemplatePath()` Path to the default template used for `{@.codelet.and.out}` taglets.
`static String`	`getDefaultSourceCodeTemplatePath()` Path to the default template used for (source-code) `{@.codelet}` taglets.
`static List<String>`	`getEnclosingBaseDirList()` An immutable list of all directories containing the top-most package of codelet-containing source-code.
`static String`	`getExampleSourceBaseDir()` Directory containing the top-most package for the source code of all example classes.
`static GapCharConfig`	`getGapCharConfig()` The character placed immediately before gap names.
`static DebugLevel`	`getGlobalDebugLevel()` The amount of debugging, beyond ......logging......, that is written in every taglet call.
`static NamedDebuggers`	`getNamedDebuggers()` Immutable map containing all named debug levels (both required and user-created).
`static String`	`getOfflinePackageListPostfix()` The filename postfix, plus optional dot-extension that follows each offline name.
`static int`	`getOnlinePackageListAttemptCount()` How many attempts should be made to retrieve each online package-list? If zero, offline only.
`static long`	`getOnlinePackageListAttemptSleepMills()` How many milliseconds between each failed attempt?.
`static int`	`getTargetClassMapInitCapacity()`
`static String`	`getUserExtraGapsClassName()` The class that defines extra gaps that can be placed in Codelet templates.
`static boolean`	`isDebugLevelAtMost(int max_level, CodeletInstance instance)` Is debugging on and at most a certain level?.
`static boolean`	`isDebugOn(CodeletInstance instance)` Is debugging on, either globally or for a single taglet?.
`static boolean`	`isDebugOn(CodeletInstance instance, String name)` Is a named debuggers active?.
`static boolean`	`isDebugOn(int min_level, CodeletInstance instance)` Is debugging on and at least a certain level?.
`static CodeletBaseConfig`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CodeletBaseConfig[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.
`static boolean`	`wasLoaded()` Was configuration loaded?.

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
  - INSTANCE
```
public static final CodeletBaseConfig INSTANCE
```
- Field Detail
  - DEFAULT_ONLINE_PKGLST_ATTEMPTS
```
public static final int DEFAULT_ONLINE_PKGLST_ATTEMPTS
```
    Default value for pkglist_online_attempts_per_url when not provided--Equal to 5.
    
    See Also:
    PKGLIST_ONLINE_ATTEMPT_COUNT, Constant Field Values
  - DEFAULT_ONLINE_PKGLST_SLEEP_MILLS
```
public static final int DEFAULT_ONLINE_PKGLST_SLEEP_MILLS
```
    Default value for pkglist_online_attempts_per_url when not provided--Equal to 500.
    
    See Also:
    PKGLIST_ONLINE_ATTEMPT_SLEEP_MILLS, Constant Field Values
  - DEFAULT_JD_TARGET_CLASS_MAP_INIT_CAPACITY
```
public static final int DEFAULT_JD_TARGET_CLASS_MAP_INIT_CAPACITY
```
    Default value for unique_jd_class_target_init_capacity when not provided--Equal to 100.
    
    See Also:
    UNIQUE_JD_CLASS_TARGET_INIT_CAPACITY, Constant Field Values
  - EXAMPLE_CLASS_SRC_BASE_DIR
```
public static final String EXAMPLE_CLASS_SRC_BASE_DIR
```
    Directory containing the top-most package for the source code of all example classes--Name is "example_class_src_base_dir".
    
    If this is an example code
    
    com.github.smith.examples.AGoodExample
    
    and the path to its source code is
    
    C:\java_code\com\github\smith\examples\AGoodExample.java
    
    set this to
    
    "C:\java_code\"
    
    The ending file-separator is requried. This may or may not be equal to ENCLOSING_CLASS_SRC_BASE_DIRS. And its value may include the "base_dir_base_dir".
    
    See Also:
    , getExampleSourceBaseDir(), Constant Field Values
  - BLACK_WHITE_LIST_TYPE
```
public static final String BLACK_WHITE_LIST_TYPE
```
    For ignoring all codelets in a single file, or in an entire package--Name is "list_type__black_white_off".
    
    (Debugging Codelet in general)
    - list_type__black_white_off: Must be one of the following:
      
      "black": The codelets in any files or packages that match an item in the proper-list, are ignored. Those not matched are processed.
      
      "white": The codelets in any files or packages that match an item in the proper-list, are processed.
      
      "off": All codelets are processed.
    - list_case__ignore_require_system: When comparing the fully-qualified name of the enclosing file (or package), should letter case be considered?
      
      "ignore": Case insensitive
      
      "require": Case (sensitive)
      
      "system": Case sensitivity is determined by the (operating system)
    - comma_delimited_proper_list: The list of wildcard matches that, when the fully-qualified file or package is matched, are ignored or processed (as determined by the black/white setting). Whitelist examples:
      
      To process all codelets in all packages: "*"
      
      To process codelets only in a single package: "github.com.myname.text.*"
      
      To process codelets in one package, plus a subset of files in another: "github.com.myname.text.*,github.com.myname.io.Get*ForPath"
      
      Do not put any dot-postfix after the file names (such as ".java" or ".html"). For the overview summary ("overview-summary.html"), use "OVERVIEW_SUMMARY". For package summary's ("package-info.java" or "package-summary.html"), use "PACKAGE_SUMMARY".
    - comma_delimited_override_list: The list of wildcard matches that trump those in the proper-list. This list is only applicable when a file or package is matched by a proper-item. Examples:
      
      To process all codelets except those in a single file, using a whitelist (the value of list_case__ignore_require_system is required, but left out of these examples):
      list_type__black_white_off=white comma_delimited_proper_list=fully.qualified.class.name.of.FileToProcess comma_delimited_override_list=
      
      Using a blacklist:
      list_type__black_white_off=black comma_delimited_proper_list=* comma_delimited_override_list=*.FileToProcess
      
      To process codelets only in a single package: "github.com.myname.text.*"
      
      To process codelets in one package, plus a subset of files in another: "github.com.myname.text.*,github.com.myname.io.Get*ForPath"
      
      Asterisks ('*') indicate one-or-more of any character, and question marks ('?') mean exactly one of any character. So, if FileToProcess is a unique filename across all project directories comma_delimited_proper_list could alternatively be
      *.FileToProcess
      If it is not unique:
      *.name.of.FileToProcess
    These values are processed by FilenameBlackWhiteList.newFromConfigStringVars
    See Also:
    , FilenameBlackWhiteList, getBlackWhiteList(), BLACK_WHITE_LIST_CASE, BLACK_WHITE_PROPER_LIST, BLACK_WHITE_OVERRIDE_LIST, Constant Field Values
  - ALTERATION_NOT_MADE_CRASH
```
public static final String ALTERATION_NOT_MADE_CRASH
```
    If a customizer attempts to make an alteration, but cannot (such as when the find-what text is not found in the example code), should a crash occur, in addition to the warning?--Name is "if_alteration_not_made_crash__yes_no".
    
    Must be one of two values:
    - "no": Only warnings will be logged.
    - "yes": In addition to the warning, and exception is thrown.
    See Also:
    doCrashIfAlterationNotMade(), NewJDLinkForWordOccuranceNum, CustomizationInstructions#getCustomizedBody, Constant Field Values
  - UNIQUE_JD_CLASS_TARGET_INIT_CAPACITY
```
public static final String UNIQUE_JD_CLASS_TARGET_INIT_CAPACITY
```
    Initial capacity of the map holding the JavaDoc target-class shortcut translators--Name is "unique_jd_class_target_init_capacity". When not provided (set to the empty-string: ""), this defaults to DEFAULT_JD_TARGET_CLASS_MAP_INIT_CAPACITY.
    
    See Also:
    , NewJDLinkForWordOccuranceNum.getAllParamSigsForLinkTarget(Class), getTargetClassMapInitCapacity(), Constant Field Values
  - BLACK_WHITE_LIST_CASE
```
public static final String BLACK_WHITE_LIST_CASE
```
    When comparing class names against the black/white list, how should case be considered?--Name is "list_case__ignore_require_system".
    
    See Also:
    , BLACK_WHITE_LIST_TYPE, Constant Field Values
  - BLACK_WHITE_PROPER_LIST
```
public static final String BLACK_WHITE_PROPER_LIST
```
    List of wildcard matches that determine which files or packages should be recognized--Name is "comma_delimited_proper_list".
    
    See Also:
    , BLACK_WHITE_LIST_TYPE, Constant Field Values
  - BLACK_WHITE_OVERRIDE_LIST
```
public static final String BLACK_WHITE_OVERRIDE_LIST
```
    List of wildcard matches that trump those in the "proper"-list--Name is "comma_delimited_proper_list".
    
    See Also:
    , BLACK_WHITE_LIST_TYPE, Constant Field Values
  - ENCLOSING_CLASS_SRC_BASE_DIRS
```
public static final String ENCLOSING_CLASS_SRC_BASE_DIRS
```
    Comma-separated list of all directories containing the top-most package-directory of all codelet-containing source files--Name is "enclosing_class_src_base_dirs".
    
    If all codelet-containing source code exists in a single directory:
    C:\java_code\src\project_overview.html C:\java_code\src\com\github\xbn\lang\AClass.java C:\java_code\src\com\github\xbn\examples\lang\Demo_AClass.java C:\java_code\src\com\github\xbn\examples\test\UnitTest_AClass.java
    Then set this to "C:\java_code\src\"
    
    If there are multiple directories:
    C:\java_code\supplemental_files\project_overview.html C:\java_code\src\com\github\xbn\lang\AClass.java C:\java_code\src\com\github\xbn\examples\lang\Demo_AClass.java C:\java_code\src\com\github\xbn\examples\test\UnitTest_AClass.java
    Then use
    C:\java_code\src\,C:\java_code\supplemental_files\
    or set "base_dir_base_dir" to "C:\java_code\", and use
    ${BASE}src\,${BASE}supplemental_files\
    
    At least one directory-value is required.
    
    The project-overview file, as configured into JavaDoc, must exist in one of these directories. If its path is
    C:\java_code\src\project_overview.html
    and C:\java_code\src\ is its enclosing class base-directory, then its fully-qualified name as required by the blacklist is "project_overview". And in the hand template-overrides configuration file, it is "project_overview.html".
    
    This value may be equal to (or contain) EXAMPLE_CLASS_SRC_BASE_DIR.
    See Also:
    , BASE_DIR_BASE_DIR, getEnclosingBaseDirList(), Constant Field Values
  - BASE_DIR_BASE_DIR
```
public static final String BASE_DIR_BASE_DIR
```
    For use in all other "base_dir" config vars, with "${BASE}"--Name is "base_dir_base_dir".
    
    Only the first use is recognized. If this variable equals
    C:\java_code\
    then
    ${BASE}hello${BASE}
    is translated to
    C:\java_code\hello${BASE}
    
    See Also:
    , ENCLOSING_CLASS_SRC_BASE_DIRS, Constant Field Values
  - OFFLINE_PACKAGE_LIST_DIR_NAME
```
public static final String OFFLINE_PACKAGE_LIST_DIR_NAME
```
    Name of the sub-directory in which the offline versions of external library "package-list" files are stored--Equal to "offline_package_lists".
    
    This is located in the Codelet configuration directory.
    
    See Also:
    , CodeletBootstrap.EXTERNAL_DOC_ROOT_URL_FILE, PKGLIST_ONLINE_ATTEMPT_COUNT, Constant Field Values
  - PKGLIST_ONLINE_ATTEMPT_COUNT
```
public static final String PKGLIST_ONLINE_ATTEMPT_COUNT
```
    How many attempts should be made to retrieve each online package-list? If zero, offline only--Name is "pkglist_online_attempts_per_url".
    
    Must be an integer zero or greater. If not provided (equal to the empty-string: ""), this defaults to DEFAULT_ONLINE_PKGLST_ATTEMPTS.
    
    See Also:
    , getAllJavaDocRoots(), getOnlinePackageListAttemptCount(), Constant Field Values
  - PKGLIST_ONLINE_ATTEMPT_SLEEP_MILLS
```
public static final String PKGLIST_ONLINE_ATTEMPT_SLEEP_MILLS
```
    How many milliseconds between each failed attempt?--Name is "pkglist_online_attempt_sleep_mills".
    
    Must be an integer zero or greater. If not provided (equal to the empty-string: ""), thi defaults to DEFAULT_ONLINE_PKGLST_SLEEP_MILLS.
    
    See Also:
    , getOnlinePackageListAttemptSleepMills(), PKGLIST_ONLINE_ATTEMPT_COUNT, Constant Field Values
  - PKGLIST_ONLINE_FAILS_BEHAVIOR
```
public static final String PKGLIST_ONLINE_FAILS_BEHAVIOR
```
    If all online-retrieval attempts fail, should only a warning be logged, or should Codelet stop execution? (Offline package-lists are always retrieved)--Name is "pkglist_if_online_retrieval_fails__warn_crash".
    
    See Also:
    , doCrashIfOnlinePackageListFailure(), PKGLIST_ONLINE_ATTEMPT_COUNT, Constant Field Values
  - AUTO_UPDATE_OFFLINE_PACKAGE_LISTS
```
public static final String AUTO_UPDATE_OFFLINE_PACKAGE_LISTS
```
    When online package-lists are retrieved, should offline package lists be refreshed (or created)?--Name is "pkglist_auto_refresh_offline__yes_no".
    
    See Also:
    , doAutoUpdateOfflinePackageLists(), PKGLIST_ONLINE_ATTEMPT_COUNT, Constant Field Values
  - PKGLIST_OFFLINE_NAME_POSTFIX
```
public static final String PKGLIST_OFFLINE_NAME_POSTFIX
```
    Filename postfix, plus optional dot-extension that follows each offline name.--Name is "pkglist_offline_name_postfix".
    
    See Also:
    , getOfflinePackageListPostfix(), PKGLIST_ONLINE_ATTEMPT_COUNT, Constant Field Values
  - GLOBAL_DEBUG_LEVEL
```
public static final String GLOBAL_DEBUG_LEVEL
```
    Amount that information that should be logged in every taglet-call--Name is "global_debugging__off_12345".
    
    This must be equal to
    - "off": No automated debugging.
    - A digit between one and five: An arbitrary number representing the amount of debugging information that will be output.
    This is the global debugging level used by all taglets. An individual taglet may override this by prepending "[DEBUG_LEVEL_#]" to its text. If the taglet's level is lower than or equal to the global level, it is ignored.
    
    For very specific control over what is output without having to recompile code, create a "named debugger", each of which has a level-number associated to it. If the actual (global or taglet) debugging level is equal-to-or-higher, it's information is output.
    
    What is logged
    
    The examples in this section assumes that CodeletBaseConfig is statically imported "en masse":
    import static com.github.aliteralmind.codelet.CodeletBaseConfig.*;
    
    To output something even if the debugging level is "off":
    
    debugln("Important information");
    
    To output only when global debugging is on (level one or greater):
    
    if(isDebugOn(null)) { debugln("Important information") }
    
    To output when global debugging is at least level three:
    
    if(isDebugOn(3, null)) { debugln("Important information") }
    
    To output when global or taglet debugging is at least three:
    
    if(isDebugOn(3, [the-taglet-instance])) { debugln("Important information") }
    See Also:
    , DEBUG_DESTINATION, getGlobalDebugLevel(), Overview JavaDoc link example, Constant Field Values
  - DEBUG_DESTINATION
```
public static final String DEBUG_DESTINATION
```
    When debugging is on, where should output be written to?--Name is "debug_to__console_path".
    
    This must be one of two values:
    - "console": Sets getDebugAptr() to TextAppenter.CONSOLE
    - The path to a writable file: Sets getDebugAptr() to
      NewTextAppenterFor.file(dbgAptrStr, AppendOrOverwrite.APPEND)
    In order to allow debugging at any time, even when the debugging level is set to off, this value is required.
    See Also:
    , getDebugAptr(), Constant Field Values
  - DEFAULT_TPML_DIR_PREFIX
```
public static final String DEFAULT_TPML_DIR_PREFIX
```
    Prepended to all "default_*_template_path" values--Name is "default_template_directory_prefix".
    
    This value may be the empty string (""), and may include the "base_dir_base_dir"
    
    All default template paths are required, must exist and be readable, and must refer to a valid Codelet template of its type. They may be in any of the following locations, which are searched for in order:
    1. A file name, which exists in the same directory as this configuration file.
    2. A relative path, which exists off of the directory from which the Java Virtual Machine was invoked.
    3. An absolute path.
    View the locally installed templates:
    These links assume the default template directory is "{@docRoot}/../codelet_config/default_templates/"
    See Also:
    , DEFAULT_SRC_CODE_TMPL_PATH, DEFAULT_DOT_OUT_TMPL_PATH, DEFAULT_FILE_TEXT_TMPL_PATH, DEFAULT_AND_OUT_TMPL_PATH, USER_EXTRA_GAPS_CLASS_NAME, USER_TEMPLATE_BASE_DIR, Constant Field Values
  - DEFAULT_SRC_CODE_TMPL_PATH
```
public static final String DEFAULT_SRC_CODE_TMPL_PATH
```
    Path to the default template used for (source-code) {@.codelet} taglets--Name is "default_source_codelet_template_path".
    
    See Also:
    , DEFAULT_TPML_DIR_PREFIX, getDefaultSourceCodeTemplatePath(), Constant Field Values
  - DEFAULT_DOT_OUT_TMPL_PATH
```
public static final String DEFAULT_DOT_OUT_TMPL_PATH
```
    Path to the default template used for {@.codelet.out} taglets--Name is "default_dot_out_template_path".
    
    See Also:
    , DEFAULT_TPML_DIR_PREFIX, getDefaultConsoleOutTemplatePath(), Constant Field Values
  - DEFAULT_AND_OUT_TMPL_PATH
```
public static final String DEFAULT_AND_OUT_TMPL_PATH
```
    Path to the default template used for {@.codelet.and.out} taglets--Name is "default_and_out_template_path".
    
    See Also:
    , DEFAULT_TPML_DIR_PREFIX, getDefaultSourceAndOutTemplatePath(), Constant Field Values
  - DEFAULT_FILE_TEXT_TMPL_PATH
```
public static final String DEFAULT_FILE_TEXT_TMPL_PATH
```
    Path to the default template used for {@.file.textlet} taglets--Name is "default_file_textlet_template_path".
    
    See Also:
    , DEFAULT_TPML_DIR_PREFIX, getDefaultFileTextTemplatePath(), Constant Field Values
  - DEFAULT_ALTERERS_CLASS_NAME
```
public static final String DEFAULT_ALTERERS_CLASS_NAME
```
    Fully-qualified name of the class that defines alterers used by all pre-built customizers, and are accessible in custom customizers--Name is "default_alterers_class_name".
    
    When provided, the class it represents must exist, implement DefaultAlterGetter, and have a no-parameter constructor. When not provided (equal to the empty-string ""), DefaultDefaultAlterGetter is used.
    
    See Also:
    , getDefaultAlterGetter(), Constant Field Values
  - GAP_NAME_PREFIX_CHAR
```
public static final String GAP_NAME_PREFIX_CHAR
```
    Character placed immediately before gap names--Name is "gap_name_prefix_char".
    
    If not provided, defaults to GapCharConfig.DEFAULT_PREFIX_CHAR
    
    See Also:
    , GAP_NAME_POSTFIX_CHAR, GAP_NAME_LITERAL_PREFIX, getGapCharConfig(), Constant Field Values
  - GAP_NAME_POSTFIX_CHAR
```
public static final String GAP_NAME_POSTFIX_CHAR
```
    Character placed immediately after gap names--Name is "gap_name_postfix_char".
    
    If not provided, defaults to GapCharConfig.DEFAULT_PREFIX_CHAR
    
    See Also:
    , GAP_NAME_PREFIX_CHAR, GAP_NAME_LITERAL_POSTFIX, getGapCharConfig(), Constant Field Values
  - GAP_NAME_LITERAL_PREFIX
```
public static final String GAP_NAME_LITERAL_PREFIX
```
    Literal representation of the prefix char, for use in between texts--Name is "gap_literal_prefix_char".
    
    If not provided, defaults to GapCharConfig.DEFAULT_LITERAL_PREFIX
    
    See Also:
    , GAP_NAME_PREFIX_CHAR, GAP_NAME_LITERAL_POSTFIX, getGapCharConfig(), Constant Field Values
  - GAP_NAME_LITERAL_POSTFIX
```
public static final String GAP_NAME_LITERAL_POSTFIX
```
    Literal representation of the postfix char, for use in between texts--Name is "gap_literal_name_postfix_char".
    
    If not provided, defaults to GapCharConfig.DEFAULT_LITERAL_PREFIX
    
    See Also:
    , GAP_NAME_POSTFIX_CHAR, GAP_NAME_LITERAL_PREFIX, getGapCharConfig(), Constant Field Values
  - USER_EXTRA_GAPS_CLASS_NAME
```
public static final String USER_EXTRA_GAPS_CLASS_NAME
```
    Fully-qualified name of the class that defines extra gaps that can be placed in Codelet templates--Name is "user_extra_gaps_class".
    
    If there are no extra gaps, set this to the empty-string. Otherwise, the class it represents must exist, implement UserExtraGapGetter, and have a no-parameter constructor.
    
    See Also:
    , DEFAULT_TPML_DIR_PREFIX, getUserExtraGapsClassName(), Constant Field Values
  - USER_TEMPLATE_BASE_DIR
```
public static final String USER_TEMPLATE_BASE_DIR
```
    Directory in which any custom (user-created) templates are stored--Name is "user_template_base_dir".
    
    This is optional and not validated in any way. Its value may include the "base_dir_base_dir".
    
    See Also:
    , getCustomTemplateDir(), Constant Field Values
- Method Detail
  - values
```
public static CodeletBaseConfig[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (CodeletBaseConfig c : CodeletBaseConfig.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CodeletBaseConfig valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - wasLoaded
```
public static final boolean wasLoaded()
```
    Was configuration loaded?.
    
    Returns:
    true If all values loaded successfully.
  - getDefaultSourceCodeTemplatePath
```
public static final String getDefaultSourceCodeTemplatePath()
```
    Path to the default template used for (source-code) {@.codelet} taglets.
    
    See Also:
    DEFAULT_SRC_CODE_TMPL_PATH
  - getDefaultConsoleOutTemplatePath
```
public static final String getDefaultConsoleOutTemplatePath()
```
    Path to the default template used for {@.codelet.out} taglets.
    
    See Also:
    DEFAULT_DOT_OUT_TMPL_PATH
  - getDefaultSourceAndOutTemplatePath
```
public static final String getDefaultSourceAndOutTemplatePath()
```
    Path to the default template used for {@.codelet.and.out} taglets.
    
    See Also:
    DEFAULT_AND_OUT_TMPL_PATH
  - getDefaultFileTextTemplatePath
```
public static final String getDefaultFileTextTemplatePath()
```
    Path to the default template used for {@.file.textlet} taglets.
    
    See Also:
    DEFAULT_FILE_TEXT_TMPL_PATH
  - debuglnAndToConsole
```
public static final void debuglnAndToConsole(CodeletInstance instance,
                       Object message)
```
    Write a message to the console and, if debugging is both on and not to the console, writes it via the debug outputter as well.
    
    This
    1. Calls System.out.println(message);
    2. If debugging is both on and not to the console, this also calls
      debugln(message)
    Parameters:
    message - Should not be null or empty.
    See Also:
    debugAndToConsole(CodeletInstance, Object)
  - debugAndToConsole
```
public static final void debugAndToConsole(CodeletInstance instance,
                     Object message)
```
    Write a message to the console and, if debugging is both on and not to the console, writes it via the debug outputter as well.
    
    This
    1. Calls System.out.print(message);
    2. If debugging is both on and not to the console, this also calls
      debug(message)
    Parameters:
    message - Should not be null or empty.
    See Also:
    debuglnAndToConsole(CodeletInstance, Object)
  - debug
```
public static final void debug(Object message)
```
    Write a message to the debugging output.
    
    Equal to
    getDebugAptr().appent(message)
    
    See Also:
    debugln(Object)
  - debugln
```
public static final void debugln(Object message)
```
    Write a message to the debugging output.
    
    Equal to
    getDebugAptr().appentln(message)
    
    See Also:
    debug(Object)
  - doDebugToConsole
```
public static final boolean doDebugToConsole()
```
    Is debugging output being written to the console?. This is used only to avoid duplicate messages when debugging is on.
    
    See Also:
    getGlobalDebugLevel()
  - getGlobalDebugLevel
```
public static final DebugLevel getGlobalDebugLevel()
```
    The amount of debugging, beyond ......logging......, that is written in every taglet call.
    
    See Also:
    GLOBAL_DEBUG_LEVEL, isDebugOn(ci), isDebugOn(ci,s), getDebugAptr(), doDebugToConsole(), log
  - isDebugOn
```
public static final boolean isDebugOn(CodeletInstance instance)
```
    Is debugging on, either globally or for a single taglet?.
    
    Parameters:
    instance - May be null.
    
    Returns:
    getGlobalDebugLevel().isThisOrAnyOn(instance.getDebugLevel())
    See Also:
    isDebugOn(CodeletInstance, String), isDebugOn(int, CodeletInstance)
  - isDebugOn
```
public static final boolean isDebugOn(int min_level,
                CodeletInstance instance)
```
    Is debugging on and at least a certain level?.
    
    Parameters:
    instance - May be null.
    
    Returns:
    getGlobalDebugLevel().isHighestOnAndAtLeast(min_level, instance.getGlobalDebugLevel())
    See Also:
    isDebugOn(CodeletInstance)
  - isDebugLevelAtMost
```
public static final boolean isDebugLevelAtMost(int max_level,
                         CodeletInstance instance)
```
    Is debugging on and at most a certain level?.
    
    Parameters:
    instance - May be null.
    
    Returns:
    (getGlobalDebugLevel().getHighestNumber(instance.getGlobalDebugLevel()) <= max_level)
  - getDebugAptr
```
public static final TextAppenter getDebugAptr()
```
    The debugging outputter.
    
    See Also:
    DEBUG_DESTINATION, getGlobalDebugLevel(), getDebugApblIfOn, getDebugApblIfOn, doDebugToConsole()
  - getDebugApblIfOn
```
public static final Appendable getDebugApblIfOn(CodeletInstance instance)
```
    If debugging is on, get an appendable.
    
    Returns:
    getDebugApblIfOn(0, instance)
  - getDebugAptrIfOn
```
public static final TextAppenter getDebugAptrIfOn(CodeletInstance instance)
```
    If debugging is on, get an appenter.
    
    Returns:
    getDebugAptrIfOn(0, instance)
  - getDebugApblIfOn
```
public static final Appendable getDebugApblIfOn(int min_level,
                          CodeletInstance instance)
```
    If debugging is on and at least a certain level, get an appendable.
    
    Returns:
    (!isDebugOn(min_level, instance) ? null : getDebugAptr().getAppendable()))
    See Also:
    getDebugApblIfOn(ci), getDebugAptrIfOn(i,ci)
  - getDebugAptrIfOn
```
public static final TextAppenter getDebugAptrIfOn(int min_level,
                            CodeletInstance instance)
```
    If debugging is on and at least a certain level, get an appenter.
    
    Returns:
    (!isDebugOn(min_level, instance) ? null : getDebugAptr().getAppendable()))
    See Also:
    getDebugAptrIfOn(ci), getDebugApblIfOn(i,ci)
  - getNamedDebuggers
```
public static final NamedDebuggers getNamedDebuggers()
```
    Immutable map containing all named debug levels (both required and user-created).
    
    See Also:
    isDebugOn(CodeletInstance, String), getDebugApblIfOn(ci,s), getDebugAptrIfOn(ci,s)
  - isDebugOn
```
public static final boolean isDebugOn(CodeletInstance instance,
                String name)
```
    Is a named debuggers active?.
    
    Parameters:
    instance - May be null.
    
    Returns:
    getNamedDebuggers().isActive(name, getGlobalDebugLevel(), instance.getDebugLevel()
    See Also:
    getDebugApblIfOn(CodeletInstance, String), getDebugAptrIfOn(CodeletInstance, String)
  - getDebugApblIfOn
```
public static final Appendable getDebugApblIfOn(CodeletInstance instance,
                          String name)
```
    If a named debuggers active, get an appendable.
    
    Parameters:
    instance - May be null.
    
    Returns:
    getNamedDebuggers().getAppendableIfActive(name, getDebugAptr(), getGlobalDebugLevel(), instance.getDebugLevel()
    See Also:
    getDebugAptrIfOn(CodeletInstance, String)
  - getDebugAptrIfOn
```
public static final TextAppenter getDebugAptrIfOn(CodeletInstance instance,
                            String name)
```
    If a named debuggers active, get an appenter.
    
    Parameters:
    instance - May be null.
    
    Returns:
    getNamedDebuggers().getAppenterIfActive(name, getDebugAptr(), getGlobalDebugLevel(), instance.getDebugLevel()
    See Also:
    getDebugAptrIfOn(CodeletInstance, String)
  - getExampleSourceBaseDir
```
public static final String getExampleSourceBaseDir()
```
    Directory containing the top-most package for the source code of all example classes.
    
    See Also:
    EXAMPLE_CLASS_SRC_BASE_DIR
  - getEnclosingBaseDirList
```
public static final List<String> getEnclosingBaseDirList()
```
    An immutable list of all directories containing the top-most package of codelet-containing source-code.
    
    See Also:
    ENCLOSING_CLASS_SRC_BASE_DIRS
  - getDefaultAlterGetter
```
public static final DefaultAlterGetter getDefaultAlterGetter()
```
    When not using a custom customizer (when using none, or a pre-made processor) how many spaces should all tabs be replaced with?.
    
    See Also:
    DEFAULT_ALTERERS_CLASS_NAME
  - getGapCharConfig
```
public static final GapCharConfig getGapCharConfig()
```
    The character placed immediately before gap names.
    
    See Also:
    GAP_NAME_POSTFIX_CHAR
  - getUserExtraGapsClassName
```
public static final String getUserExtraGapsClassName()
```
    The class that defines extra gaps that can be placed in Codelet templates.
    
    See Also:
    USER_EXTRA_GAPS_CLASS_NAME
  - getCustomTemplateDir
```
public static final String getCustomTemplateDir()
```
    The directory in which any custom (user-created) templates are stored.
    
    See Also:
    USER_TEMPLATE_BASE_DIR
  - getBlackWhiteList
```
public static final FilenameBlackWhiteList getBlackWhiteList()
```
    For determining which codelets should be processed or ignored.
    
    See Also:
    BLACK_WHITE_LIST_TYPE
  - getTargetClassMapInitCapacity
```
public static final int getTargetClassMapInitCapacity()
```
  - doCrashIfAlterationNotMade
```
public static final boolean doCrashIfAlterationNotMade()
```
    If a customizer attempts to make an alteration, but cannot (such as when the find-what text is not found in the example code), what should happen?.
    Returns:
    true: If a warning should be logged and an exception should be thrown.
    
    false: If only a warning should be logged.
    See Also:
    ALTERATION_NOT_MADE_CRASH
  - getOnlinePackageListAttemptCount
```
public static final int getOnlinePackageListAttemptCount()
```
    How many attempts should be made to retrieve each online package-list? If zero, offline only.
    
    See Also:
    PKGLIST_ONLINE_ATTEMPT_COUNT
  - getOnlinePackageListAttemptSleepMills
```
public static final long getOnlinePackageListAttemptSleepMills()
```
    How many milliseconds between each failed attempt?.
    
    See Also:
    PKGLIST_ONLINE_ATTEMPT_SLEEP_MILLS
  - doCrashIfOnlinePackageListFailure
```
public static final boolean doCrashIfOnlinePackageListFailure()
```
    If all online-retrieval attempts fail, should only a warning be logged, or should Codelet stop execution? (Offline package-lists are always retrieved.)
    
    See Also:
    PKGLIST_ONLINE_FAILS_BEHAVIOR
  - doAutoUpdateOfflinePackageLists
```
public static final boolean doAutoUpdateOfflinePackageLists()
```
    When online package-lists are retrieved, should offline package lists be refreshed (or created)?
    
    See Also:
    AUTO_UPDATE_OFFLINE_PACKAGE_LISTS
  - getOfflinePackageListPostfix
```
public static final String getOfflinePackageListPostfix()
```
    The filename postfix, plus optional dot-extension that follows each offline name.
    
    See Also:
    PKGLIST_OFFLINE_NAME_POSTFIX
  - getAllJavaDocRoots
```
public static final AllOnlineOfflineDocRoots getAllJavaDocRoots()
```
    All external JavaDoc doc roots, for creating links.
    
    See Also:
    PKGLIST_ONLINE_ATTEMPT_COUNT

Enum CodeletBaseConfig

Codelet: Configuration

Codelet: Configuration: Base directories and urls, and other

Codelet: Configuration: JavaDoc related

Codelet: Configuration: Default template files

Codelet: Configuration: Template gaps

Codelet: Configuration: Debugging and diagnostics

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INSTANCE

Field Detail

DEFAULT_ONLINE_PKGLST_ATTEMPTS

DEFAULT_ONLINE_PKGLST_SLEEP_MILLS

DEFAULT_JD_TARGET_CLASS_MAP_INIT_CAPACITY

EXAMPLE_CLASS_SRC_BASE_DIR

BLACK_WHITE_LIST_TYPE

ALTERATION_NOT_MADE_CRASH

UNIQUE_JD_CLASS_TARGET_INIT_CAPACITY

BLACK_WHITE_LIST_CASE

BLACK_WHITE_PROPER_LIST

BLACK_WHITE_OVERRIDE_LIST

ENCLOSING_CLASS_SRC_BASE_DIRS

BASE_DIR_BASE_DIR

OFFLINE_PACKAGE_LIST_DIR_NAME

PKGLIST_ONLINE_ATTEMPT_COUNT

PKGLIST_ONLINE_ATTEMPT_SLEEP_MILLS

PKGLIST_ONLINE_FAILS_BEHAVIOR

AUTO_UPDATE_OFFLINE_PACKAGE_LISTS

PKGLIST_OFFLINE_NAME_POSTFIX

GLOBAL_DEBUG_LEVEL

What is logged

DEBUG_DESTINATION

DEFAULT_TPML_DIR_PREFIX

DEFAULT_SRC_CODE_TMPL_PATH

DEFAULT_DOT_OUT_TMPL_PATH

DEFAULT_AND_OUT_TMPL_PATH

DEFAULT_FILE_TEXT_TMPL_PATH

DEFAULT_ALTERERS_CLASS_NAME

GAP_NAME_PREFIX_CHAR

GAP_NAME_POSTFIX_CHAR

GAP_NAME_LITERAL_PREFIX

GAP_NAME_LITERAL_POSTFIX

USER_EXTRA_GAPS_CLASS_NAME

USER_TEMPLATE_BASE_DIR

Method Detail

values

valueOf

wasLoaded

getDefaultSourceCodeTemplatePath

getDefaultConsoleOutTemplatePath

getDefaultSourceAndOutTemplatePath

getDefaultFileTextTemplatePath

debuglnAndToConsole

debugAndToConsole

debug

debugln

doDebugToConsole

getGlobalDebugLevel

isDebugOn

isDebugOn

isDebugLevelAtMost

getDebugAptr

getDebugApblIfOn

getDebugAptrIfOn

getDebugApblIfOn

getDebugAptrIfOn

getNamedDebuggers

isDebugOn

getDebugApblIfOn

getDebugAptrIfOn

getExampleSourceBaseDir

getEnclosingBaseDirList

getDefaultAlterGetter

getGapCharConfig

getUserExtraGapsClassName

getCustomTemplateDir