- GAP_BASE_DIR - Static variable in class com.github.aliteralmind.codelet.type.FileTextTemplate
-
The on-disk path that is prepended to the file's relative path--Gap name is "base_dir".
- GAP_BODY_CONSOLE_OUTPUT - Static variable in class com.github.aliteralmind.codelet.type.SourceAndOutTemplate
-
The gap name for the fully processed console output, which is one of two gaps required to exist in the template--equal to "body_console_output".
- GAP_BODY_SOURCE_CODE - Static variable in class com.github.aliteralmind.codelet.type.SourceAndOutTemplate
-
The gap name for the fully processed source-code, which is one of two gaps required to exist in the template--equal to "body_source_code".
- GAP_COMMAND_LINE_PARAMS - Static variable in class com.github.aliteralmind.codelet.type.ConsoleOutTemplate
-
Parameters as passed to the example code's main function--Name is "command_line_params".
- GAP_FILE_NAME_NO_EXT - Static variable in class com.github.aliteralmind.codelet.type.FileTextTemplate
-
The name of the file, without its dot-extension (such as ".txt")--Gap name is "file_name_no_ext".
- GAP_FILE_NAME_WITH_EXT - Static variable in class com.github.aliteralmind.codelet.type.FileTextTemplate
-
The name of the file, including its dot-extension (such as ".txt")--Gap name is "file_name".
- GAP_FQ_CLASS_NAME - Static variable in class com.github.aliteralmind.codelet.type.SourceCodeTemplate
-
The example code's fully-qualified class name--Gap name is "fq_class_name".
- GAP_FQ_CLASS_NAME_DIR - Static variable in class com.github.aliteralmind.codelet.type.SourceCodeTemplate
-
The example's fully-qualified class name, with dots '.' replaced by file-separators--Gap name is "fq_class_name_dir".
- GAP_FQ_CLASS_NAME_URL - Static variable in class com.github.aliteralmind.codelet.type.SourceCodeTemplate
-
The example's fully-qualified class name, with dots ('.') replaced by url-slashes ('/')--Gap name is "fq_class_name_url".
- GAP_JAVADOC_URL - Static variable in class com.github.aliteralmind.codelet.type.SourceCodeTemplate
-
The absolute url to the example code's JavaDoc--Gap name is "javadoc_url".
- GAP_NAME_LITERAL_POSTFIX - Static variable in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
Literal representation of the postfix char, for use in between texts--Name is "gap_literal_name_postfix_char".
- GAP_NAME_LITERAL_PREFIX - Static variable in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
Literal representation of the prefix char, for use in between texts--Name is "gap_literal_prefix_char".
- GAP_NAME_POSTFIX_CHAR - Static variable in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
Character placed immediately after gap names--Name is "gap_name_postfix_char".
- GAP_NAME_PREFIX_CHAR - Static variable in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
Character placed immediately before gap names--Name is "gap_name_prefix_char".
- GAP_PACKAGE - Static variable in class com.github.aliteralmind.codelet.type.SourceCodeTemplate
-
The example code's package name--Gap name is "package".
- GAP_PACKAGE_DIR - Static variable in class com.github.aliteralmind.codelet.type.SourceCodeTemplate
-
The example's package name, with dots '.' replaced by file-separators--Gap name is "package_dir".
- GAP_PACKAGE_URL - Static variable in class com.github.aliteralmind.codelet.type.SourceCodeTemplate
-
The example code's package, with dots ('.') replaced by url-slashes ('/')--Gap name is "package_url".
- GAP_PATH - Static variable in class com.github.aliteralmind.codelet.type.FileTextTemplate
-
The absolute on-disk path to the file--Gap name is "path".
- GAP_REL_DIR_AS_URL - Static variable in class com.github.aliteralmind.codelet.type.FileTextTemplate
-
The example code's relative_dir, with file-separators replaced by url-slashes ('/')--Gap name is "relative_dir_as_url".
- GAP_REL_PATH_AS_URL - Static variable in class com.github.aliteralmind.codelet.type.FileTextTemplate
-
The file's relative url-path, as it exists in the base url--Gap name is "rel_path_url"..
- GAP_RELATIVE_DIR - Static variable in class com.github.aliteralmind.codelet.type.FileTextTemplate
-
The example code's relative directory, as it exists in the absolute path--Gap name is "relative_dir".
- GAP_RELATIVE_PATH - Static variable in class com.github.aliteralmind.codelet.type.FileTextTemplate
-
The example's path as it exists in the base directory--Gap name is "file_name_dir".
- GAP_SIMPLE_CLASS_NAME - Static variable in class com.github.aliteralmind.codelet.type.SourceCodeTemplate
-
The example code's non-fully-qualified class name--Gap name is "simple_class_name".
- GAP_SOURCE_URL - Static variable in class com.github.aliteralmind.codelet.type.SourceCodeTemplate
-
- GAP_SRC_BASE_DIR - Static variable in class com.github.aliteralmind.codelet.type.SourceCodeTemplate
-
The on-disk directory in which the top-most package of example source-code file exists--Gap name is "source_base_dir".
- GAP_SRC_PATH - Static variable in class com.github.aliteralmind.codelet.type.SourceCodeTemplate
-
The full on-disk path to the example code's source file--Gap name is "source_path".
- GAP_URL - Static variable in class com.github.aliteralmind.codelet.type.FileTextTemplate
-
The absolute url to the example code's source file, as exists somewhere in the JavaDoc output directory ({@docRoot})--Gap name is "javadoc_path_url".
- get(CodeletInstance, String, Appendable) - Static method in class com.github.aliteralmind.codelet.alter.DefaultAlterGetterUtil
-
Get a default alterer from its name.
- get(Tag) - Static method in enum com.github.aliteralmind.codelet.taglet.CodletComSunJavadocTagProcessor
-
Passes all taglet information to the codelet processor (without any references to com.sun.javadoc) and returns the text that replaces the taglet in the JavaDoc.
- get() - Method in class com.github.aliteralmind.codelet.TagletProcessor
-
Get the taglet's already-rendered output text.
- get(CodeletInstance, Appendable) - Static method in enum com.github.aliteralmind.codelet.TemplateOverrides
-
Get the template.
- getAllJavaDocRoots() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
- getAllMatches(List<ConstructorSimpleParamSig>, CrashIfZero) - Method in class com.github.aliteralmind.codelet.simplesig.ConstructorParamSearchTerm
-
Get a new list of all matches.
- getAllMatches(AllSimpleParamSignatures, CrashIfZero) - Method in class com.github.aliteralmind.codelet.simplesig.MethodSigSearchTerm
-
Get a new list of all matches.
- getAllMatchesProt(List<? extends SimpleParamNameSignature>, CrashIfZero) - Method in class com.github.aliteralmind.codelet.simplesig.SimpleParamSigSearchTerm
-
Get a new list of all matching constructors/methods.
- getAllParamSigsForLinkTarget(Class<?>) - Static method in class com.github.aliteralmind.codelet.alter.NewJDLinkForWordOccuranceNum
-
Get the object that translates function and constructor shortcut signatures to the method or constructor object they represent.
- getAllQueriesDebugAptr() - Method in class com.github.aliteralmind.codelet.util.NamedDebuggers
-
Get the text appenter for debugging each query.
- getAlterArrayWithDefaultAlterersAdded(CodeletType, TextLineAlterer) - Static method in class com.github.aliteralmind.codelet.alter.DefaultAlterGetterUtil
-
Creates a new line-alter array with all default alterers placed after the provided alterer.
- getAlterArrayWithDefaultAlterersAdded(CodeletType, List<TextLineAlterer>) - Static method in class com.github.aliteralmind.codelet.alter.DefaultAlterGetterUtil
-
Creates a new line-alter array with all default alterers placed after all provided alterers.
- getAlterer() - Method in class com.github.aliteralmind.codelet.CustomizationInstructions
-
Get the line-alterer.
- getAppendableIfActive(String, TextAppenter, DebugLevel, DebugLevel...) - Method in class com.github.aliteralmind.codelet.util.NamedDebuggers
-
If a named-level is active, get an appendable for it.
- getAppenterIfActive(String, TextAppenter, DebugLevel, DebugLevel...) - Method in class com.github.aliteralmind.codelet.util.NamedDebuggers
-
If a named-level is active, get an appenter for it.
- getBaseDirectory() - Method in class com.github.aliteralmind.codelet.util.FQClassNameWithBaseDir
-
- getBlackIfTrue(boolean) - Static method in enum com.github.aliteralmind.codelet.util.BlackOrWhite
-
Return BlackOrWhite.BLACK if the flag is true, or WHITE if false.
- getBlackWhiteList() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
For determining which codelets should be processed or ignored.
- getCaseSensitivity() - Method in class com.github.aliteralmind.codelet.util.FilenameBlackWhiteList
-
Is case ignored, required, or system-determined?.
- getClassName() - Method in class com.github.aliteralmind.codelet.util.FQClassNameWithBaseDir
-
- getClassNameForParams(Class<?>[], VarArgs) - Static method in class com.github.aliteralmind.codelet.util.JavaDocUtil
-
Append the comma-separated list of JavaDoc parameters for a method or constructor.
- getClassNameOrFilePathRestricter() - Method in class com.github.aliteralmind.codelet.CustomizationInstructions
-
Wildcard search-term to restrict the classes that may utilize this customizer.
- getClassOrFilePortion() - Method in class com.github.aliteralmind.codelet.TagletOfTypeProcessor
-
The example code's fully-qualified class name (plus any command-line parameters), or the path to the plain-text file.
- getCodeletConfigDir() - Static method in enum com.github.aliteralmind.codelet.CodeletBootstrap
-
The directory in which all Codelet configuration files exist, as passed in via the javadoc.exe system property named "codelet_config_dir".
- getConstructor() - Method in class com.github.aliteralmind.codelet.simplesig.ConstructorSimpleParamSig
-
The constructor object.
- getConstructorFromAllSigsAndSearchTerm(AllSimpleParamSignatures, String, Appendable, Appendable) - Static method in class com.github.aliteralmind.codelet.simplesig.ConstructorParamSearchTerm
-
Get the single matching constructor from an all-signature object.
- getConstructorList() - Method in class com.github.aliteralmind.codelet.simplesig.AllSimpleParamSignatures
-
All constructors.
- getContainingClass() - Method in class com.github.aliteralmind.codelet.simplesig.AllSimpleParamSignatures
-
The class containing the constructors and methods.
- getCustomCustomizationInstructions(CodeletType) - Method in class com.github.aliteralmind.codelet.TagletOfTypeProcessor
-
- getCustomizationInstructions(CodeletType) - Method in class com.github.aliteralmind.codelet.TagletOfTypeProcessor
-
- getCustomizedBody(CodeletInstance, Iterator<String>) - Method in class com.github.aliteralmind.codelet.CustomizationInstructions
-
Given all configured customization instructions, transform the raw output (source-code, console-output, or file-text) into its fully-processed form, ready for insertion into the template.
- getCustomizerPortion() - Method in class com.github.aliteralmind.codelet.TagletOfTypeProcessor
-
The optional customizer part of a codelet, as found after its prefix character.
- getCustomizerSigFromString(String) - Method in class com.github.aliteralmind.codelet.TagletOfTypeProcessor
-
Given the customizer's fully-expanded string-signature, get its simple-signature.
- getCustomTemplateDir() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
The directory in which any custom (user-created) templates are stored.
- getDbgAptr() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleMethodSignature
-
- getDebugApblIfOn(CodeletInstance) - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
If debugging is on, get an appendable.
- getDebugApblIfOn(int, CodeletInstance) - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
If debugging is on and at least a certain level, get an appendable.
- getDebugApblIfOn(CodeletInstance, String) - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
If a named debuggers active, get an appendable.
- getDebugAptr() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
The debugging outputter.
- getDebugAptrBasics() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleParamSigSearchTerm
-
- getDebugAptrDoesMatch() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleParamSigSearchTerm
-
- getDebugAptrIfOn(CodeletInstance) - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
If debugging is on, get an appenter.
- getDebugAptrIfOn(int, CodeletInstance) - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
If debugging is on and at least a certain level, get an appenter.
- getDebugAptrIfOn(CodeletInstance, String) - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
If a named debuggers active, get an appenter.
- getDebugLevel() - Method in class com.github.aliteralmind.codelet.CodeletInstance
-
The debugging level for this taglet only, as defined in the optional override prefix.
- getDefaultAlterArray(CodeletType) - Static method in class com.github.aliteralmind.codelet.alter.DefaultAlterGetterUtil
-
Creates a new line-alter array with all defaults.
- getDefaultAlterGetter() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
When not using a custom customizer (when using none, or a pre-made processor) how many spaces should all tabs be replaced with?.
- getDefaultConsoleOutTemplate() - Static method in enum com.github.aliteralmind.codelet.CodeletTemplateConfig
-
The path to the default template used for {@.codelet.out} taglets.
- getDefaultConsoleOutTemplatePath() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
Path to the default template used for {@.codelet.out} taglets.
- getDefaultFileTextTemplate() - Static method in enum com.github.aliteralmind.codelet.CodeletTemplateConfig
-
The path to the default template used for {@.file.textlet} taglets.
- getDefaultFileTextTemplatePath() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
Path to the default template used for {@.file.textlet} taglets.
- getDefaultLineProcNamePrefix() - Method in enum com.github.aliteralmind.codelet.CodeletType
-
The default prefix for Customizers of this type.
- getDefaultSourceAndOutTemplate() - Static method in enum com.github.aliteralmind.codelet.CodeletTemplateConfig
-
The path to the default template used for {@.codelet.and.out} taglets.
- getDefaultSourceAndOutTemplatePath() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
Path to the default template used for {@.codelet.and.out} taglets.
- getDefaultSourceCodeTemplate() - Static method in enum com.github.aliteralmind.codelet.CodeletTemplateConfig
-
The path to the default template used for (source-code) {@.codelet} taglets.
- getDefaultSourceCodeTemplatePath() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
Path to the default template used for (source-code) {@.codelet} taglets.
- getDefaultTemplateDebug() - Method in class com.github.aliteralmind.codelet.CustomizationInstructions
-
When using the default template only, this is its debug destination.
- getDocRootUrlToTargetClass(CodeletInstance, Class<?>) - Static method in class com.github.aliteralmind.codelet.alter.NewJavaDocLinkReplacerFor
-
Get the
{@docRoot} url for a package, which may be internal or
external.
- getDotPlusExtension() - Method in class com.github.aliteralmind.codelet.util.FQClassNameWithBaseDir
-
- getEllipsisArrayLastParam(Class<?>) - Static method in class com.github.aliteralmind.codelet.util.JavaDocUtil
-
- getEnclosingBaseDirList() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
An immutable list of all directories containing the top-most package of codelet-containing source-code.
- getEnclosingClass() - Method in class com.github.aliteralmind.codelet.CodeletInstance
-
Get the taglet's enclosing class object, if it is a class.
- getEnclosingFile() - Method in class com.github.aliteralmind.codelet.CodeletInstance
-
The
file-object whose source code contains a JavaDoc block, in which this codelet exists.
- getEnclosingFullyQualifiedName() - Method in class com.github.aliteralmind.codelet.CodeletInstance
-
Get the fully-qualified name of the taglet's enclosing JavaDoc file.
- getEnclosingPackage() - Method in class com.github.aliteralmind.codelet.CodeletInstance
-
- getEnclosingPackageName(Tag) - Static method in class com.github.aliteralmind.codelet.taglet.ComSunJavaDocUtil
-
Get the package of the tag-containing JavaDoc page.
- getEnclosingSimpleName() - Method in class com.github.aliteralmind.codelet.CodeletInstance
-
The post-package name of this taglet's containing JavaDoc file.
- getEnclosingSimpleName(Tag, IncludePostClassName) - Static method in class com.github.aliteralmind.codelet.taglet.ComSunJavaDocUtil
-
Get the tag-containing JavaDoc page's post-package name.
- getErrorMessage(CodeletInstance, String) - Static method in exception com.github.aliteralmind.codelet.CodeletFormatException
-
- getErrorMessage(int, String, String) - Static method in exception com.github.aliteralmind.codelet.TemplateOverridesConfigLineException
-
- getExampleClassFQName(CodeletInstance) - Static method in class com.github.aliteralmind.codelet.TagletTextUtil
-
The example code's fully-qualified class name.
- getExampleClassOrFilePortionFromTagletText(CodeletInstance) - Static method in class com.github.aliteralmind.codelet.TagletTextUtil
-
The example-class or plain-text-file portion of the taglet text.
- getExampleCodeStringSig() - Method in class com.github.aliteralmind.codelet.TagletOfTypeProcessor
-
Get the string-signature for executing the example code.
- getExampleCommandLineParams(CodeletInstance) - Static method in class com.github.aliteralmind.codelet.TagletTextUtil
-
- getExamplePackageName(CodeletInstance) - Static method in class com.github.aliteralmind.codelet.TagletTextUtil
-
Get the example code's package name.
- getExampleSimpleClassName(CodeletInstance) - Static method in class com.github.aliteralmind.codelet.TagletTextUtil
-
Get the example code's non-fully-qualified class name.
- getExampleSourceBaseDir() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
Directory containing the top-most package for the source code of all example classes.
- getFileNameWithExtension(CodeletInstance) - Static method in class com.github.aliteralmind.codelet.TagletTextUtil
-
The plain-text file name, including its dot-extension (such as ".txt"), if any.
- getFileNameWithoutExtension(CodeletInstance) - Static method in class com.github.aliteralmind.codelet.TagletTextUtil
-
The plain-text file name, excluding its dot-extension (such as ".txt").
- getFilePath(CodeletInstance) - Static method in class com.github.aliteralmind.codelet.TagletTextUtil
-
The full path to the plain-text file.
- getFileText() - Method in class com.github.aliteralmind.codelet.util.FQClassNameWithBaseDir
-
- getFillText(CodeletInstance) - Method in class com.github.aliteralmind.codelet.CodeletGap
-
The output string that replaces the gap.
- getFilter() - Method in class com.github.aliteralmind.codelet.CustomizationInstructions
-
Get the line-filter.
- getFirstMatch(List<ConstructorSimpleParamSig>, CrashIfZero, CrashIfMoreThanOne) - Method in class com.github.aliteralmind.codelet.simplesig.ConstructorParamSearchTerm
-
Get the first match.
- getFirstMatch(AllSimpleParamSignatures, CrashIfZero, CrashIfMoreThanOne) - Method in class com.github.aliteralmind.codelet.simplesig.MethodSigSearchTerm
-
Get the first match.
- getFirstMatchProt(List<? extends SimpleParamNameSignature>, CrashIfZero, CrashIfMoreThanOne) - Method in class com.github.aliteralmind.codelet.simplesig.SimpleParamSigSearchTerm
-
Get the first matching constructor/method.
- getForBoolean(boolean) - Static method in enum com.github.aliteralmind.codelet.alter.DeleteMultiLineComments
-
Return DeleteMultiLineComments.YES if the flag is true, or NO if false.
- getForBoolean(boolean) - Static method in enum com.github.aliteralmind.codelet.simplesig.CrashIfMoreThanOne
-
Return CrashIfMoreThanOne.YES if the flag is true, or NO if false.
- getForBoolean(boolean) - Static method in enum com.github.aliteralmind.codelet.simplesig.CrashIfZero
-
Return CrashIfZero.YES if the flag is true, or NO if false.
- getForBoolean(boolean) - Static method in enum com.github.aliteralmind.codelet.simplesig.Immutable
-
Return Immutable.YES if the flag is true, or NO if false.
- getForBoolean(boolean) - Static method in enum com.github.aliteralmind.codelet.simplesig.Sorted
-
Return Sorted.YES if the flag is true, or NO if false.
- getForBoolean(boolean) - Static method in enum com.github.aliteralmind.codelet.taglet.IncludePostClassName
-
Return IncludePostClassName.YES if the flag is true, or NO if false.
- getForBoolean(boolean) - Static method in enum com.github.aliteralmind.codelet.util.RefreshOffline
-
Return RefreshOffline.YES if the flag is true, or NO if false.
- getForBoolean(boolean) - Static method in enum com.github.aliteralmind.codelet.util.VarArgs
-
Return VarArgs.YES if the flag is true, or NO if false.
- getForCodeletAndOut() - Method in interface com.github.aliteralmind.codelet.UserExtraGapGetter
-
- getForCodeletDotOut() - Method in interface com.github.aliteralmind.codelet.alter.DefaultAlterGetter
-
- getForCodeletDotOut() - Method in class com.github.aliteralmind.codelet.alter.DefaultDefaultAlterGetter
-
Returns a map with a single entry, whose key is "escape_html", and whose value is NewTextLineAltererFor.escapeHtml().
- getForCodeletDotOut() - Method in interface com.github.aliteralmind.codelet.UserExtraGapGetter
-
- getForFileTextlet() - Method in interface com.github.aliteralmind.codelet.alter.DefaultAlterGetter
-
- getForFileTextlet() - Method in class com.github.aliteralmind.codelet.alter.DefaultDefaultAlterGetter
-
Returns a map with a single entry, whose key is "escape_html", and whose value is NewTextLineAltererFor.escapeHtml().
- getForFileTextlet() - Method in interface com.github.aliteralmind.codelet.UserExtraGapGetter
-
- getForMainFromStringSig(Object, Appendable) - Static method in class com.github.aliteralmind.codelet.simplesig.SimpleMethodSignature
-
Splits a string-signature into its parts, for the classes
main function (or any non-returning
void function), and where the fully-qualified class is explicitely specified in the string (no defaults are used).
- getForSourceCodelet() - Method in interface com.github.aliteralmind.codelet.alter.DefaultAlterGetter
-
- getForSourceCodelet() - Method in class com.github.aliteralmind.codelet.alter.DefaultDefaultAlterGetter
-
- getForSourceCodelet() - Method in interface com.github.aliteralmind.codelet.UserExtraGapGetter
-
- getFullOriginalTaglet() - Method in class com.github.aliteralmind.codelet.CodeletInstance
-
Returns the full original taglet, exactly as found in the JavaDoc.
- getFullyCustomizedOutput() - Method in class com.github.aliteralmind.codelet.TagletOfTypeProcessor
-
- getFunctionName() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleMethodSignature
-
- getGapCharConfig() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
The character placed immediately before gap names.
- getGapCount() - Method in class com.github.aliteralmind.codelet.CodeletTemplateBase
-
The number of gaps actually in the template.
- getGlobalDebugLevel() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
The amount of debugging, beyond ......logging......, that is written in every taglet call.
- getImmutableOverrideList() - Method in class com.github.aliteralmind.codelet.util.FilenameBlackWhiteList
-
The unmodifiable list of wildcard items that, when matched, override the "proper" finding.
- getImmutableProperList() - Method in class com.github.aliteralmind.codelet.util.FilenameBlackWhiteList
-
The unmodifiable list of wildcard items that, when matched--and not overridden--are either acceptable (white-listed) or unacceptable (black-listed).
- getInstance() - Method in exception com.github.aliteralmind.codelet.CodeletFormatException
-
- getInstance() - Method in class com.github.aliteralmind.codelet.CustomizationInstructions
-
- getInstance() - Method in class com.github.aliteralmind.codelet.TagletOfTypeProcessor
-
The current taglet instance.
- getInstructionsFromSig(SimpleMethodSignature, CodeletType) - Method in class com.github.aliteralmind.codelet.TagletOfTypeProcessor
-
Invoke the customizer and get its return value, as required by the taglet-processor--For {@.codelet.and.out} taglets only.
- getJavaClass() - Method in class com.github.aliteralmind.codelet.util.JavaClassWithBaseDir
-
- getJavaDocExampleUrl(CodeletInstance) - Static method in class com.github.aliteralmind.codelet.TagletTextUtil
-
The absolute url to the example code's source file, as created by JavaDoc (in {@docRoot}/src-html/).
- getJavaDocSourceUrl(CodeletInstance) - Static method in class com.github.aliteralmind.codelet.TagletTextUtil
-
- getJavaDocUrl(CodeletInstance) - Static method in class com.github.aliteralmind.codelet.TagletTextUtil
-
- getJavaSourceFilePath(CodeletInstance) - Static method in class com.github.aliteralmind.codelet.TagletTextUtil
-
The full on-disk path to the example code's source file.
- getLineNumber() - Method in class com.github.aliteralmind.codelet.CodeletInstance
-
The
line number in the enclosing classes source-code, at which this codelet exists.
- getLineNumber() - Method in exception com.github.aliteralmind.codelet.TemplateOverridesConfigLineException
-
- getLineText() - Method in exception com.github.aliteralmind.codelet.TemplateOverridesConfigLineException
-
- getMap(CodeletType) - Static method in class com.github.aliteralmind.codelet.alter.DefaultAlterGetterUtil
-
Get the map of default alterers.
- getMap() - Method in class com.github.aliteralmind.codelet.util.NamedDebuggers
-
Unmodifiable name-to-level map.
- getMayContainFuncClass(int) - Method in class com.github.aliteralmind.codelet.simplesig.SimpleMethodSignature
-
- getMayContainFuncClassCount() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleMethodSignature
-
- getMember() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleParamNameSignature
-
The method or constructor having these parameters.
- getMethod() - Method in class com.github.aliteralmind.codelet.simplesig.MethodSimpleParamSig
-
The method object.
- getMethod() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleMethodSignature
-
- getMethodFromAllSigsAndSearchTerm(AllSimpleParamSignatures, String, Appendable, Appendable) - Static method in class com.github.aliteralmind.codelet.simplesig.MethodSigSearchTerm
-
Get the single matching method from an all-signature object.
- getMethodFromParamTypes(Class<?>[]) - Method in class com.github.aliteralmind.codelet.simplesig.SimpleMethodSignature
-
Get the method as specified in the SimpleMethodSignature, which must exist in one of the may-contain classes.
- getMethodFromParamValueList(List<Object>) - Method in class com.github.aliteralmind.codelet.simplesig.SimpleMethodSignature
-
- getMethodListForNameCrashIfNone(String) - Method in class com.github.aliteralmind.codelet.simplesig.AllSimpleParamSignatures
-
Get the methods with a name, or crash if no methods have that name.
- getMethodMap() - Method in class com.github.aliteralmind.codelet.simplesig.AllSimpleParamSignatures
-
All methods.
- getMethodName() - Method in class com.github.aliteralmind.codelet.simplesig.ConstructorSimpleParamSig
-
- getMethodName() - Method in class com.github.aliteralmind.codelet.simplesig.MethodSimpleParamSig
-
- getMethodName() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleParamNameSignature
-
If a method: its name, if a constructor: the empty string ("").
- getMethodName() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleParamSigSearchTerm
-
The function name, or the empty string if a constructor.
- getName() - Method in enum com.github.aliteralmind.codelet.CodeletType
-
The
name of this taglet, as used in JavaDoc.
- getName() - Method in class com.github.aliteralmind.codelet.taglet.CodeletAndOutTaglet
-
Return the name of this custom tag.
- getName() - Method in class com.github.aliteralmind.codelet.taglet.CodeletDotOutTaglet
-
Return the name of this custom tag.
- getName() - Method in class com.github.aliteralmind.codelet.taglet.CodeletTaglet
-
Return the name of this custom tag.
- getName() - Method in class com.github.aliteralmind.codelet.taglet.FileTextletTaglet
-
Return the name of this custom tag.
- getNamedDebuggers() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
- getNameToRootMap() - Method in class com.github.aliteralmind.codelet.util.AllOnlineOfflineDocRoots
-
An immutable map whose key is the doc-root's
name, and value is its
OnlineOfflineDocRoot.
- getNeededAlterArrayType() - Method in class com.github.aliteralmind.codelet.CustomizationInstructions
-
- getNoParams() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleParamSigSearchTerm
-
The original search-term parameter list, excluding the parentheses.
- getNoParens() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleParamNameSignature
-
Comma-delimited string of all parameter-type simple names, excluding the surrounding parentheses.
- getObjectCopy(Appendable) - Method in class com.github.aliteralmind.codelet.CodeletTemplateBase
-
- getObjectCopy(Appendable) - Method in class com.github.aliteralmind.codelet.type.ConsoleOutTemplate
-
Duplicate this template.
- getObjectCopy(Appendable) - Method in class com.github.aliteralmind.codelet.type.FileTextTemplate
-
Duplicate this template.
- getObjectCopy(Appendable) - Method in class com.github.aliteralmind.codelet.type.SourceAndOutTemplate
-
Duplicate this template.
- getObjectCopy(Appendable) - Method in class com.github.aliteralmind.codelet.type.SourceCodeTemplate
-
Duplicate this template.
- getObjectCopy() - Method in class com.github.aliteralmind.codelet.util.FQClassNameWithBaseDir
-
Get a duplicate of this FQClassNameWithBaseDir.
- getObjectFromString(String) - Static method in class com.github.aliteralmind.codelet.simplesig.SimpleMethodSignature
-
Get the object represented by a single string-representation of a single parameter.
- getObjectListFromCommaSepParamString(String) - Static method in class com.github.aliteralmind.codelet.simplesig.SimpleMethodSignature
-
Get the objects from the string-representation of a function's parameter list.
- getOfflinePackageListPostfix() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
The filename postfix, plus optional dot-extension that follows each offline name.
- getOnlinePackageListAttemptCount() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
How many attempts should be made to retrieve each online package-list? If zero, offline only.
- getOnlinePackageListAttemptSleepMills() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
How many milliseconds between each failed attempt?.
- getOnlyMatch(List<ConstructorSimpleParamSig>) - Method in class com.github.aliteralmind.codelet.simplesig.ConstructorParamSearchTerm
-
Get the first and only match.
- getOnlyMatch(AllSimpleParamSignatures) - Method in class com.github.aliteralmind.codelet.simplesig.MethodSigSearchTerm
-
Get the first and only match.
- getOnlyMatchProt(List<? extends SimpleParamNameSignature>) - Method in class com.github.aliteralmind.codelet.simplesig.SimpleParamSigSearchTerm
-
Get the first and only match.
- getPackageDoc(Tag) - Static method in class com.github.aliteralmind.codelet.taglet.ComSunJavaDocUtil
-
Get the object containing the "package" of the tag-containing JavaDoc page.
- getPackageList() - Method in class com.github.aliteralmind.codelet.util.OnlineOfflineDocRoot
-
An immutable list of all package names.
- getParamNameList() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleParamNameSignature
-
List of all parameter-type simple names.
- getParamStringList() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleMethodSignature
-
- getParamValueObjectList() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleMethodSignature
-
- getPath() - Method in class com.github.aliteralmind.codelet.CodeletTemplateBase
-
- getPath() - Method in class com.github.aliteralmind.codelet.util.FQClassNameWithBaseDir
-
- getPath() - Method in class com.github.aliteralmind.codelet.util.OnlineOfflineDocRoot
-
Full path to the offline duplicate of the package-list file.
- getPkgToUrlMap() - Method in class com.github.aliteralmind.codelet.util.AllOnlineOfflineDocRoots
-
An immutable map whose key is a
package, and value is its document root url.
- getRelativeUrlToDocRoot() - Method in class com.github.aliteralmind.codelet.CodeletInstance
-
The relative directory from the containing classes JavaDoc file, to the JavaDoc root directory--Equivalent to {@docRoot}.
- getRelativeUrlToDocRoot(Tag) - Static method in class com.github.aliteralmind.codelet.taglet.ComSunJavaDocUtil
-
Get the relative url whose value is equivalent to {@docRoot}.
- getRelativeUrlToDocRoot(String) - Static method in class com.github.aliteralmind.codelet.util.JavaDocUtil
-
Get the url from a link-source file's package to doc-root.
- getRendered(CodeletInstance) - Method in class com.github.aliteralmind.codelet.CodeletTemplateBase
-
ReplacedInEachInput all default-optional and user-extra gaps with their values, resets the template, and returns its fully-rendered text--This is what actually replaces the codelet-taglet.
- getReturnType() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleMethodSignature
-
- getSig2PrnsApnddForNameOrPostfix(String, String, boolean) - Method in class com.github.aliteralmind.codelet.TagletOfTypeProcessor
-
- getSimpleNameListFromClasses(Class<?>[]) - Static method in class com.github.aliteralmind.codelet.simplesig.SimpleParamNameSignature
-
Create a list of all simple names from a class array.
- getSourceCodeLineIterator(CodeletInstance) - Method in class com.github.aliteralmind.codelet.TagletOfTypeProcessor
-
- getStringForBoolInt(Boolean, Integer) - Static method in class com.github.aliteralmind.codelet.examples.simplesig.SimpleMethodSigNoDefaults
-
- getStringForBoolInt(Boolean, Integer) - Static method in class com.github.aliteralmind.codelet.examples.simplesig.SimpleMethodSigWithClassDefaults
-
- getStringSig_ret_class_func_params(boolean, boolean, boolean, boolean) - Method in class com.github.aliteralmind.codelet.simplesig.SimpleMethodSignature
-
- getStringSigForFileText() - Method in class com.github.aliteralmind.codelet.type.FileTextProcessor
-
Get the string signature for a {@.file.textlet} taglets only.
- getStringSignature() - Method in exception com.github.aliteralmind.codelet.simplesig.SimpleMethodSigFormatException
-
- getStringSignature() - Method in exception com.github.aliteralmind.codelet.simplesig.SimpleParamSigSearchTermFormatException
-
- getStringSignature() - Method in class com.github.aliteralmind.codelet.TagletOfTypeProcessor
-
Expands a potentially-shortened customizer signature (shortcut) to its full string-signature, for
{@.codelet} and
{@.codelet.out} taglets only.
- getSum() - Method in class com.github.aliteralmind.codelet.examples.adder.Adder
-
- getSum() - Method in class com.github.aliteralmind.codelet.examples.adder.AdderWithCodelet
-
- getTagletTextSplitOnLineProcDelim(CodeletInstance) - Static method in class com.github.aliteralmind.codelet.TagletTextUtil
-
The class-or-plain-text-file portion of the taglet text, split on the customizer delimiter character.
- getTargetClassMapInitCapacity() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
- getTemplate() - Method in class com.github.aliteralmind.codelet.CodeletTemplateBase
-
The template.
- getTemplate() - Method in class com.github.aliteralmind.codelet.CustomizationInstructions
-
Get the template.
- getTemplateFromInstructionsOverrideOrDefault(CustomizationInstructions<T>) - Method in class com.github.aliteralmind.codelet.TagletOfTypeProcessor
-
- getTermList() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleParamSigSearchTerm
-
Immutable list of parameter types (their simple names), where asterisks are replaced with null.
- getText() - Method in class com.github.aliteralmind.codelet.CodeletInstance
-
The original, unaltered
text, as found after the taglet's name (and any whitespace).
- getThisOrCrashIfBad(Readable, Writable) - Method in class com.github.aliteralmind.codelet.util.FQClassNameWithBaseDir
-
- getThisOrCrashIfBad(Existence, Readable, Writable) - Method in class com.github.aliteralmind.codelet.util.FQClassNameWithBaseDir
-
- getType() - Method in class com.github.aliteralmind.codelet.CodeletInstance
-
The type of this Codelet, which implies its
name.
- getType() - Method in class com.github.aliteralmind.codelet.CodeletTemplateBase
-
The type of this template.
- getUrlDir() - Method in class com.github.aliteralmind.codelet.util.OnlineOfflineDocRoot
-
Url of the directory in which the package-list file exists.
- getUrlToClass(String, Class<?>) - Static method in class com.github.aliteralmind.codelet.util.JavaDocUtil
-
Get the url to a class.
- getUrlToClassViaDocRoot(String, Class<?>) - Static method in class com.github.aliteralmind.codelet.util.JavaDocUtil
-
Get the url from a link-source to the target class file.
- getUrlToConstructor(String, Constructor) - Static method in class com.github.aliteralmind.codelet.util.JavaDocUtil
-
Get the url to a constructor.
- getUrlToField(String, Field) - Static method in class com.github.aliteralmind.codelet.util.JavaDocUtil
-
Get the url to a field.
- getUrlToMethod(String, Method) - Static method in class com.github.aliteralmind.codelet.util.JavaDocUtil
-
Get the url to a function.
- getUrlToRootMap() - Method in class com.github.aliteralmind.codelet.util.AllOnlineOfflineDocRoots
-
An immutable map whose key is the doc-root's
url, and value is its
OnlineOfflineDocRoot.
- getUserExtraGapsClass() - Static method in enum com.github.aliteralmind.codelet.CodeletTemplateConfig
-
The class that defines extra gaps that can be placed in Codelet templates.
- getUserExtraGapsClassName() - Static method in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
The class that defines extra gaps that can be placed in Codelet templates.
- getWithParams() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleParamSigSearchTerm
-
The original search-term parameter list.
- getWithParens() - Method in class com.github.aliteralmind.codelet.simplesig.SimpleParamNameSignature
-
Comma-delimited string of all parameter-type simple names, listed in the same order as declared, including the surrounding parentheses.
- GLOBAL_DEBUG_LEVEL - Static variable in enum com.github.aliteralmind.codelet.CodeletBaseConfig
-
Amount that information that should be logged in every taglet-call--Name is "global_debugging__off_12345".