com.github.aliteralmind.codelet

Enum CodeletTemplateConfig

java.lang.Object

java.lang.Enum<CodeletTemplateConfig>

com.github.aliteralmind.codelet.CodeletTemplateConfig

All Implemented Interfaces:

Serializable, Comparable<CodeletTemplateConfig>

public enum CodeletTemplateConfig
extends Enum<CodeletTemplateConfig>

Loads and manages default templates and user-extra gaps. Loading is executed by CodeletBootstrap.

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

Method Summary

Methods

Modifier and Type	Method and Description
static ConsoleOutTemplate	getDefaultConsoleOutTemplate() The path to the default template used for {@.codelet.out} taglets.
static FileTextTemplate	getDefaultFileTextTemplate() The path to the default template used for {@.file.textlet} taglets.
static SourceAndOutTemplate	getDefaultSourceAndOutTemplate() The path to the default template used for {@.codelet.and.out} taglets.
static SourceCodeTemplate	getDefaultSourceCodeTemplate() The path to the default template used for (source-code) {@.codelet} taglets.
static UserExtraGapGetter	getUserExtraGapsClass() The class that defines extra gaps that can be placed in Codelet templates.
static CodeletTemplateConfig	loadConfigGetInstance() Load configuration and return theh instance.
static CodeletTemplateConfig	valueOf(String name) Returns the enum constant of this type with the specified name.
static CodeletTemplateConfig[]	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 CodeletTemplateConfig INSTANCE

Method Detail

values

public static CodeletTemplateConfig[] 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 (CodeletTemplateConfig c : CodeletTemplateConfig.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CodeletTemplateConfig 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

loadConfigGetInstance

public static final CodeletTemplateConfig loadConfigGetInstance()
                                                         throws ClassNotFoundException

Load configuration and return theh instance. Call only once.

Returns:

#INSTANCE

Throws:

IllegalStateException - If
CodeletBaseConfig.wasLoaded
is false, or wasLoaded() is true.

ClassNotFoundException - If
CodeletBaseConfig.getUserExtraGapsClassName()
is non-empty, but does not represent an existing class.

ClassCastException - If the class exists, but is not a UserExtraGapGetter.

See Also:

PropertiesUtil

wasLoaded

public static final boolean wasLoaded()

Was configuration loaded?.

Returns:

true If all values loaded successfully.

See Also:

loadConfigGetInstance()

getDefaultSourceCodeTemplate

public static final SourceCodeTemplate getDefaultSourceCodeTemplate()

The path to the default template used for (source-code) {@.codelet} taglets.

See Also:

CodeletBaseConfig.DEFAULT_SRC_CODE_TMPL_PATH

getDefaultConsoleOutTemplate

public static final ConsoleOutTemplate getDefaultConsoleOutTemplate()

The path to the default template used for {@.codelet.out} taglets.

See Also:

CodeletBaseConfig.DEFAULT_DOT_OUT_TMPL_PATH

getDefaultSourceAndOutTemplate

public static final SourceAndOutTemplate getDefaultSourceAndOutTemplate()

The path to the default template used for {@.codelet.and.out} taglets.

See Also:

CodeletBaseConfig.DEFAULT_AND_OUT_TMPL_PATH

getDefaultFileTextTemplate

public static final FileTextTemplate getDefaultFileTextTemplate()

The path to the default template used for {@.file.textlet} taglets.

See Also:

CodeletBaseConfig.DEFAULT_FILE_TEXT_TMPL_PATH

getUserExtraGapsClass

public static final UserExtraGapGetter getUserExtraGapsClass()

The class that defines extra gaps that can be placed in Codelet templates.

See Also:

CodeletBaseConfig.USER_EXTRA_GAPS_CLASS_NAME