C-Index (Codelet)

A B C D E F G H I J L M N O P R S T U V W Z

C

cclass(CodeletInstance, Class, Appendable) - Static method in class com.github.aliteralmind.codelet.alter.NewJavaDocLinkReplacerFor: Changes a class name to a JavaDoc link.
cclass(CodeletInstance, int, Class<?>, Appendable, Appendable) - Static method in class com.github.aliteralmind.codelet.alter.NewJDLinkForWordOccuranceNum: Replaces a single occurance of a class name with a JavaDoc link.
cclass(CodeletInstance, String, String, int, Class<?>) - Static method in class com.github.aliteralmind.codelet.alter.NewJDLinkForWordOccuranceNum: Create a class link replacer with named debuggers.
classNameOrFilePathRestricter(String) - Method in class com.github.aliteralmind.codelet.CustomizationInstructions: Wildcard search-term to restrict the classes or files that may utilize this customizer.
CODELET_CONFIG_DIR_SYS_PROP_NAME - Static variable in enum com.github.aliteralmind.codelet.CodeletBootstrap: The name of the system property that is passed into the javadoc application, whose value is the directory in which all Codelet configuration files are stored--Equal to "codelet_config_dir".
CODELET_RQD_NAMED_DBGRS_CONFIG_FILE - Static variable in enum com.github.aliteralmind.codelet.CodeletBootstrap: The name of the configuration file containing Codelet-required named debuggers--Equal to "named_debuggers_config_CODELET_RQD.txt".
CodeletAndOutTaglet - Class in com.github.aliteralmind.codelet.taglet: Inline JavaDoc taglet for displaying an the source code and console (System.out) output for a class (usually example code).
CodeletAndOutTaglet() - Constructor for class com.github.aliteralmind.codelet.taglet.CodeletAndOutTaglet
CodeletBaseConfig - Enum in com.github.aliteralmind.codelet: Immutable, static, and non-template related configuration, used throughout Codelet, as held in a file named codelet.properties.
CodeletBootstrap - Enum in com.github.aliteralmind.codelet: Initializes Codelet by loading all configuration--This is triggered by the first codelet-taglet encountered by javadoc.exe.
CodeletDotOutTaglet - Class in com.github.aliteralmind.codelet.taglet: Inline JavaDoc taglet for displaying the console (System.out) output for a class (usually example code).
CodeletDotOutTaglet() - Constructor for class com.github.aliteralmind.codelet.taglet.CodeletDotOutTaglet
CodeletFormatException - Exception in com.github.aliteralmind.codelet: Indicates the text in a codelet is invalid.
CodeletFormatException(CodeletInstance, String) - Constructor for exception com.github.aliteralmind.codelet.CodeletFormatException
CodeletFormatException(CodeletInstance) - Constructor for exception com.github.aliteralmind.codelet.CodeletFormatException
CodeletFormatException(CodeletInstance, String, Throwable) - Constructor for exception com.github.aliteralmind.codelet.CodeletFormatException
CodeletFormatException(CodeletInstance, Throwable) - Constructor for exception com.github.aliteralmind.codelet.CodeletFormatException
CodeletGap - Class in com.github.aliteralmind.codelet: A single gap in a Codelet template, including a function that fills it based on the Codelet instance and global configuration.
CodeletGap(String) - Constructor for class com.github.aliteralmind.codelet.CodeletGap: Create a new instance with a name.
CodeletInstance - Class in com.github.aliteralmind.codelet: Represents a single codelet-taglet, as found by javadoc.exe.
CodeletInstance(String, String, String, File, int, String, String) - Constructor for class com.github.aliteralmind.codelet.CodeletInstance: Create a new Codelet from its taglet elements.
CodeletTaglet - Class in com.github.aliteralmind.codelet.taglet: Inline JavaDoc taglet for displaying the source code of a class (usually example code).
CodeletTaglet() - Constructor for class com.github.aliteralmind.codelet.taglet.CodeletTaglet
CodeletTemplateBase - Class in com.github.aliteralmind.codelet: What the fully-processed output (source-code, console output, or plain-file text) is put into--The rendered template is what actually replaces the codelet-taglet.
CodeletTemplateBase(CodeletType, FeatherTemplate, String, String[], CodeletGap[], UserExtraGapGetter) - Constructor for class com.github.aliteralmind.codelet.CodeletTemplateBase: Create the first instance only.
CodeletTemplateBase(CodeletTemplateBase, FeatherTemplate, String) - Constructor for class com.github.aliteralmind.codelet.CodeletTemplateBase: Create the second or subsequent instance.
CodeletTemplateBase(CodeletTemplateBase, Appendable) - Constructor for class com.github.aliteralmind.codelet.CodeletTemplateBase: Create a new instance as a duplicate of another.
CodeletTemplateConfig - Enum in com.github.aliteralmind.codelet: Loads and manages default templates and user-extra gaps.
CodeletType - Enum in com.github.aliteralmind.codelet: The type of a single JavaDoc codelet instance.
CodletComSunJavadocTagProcessor - Enum in com.github.aliteralmind.codelet.taglet: The interface between Java com.sun.javadoc.* and com.github.aliteralmind.codelet.*.
com.github.aliteralmind.codelet - package com.github.aliteralmind.codelet: Main package.
com.github.aliteralmind.codelet.alter - package com.github.aliteralmind.codelet.alter: Classes related to the alteration-portion of a customizer function.
com.github.aliteralmind.codelet.examples - package com.github.aliteralmind.codelet.examples: Full examples used throughout Codelet.
com.github.aliteralmind.codelet.examples.adder - package com.github.aliteralmind.codelet.examples.adder: Trivial classes used in Codelet examples.
com.github.aliteralmind.codelet.examples.for_testing_only - package com.github.aliteralmind.codelet.examples.for_testing_only
com.github.aliteralmind.codelet.examples.non_xbn - package com.github.aliteralmind.codelet.examples.non_xbn: Example code demonstrating Codelet-like functionality, but that does not use any com.github.aliteralmind.codelet classes.
com.github.aliteralmind.codelet.examples.simplesig - package com.github.aliteralmind.codelet.examples.simplesig: Example code demonstrating the classes in com.github.aliteralmind.codelet.simplesig.
com.github.aliteralmind.codelet.examples.util - package com.github.aliteralmind.codelet.examples.util: Example code demonstrating the classes in com.github.aliteralmind.codelet.util.
com.github.aliteralmind.codelet.simplesig - package com.github.aliteralmind.codelet.simplesig: Generically-useful utilities for searching among methods with parameter wildcards, and for specifying and invoking "simplified" method signatures, which accept only primitives and non-null strings.
com.github.aliteralmind.codelet.taglet - package com.github.aliteralmind.codelet.taglet: The only part of Codelet that depends on com.sun.javadoc.
com.github.aliteralmind.codelet.type - package com.github.aliteralmind.codelet.type: Type-specific taglet-processors and templates.
com.github.aliteralmind.codelet.util - package com.github.aliteralmind.codelet.util: Generically-useful classes for blacklisting file names, accessing Java-related files given its base-directory and fully-qualified name, and JavaDoc related utilities.
compareTo(SimpleParamNameSignature) - Method in class com.github.aliteralmind.codelet.simplesig.SimpleParamNameSignature
ComSunJavaDocUtil - Class in com.github.aliteralmind.codelet.taglet: Generically-useful utilities related to com.sun.javadoc.
ComSunJavaDocUtil() - Constructor for class com.github.aliteralmind.codelet.taglet.ComSunJavaDocUtil
ConsoleOutProcessor - Class in com.github.aliteralmind.codelet.type: Reads a {@.codelet.out} taglet and outputs its replacement text.
ConsoleOutProcessor(CodeletInstance) - Constructor for class com.github.aliteralmind.codelet.type.ConsoleOutProcessor: Create a new instance from an CodeletInstance.
ConsoleOutTemplate - Class in com.github.aliteralmind.codelet.type: The text into which {@.codelet} output (the example-code's source) is placed.
ConsoleOutTemplate(FeatherTemplate, String, UserExtraGapGetter) - Constructor for class com.github.aliteralmind.codelet.type.ConsoleOutTemplate: Create the first instance.
ConsoleOutTemplate(ConsoleOutTemplate, FeatherTemplate, String) - Constructor for class com.github.aliteralmind.codelet.type.ConsoleOutTemplate: Create the second or subsequent instance.
ConsoleOutTemplate(ConsoleOutTemplate, Appendable) - Constructor for class com.github.aliteralmind.codelet.type.ConsoleOutTemplate
constructor(CodeletInstance, Constructor<?>, Appendable) - Static method in class com.github.aliteralmind.codelet.alter.NewJavaDocLinkReplacerFor: Changes a constructor name to a JavaDoc link.
constructor(CodeletInstance, int, Class<?>, String, Appendable, Appendable, Appendable, Appendable) - Static method in class com.github.aliteralmind.codelet.alter.NewJDLinkForWordOccuranceNum: Replaces a single occurance of a constructor name with a JavaDoc link.
constructor(CodeletInstance, String, String, int, Class<?>, String) - Static method in class com.github.aliteralmind.codelet.alter.NewJDLinkForWordOccuranceNum: Create a constructor link replacer with named debuggers.
ConstructorParamSearchTerm - Class in com.github.aliteralmind.codelet.simplesig: For matching one or more ConstructorSimpleParamSig.
ConstructorParamSearchTerm(String, Appendable, Appendable) - Constructor for class com.github.aliteralmind.codelet.simplesig.ConstructorParamSearchTerm: Create a new instance.
ConstructorParamSearchTermXmpl - Class in com.github.aliteralmind.codelet.examples.simplesig: Demonstration of ConstructorParamSearchTerm.
ConstructorParamSearchTermXmpl(int) - Constructor for class com.github.aliteralmind.codelet.examples.simplesig.ConstructorParamSearchTermXmpl
ConstructorParamSearchTermXmpl(boolean) - Constructor for class com.github.aliteralmind.codelet.examples.simplesig.ConstructorParamSearchTermXmpl
ConstructorSimpleParamSig - Class in com.github.aliteralmind.codelet.simplesig: Simple-parameter-name signature for a constructor.
ConstructorSimpleParamSig(Constructor<?>) - Constructor for class com.github.aliteralmind.codelet.simplesig.ConstructorSimpleParamSig: Create a new instance from a constructor.
crashIfClassOrFileCannotUseCustomizer(CustomizationInstructions<T>) - Method in class com.github.aliteralmind.codelet.TagletOfTypeProcessor: If the class or file is not allowed to use the customizer, crash.
crashIfForbiddenValue(CodeletType, String, Object) - Method in enum com.github.aliteralmind.codelet.CodeletType: If an CodeletType is a forbidden value, crash.
CrashIfMoreThanOne - Enum in com.github.aliteralmind.codelet.simplesig: If more than one match, crash?.
crashIfNotRequiredValue(CodeletType, String, Object) - Method in enum com.github.aliteralmind.codelet.CodeletType: If an CodeletType is not a required value, crash.
CrashIfZero - Enum in com.github.aliteralmind.codelet.simplesig: If zero matches, crash?.
CustomizationInstructions<T extends CodeletTemplateBase> - Class in com.github.aliteralmind.codelet: The instructions returned by a Codelet Customizer, which is used by the taglet-processor to modify its output.
CustomizationInstructions(CodeletInstance, CodeletType) - Constructor for class com.github.aliteralmind.codelet.CustomizationInstructions: Create a new instance.
CUSTOMIZER_PREFIX_CHAR - Static variable in class com.github.aliteralmind.codelet.CodeletInstance: The character that divides the fully-qualified class-name or plain-text file-path, and its optional Codelet-customizer--Equal to '%'.

A B C D E F G H I J L M N O P R S T U V W Z