A B C D E F G H I K L M N P Q R S T U V W

A

AbstractConfiguration - Class in net.sourceforge.taglets.simple.configuration

Abstract implementation of a configuration that supports a parent configuration.

AbstractConfiguration(Configuration) - Constructor for class net.sourceforge.taglets.simple.configuration.AbstractConfiguration

Creates a new abstract configuration with the specified parent configuration.

AbstractSimpleTaglet - Class in net.sourceforge.taglets.simple.impl

Abstract base class for all simple taglets.

AbstractSimpleTaglet(String) - Constructor for class net.sourceforge.taglets.simple.impl.AbstractSimpleTaglet

Creates a new abstract SimpleTaglet with the specified name.

AbstractTextFilter - Class in net.sourceforge.taglets.simple.filter

Abstract base class for all text filters.

AbstractTextFilter(String) - Constructor for class net.sourceforge.taglets.simple.filter.AbstractTextFilter

Creates a new abstract text filter with the specified name.

accept(File) - Method in class net.sourceforge.taglets.simple.shutdown.WildcardFileFilter

Accepts files matching the file pattern specified at construction time.

addURL(Logger, File, List) - Method in class net.sourceforge.taglets.simple.shutdown.FileCopier

Adds the URL of the specified file to the given list.

B

BlockTaglet - Interface in net.sourceforge.taglets.simple

Interface for "simple" block taglets.

C

canonicalPath(File) - Method in class net.sourceforge.taglets.simple.shutdown.WildcardFileFilter

Returns the canonical path of the specified file.

CELL_DELIMITER - Static variable in class net.sourceforge.taglets.simple.inline.TableInlineTaglet

The delimiter for cells.

ClassNameInlineTaglet - Class in net.sourceforge.taglets.simple.inline

Simple inline taglet that creates either the simple class name or the fully qualified class name of the current element.

ClassNameInlineTaglet(String) - Constructor for class net.sourceforge.taglets.simple.inline.ClassNameInlineTaglet

Creates a new InlineTaglet that creates either the simple class name or the fully qualified class name of the current element.

combineKeys(String[], String[]) - Static method in class net.sourceforge.taglets.simple.configuration.KeyUtilities

Combines two sets of keys, filtering out duplicate entries.

Configuration - Interface in net.sourceforge.taglets.simple

Taglets configuration interface.

configure(Logger, Configuration) - Method in class net.sourceforge.taglets.simple.block.ConstantsBlockTaglet

Configures the constant taglet and determines if constant field values are automatically included.

configure(Logger, Configuration) - Method in class net.sourceforge.taglets.simple.block.DefinitionListBlockTaglet

Configures this definition list block taglet.

configure(Logger, Configuration) - Method in class net.sourceforge.taglets.simple.block.ParamBlockTaglet

configure(Logger, Configuration) - Method in class net.sourceforge.taglets.simple.block.SinceBlockTaglet

Configures the since taglet and determines if declaration of since tags is mandatory.

configure(Logger, Configuration) - Method in class net.sourceforge.taglets.simple.filter.AbstractTextFilter

configure(Logger, Configuration) - Method in class net.sourceforge.taglets.simple.filter.LiteralTextFilter

configure(Logger, Configuration) - Method in class net.sourceforge.taglets.simple.filter.ParamTextFilter

configure(Logger, Configuration) - Method in class net.sourceforge.taglets.simple.filter.PreformattedTextFilter

configure(Logger, Configuration) - Method in class net.sourceforge.taglets.simple.filter.RegexParamTextFilter

configure(Logger, Configuration) - Method in class net.sourceforge.taglets.simple.filter.RegexTextFilter

configure(Logger, Configuration) - Method in interface net.sourceforge.taglets.simple.filter.TextFilter

Configures this filter according to the configuration object passed in.

configure(Logger, Configuration) - Method in class net.sourceforge.taglets.simple.impl.AbstractSimpleTaglet

configure(Logger, Configuration) - Method in class net.sourceforge.taglets.simple.impl.TextFilterTaglet

configure(Logger, Configuration) - Method in class net.sourceforge.taglets.simple.inline.TableInlineTaglet

Configures the table taglet and determines the table class to use.

configure(Logger, Configuration) - Method in class net.sourceforge.taglets.simple.shutdown.FileCopier

configure(Logger, Configuration) - Method in class net.sourceforge.taglets.simple.shutdown.RegexReplacer

configure(Logger, Configuration) - Method in interface net.sourceforge.taglets.simple.SimpleTaglet

Configures this "simple" taglet.

ConstantsBlockTaglet - Class in net.sourceforge.taglets.simple.block

Taglet that automatically inserts constant values.

ConstantsBlockTaglet(String) - Constructor for class net.sourceforge.taglets.simple.block.ConstantsBlockTaglet

Creates a new constant taglet that automatically inserts constant values.

containsParams(String) - Method in class net.sourceforge.taglets.simple.filter.ParamTextFilter

Checks if there is a parameter in format ${param} contained in the specified text.

copy(InputStream, OutputStream) - Static method in class net.sourceforge.taglets.simple.impl.Streams

Copies all data from the specified input to the given output stream.

copy(InputStream, OutputStream, int) - Static method in class net.sourceforge.taglets.simple.impl.Streams

Copies all data from the specified input to the given output stream.

copyURL(Logger, URL, File) - Method in class net.sourceforge.taglets.simple.shutdown.FileCopier

Copies the data of the specified URL as a file with the URL name to the destination directory.

createMatchDirectories(Pattern) - Method in class net.sourceforge.taglets.simple.shutdown.WildcardFileFilter

Check if directories should be matched by this pattern or not.

createParam(String) - Method in class net.sourceforge.taglets.simple.filter.ParamTextFilter

Creates a parameter object for the specified string parameter.

createPattern(String) - Method in class net.sourceforge.taglets.simple.shutdown.WildcardFileFilter

Creates a regular expression pattern from the specified file pattern.

D

debug(String) - Method in class net.sourceforge.taglets.simple.impl.TextFilterLogger

debug(String) - Method in interface net.sourceforge.taglets.simple.Logger

Logs the specified debugging message.

DEFAULT_CLASS - Static variable in class net.sourceforge.taglets.simple.inline.TableInlineTaglet

Default table class.

DefaultDocletParameter - Class in net.sourceforge.taglets.simple.impl

Default DocletParameter implementation.

DefaultDocletParameter(String, String, File, int, String, Doc) - Constructor for class net.sourceforge.taglets.simple.impl.DefaultDocletParameter

Creates a new default doclet parameter.

DefinitionListBlockTaglet - Class in net.sourceforge.taglets.simple.block

Block taglet that outputs its texts in form of a definition list.

DefinitionListBlockTaglet(String) - Constructor for class net.sourceforge.taglets.simple.block.DefinitionListBlockTaglet

Creates a new definition list BlockTaglet.

DefinitionListBlockTaglet(String, TextFilter) - Constructor for class net.sourceforge.taglets.simple.block.DefinitionListBlockTaglet

Creates a new definition list BlockTaglet.

DL_CSS_CLASS_KEY - Static variable in class net.sourceforge.taglets.simple.block.DefinitionListBlockTaglet

The key used to retrieve the CSS class used in the output.

DocletParameter - Interface in net.sourceforge.taglets.simple

Extended parameter object for SimpleTaglets.

E

encode(String) - Method in class net.sourceforge.taglets.simple.filter.LiteralTextFilter

Encodes the specified input string and writes the result to the string buffer specified.

endIndex(String, int) - Method in class net.sourceforge.taglets.simple.filter.ParamTextFilter

Retrieves the index of the ParamTextFilter.PARAM_END.

error(String) - Method in class net.sourceforge.taglets.simple.impl.TextFilterLogger

error(String) - Method in interface net.sourceforge.taglets.simple.Logger

Logs the specified error message.

escapeMessageFormat(String) - Method in class net.sourceforge.taglets.simple.filter.ParamTextFilter

Escapes the specified text so that it can be used as input value to the MessageFormat processor.

F

FileCopier - Class in net.sourceforge.taglets.simple.shutdown

FileCopier(String) - Constructor for class net.sourceforge.taglets.simple.shutdown.FileCopier

Creates a new file copier with the specified name.

filter(Logger, String[]) - Method in class net.sourceforge.taglets.simple.block.TextFilterBlockTaglet

Applies the filter method of the filter specified at construction time to each text in the input array.

filter(Logger, String) - Method in class net.sourceforge.taglets.simple.filter.AbstractTextFilter

filter(Logger, String) - Method in class net.sourceforge.taglets.simple.filter.IdentityTextFilter

filter(Logger, String) - Method in class net.sourceforge.taglets.simple.filter.LiteralTextFilter

filter(Logger, String) - Method in class net.sourceforge.taglets.simple.filter.ParamTextFilter

filter(Logger, String) - Method in class net.sourceforge.taglets.simple.filter.PreformattedTextFilter

filter(Logger, String) - Method in class net.sourceforge.taglets.simple.filter.RegexTextFilter

filter(Logger, String) - Method in interface net.sourceforge.taglets.simple.filter.TextFilter

Filters the specified input text.

filter(Logger, String) - Method in class net.sourceforge.taglets.simple.impl.TextFilterTaglet

Filters the specified input text using the text filter specified at construction time.

G

getAbsolutePath(String) - Method in class net.sourceforge.taglets.simple.shutdown.FileCopier

Returns the absolute path name of a file for lookup on the classpath.

getBoolean(String, boolean) - Method in class net.sourceforge.taglets.simple.configuration.AbstractConfiguration

getBoolean(String, boolean) - Method in interface net.sourceforge.taglets.simple.Configuration

Retrieves a boolean value for the specified key.

getBoolean(String, boolean) - Method in class net.sourceforge.taglets.simple.configuration.KeyPrefixConfiguration

getBoolean(String, boolean) - Method in class net.sourceforge.taglets.simple.configuration.MultiplexingConfiguration

getClassDoc(Parameter) - Method in class net.sourceforge.taglets.simple.inline.ClassNameInlineTaglet

Returns the ClassDoc of the tag holder of the specified parameter.

getClassName(Logger, Parameter, boolean) - Method in class net.sourceforge.taglets.simple.inline.ClassNameInlineTaglet

Returns the class name of the class (or the containing class for arbitrary program elements) currently processed.

getConfiguration(String) - Method in class net.sourceforge.taglets.simple.configuration.MultiplexingConfiguration

Retrieves the configuration that can handle the specified key.

getCssClass() - Method in class net.sourceforge.taglets.simple.block.DefinitionListBlockTaglet

Returns the CSS class of the definition list.

getCssClass() - Method in class net.sourceforge.taglets.simple.block.ParamBlockTaglet

Returns the CSS class of the definition list.

getDestinationDir(File, String) - Method in class net.sourceforge.taglets.simple.shutdown.FileCopier

Returns the destination directory to copy files to.

getDestinationDirectory() - Method in class net.sourceforge.taglets.simple.impl.DefaultDocletParameter

getDestinationDirectory() - Method in interface net.sourceforge.taglets.simple.Parameter

Returns the path of the JavaDoc destination directory.

getDocRoot() - Method in class net.sourceforge.taglets.simple.impl.DefaultDocletParameter

getDocRoot() - Method in interface net.sourceforge.taglets.simple.Parameter

Returns the relative path to the documentation root.

getDocRoot(File, File) - Method in class net.sourceforge.taglets.simple.shutdown.RegexReplacer

Calculates the documentation root directory for the specified file and root directory.

getFileURLs(Logger, String[], File) - Method in class net.sourceforge.taglets.simple.shutdown.FileCopier

Returns an array of URLs for the specified file names.

getHeader() - Method in class net.sourceforge.taglets.simple.block.DefinitionListBlockTaglet

Returns the definition list header.

getHeader() - Method in class net.sourceforge.taglets.simple.block.ParamBlockTaglet

Returns the definition list header.

getMaster() - Method in class net.sourceforge.taglets.simple.configuration.MultiplexingConfiguration

Returns the master configuration bound to this multiplexer.

getName() - Method in class net.sourceforge.taglets.simple.filter.AbstractTextFilter

getName() - Method in interface net.sourceforge.taglets.simple.filter.TextFilter

Returns the name of this filter.

getName() - Method in class net.sourceforge.taglets.simple.impl.AbstractSimpleTaglet

getName() - Method in interface net.sourceforge.taglets.simple.SimpleTaglet

Returns the name of the "simple" taglet.

getOutput(Logger, Parameter, String[]) - Method in class net.sourceforge.taglets.simple.block.DefinitionListBlockTaglet

getOutput(Logger, Parameter, String[]) - Method in class net.sourceforge.taglets.simple.block.IgnoreBlockTaglet

getOutput(Logger, Parameter, String[]) - Method in class net.sourceforge.taglets.simple.block.ParamBlockTaglet

getOutput(Logger, Parameter, String[]) - Method in class net.sourceforge.taglets.simple.block.TextFilterBlockTaglet

getOutput(Logger, Parameter, String[]) - Method in interface net.sourceforge.taglets.simple.BlockTaglet

Returns the output for the specified input texts.

getOutput(Logger, Parameter, String) - Method in class net.sourceforge.taglets.simple.inline.ClassNameInlineTaglet

getOutput(Logger, Parameter, String) - Method in class net.sourceforge.taglets.simple.inline.IgnoreInlineTaglet

getOutput(Logger, Parameter, String) - Method in class net.sourceforge.taglets.simple.inline.TableInlineTaglet

Returns the output for the specified input text.

getOutput(Logger, Parameter, String) - Method in class net.sourceforge.taglets.simple.inline.TextFilterInlineTaglet

Returns the output for the specified input text.

getOutput(Logger, Parameter, String) - Method in interface net.sourceforge.taglets.simple.InlineTaglet

Returns the output for the specified input text.

getQualifiedName() - Method in class net.sourceforge.taglets.simple.impl.DefaultDocletParameter

getQualifiedName() - Method in interface net.sourceforge.taglets.simple.Parameter

The qualified name of the currently parsed program element.

getSlave() - Method in class net.sourceforge.taglets.simple.configuration.MultiplexingConfiguration

Returns the slave configuration bound to this multiplexer.

getSourceFile() - Method in class net.sourceforge.taglets.simple.impl.DefaultDocletParameter

getSourceFile() - Method in interface net.sourceforge.taglets.simple.Parameter

Returns the source file currently parsed.

getSourceLine() - Method in class net.sourceforge.taglets.simple.impl.DefaultDocletParameter

getSourceLine() - Method in interface net.sourceforge.taglets.simple.Parameter

Returns the line in the source file currently parsed.

getString(String, String) - Method in class net.sourceforge.taglets.simple.configuration.AbstractConfiguration

getString(String, String) - Method in interface net.sourceforge.taglets.simple.Configuration

Retrieves a String value for the specified key.

getString(String, String) - Method in class net.sourceforge.taglets.simple.configuration.KeyPrefixConfiguration

getString(String, String) - Method in class net.sourceforge.taglets.simple.configuration.MultiplexingConfiguration

getString(String, String) - Method in class net.sourceforge.taglets.simple.configuration.PropertiesConfiguration

getString(String, String) - Method in class net.sourceforge.taglets.simple.configuration.SystemPropertyConfiguration

getStringList(String, String[]) - Method in class net.sourceforge.taglets.simple.configuration.AbstractConfiguration

getStringList(String, String[]) - Method in interface net.sourceforge.taglets.simple.Configuration

Retrieves a an array of Strings for the specified key.

getStringList(String, String[]) - Method in class net.sourceforge.taglets.simple.configuration.KeyPrefixConfiguration

getStringList(String, String[]) - Method in class net.sourceforge.taglets.simple.configuration.MultiplexingConfiguration

getTableData(String) - Method in class net.sourceforge.taglets.simple.inline.TableInlineTaglet

Strips the options from the specified table tag content.

getTableOutput(Logger, Parameter, String) - Method in class net.sourceforge.taglets.simple.inline.TableInlineTaglet

Returns the table output for the specified input text.

getTagHolder() - Method in interface net.sourceforge.taglets.simple.DocletParameter

Returns the JavaDoc doclet tag holder for the currently processed tag.

getTagHolder() - Method in class net.sourceforge.taglets.simple.impl.DefaultDocletParameter

H

hasFill(String) - Method in class net.sourceforge.taglets.simple.inline.TableInlineTaglet

Check if the table stretches the whole document width.

hasHeader(String) - Method in class net.sourceforge.taglets.simple.inline.TableInlineTaglet

Check if the first row denotes a header.

hasNewTag(Doc) - Method in class net.sourceforge.taglets.simple.block.SinceBlockTaglet

Tests if the specified tag holder has a new tag.

hasValue(String) - Method in class net.sourceforge.taglets.simple.configuration.AbstractConfiguration

hasValue(String) - Method in interface net.sourceforge.taglets.simple.Configuration

Check if the configuration supports the specified key.

hasValue(String) - Method in class net.sourceforge.taglets.simple.configuration.KeyPrefixConfiguration

hasValue(String) - Method in class net.sourceforge.taglets.simple.configuration.MultiplexingConfiguration

hasValue(String) - Method in class net.sourceforge.taglets.simple.configuration.PropertiesConfiguration

hasValue(String) - Method in class net.sourceforge.taglets.simple.configuration.SystemPropertyConfiguration

I

IdentityTextFilter - Class in net.sourceforge.taglets.simple.filter

Text filter that simply returns the input values.

IdentityTextFilter() - Constructor for class net.sourceforge.taglets.simple.filter.IdentityTextFilter

Creates a new identity text filter.

IgnoreBlockTaglet - Class in net.sourceforge.taglets.simple.block

Taglet that completely discards the text of a block tag.

IgnoreBlockTaglet(String) - Constructor for class net.sourceforge.taglets.simple.block.IgnoreBlockTaglet

Creates a new BlockTaglet that ignores its text.

IgnoreInlineTaglet - Class in net.sourceforge.taglets.simple.inline

Taglet that completely discards the text of an inline tag.

IgnoreInlineTaglet(String) - Constructor for class net.sourceforge.taglets.simple.inline.IgnoreInlineTaglet

Creates a new InlineTaglet that ignores its text.

info(String) - Method in class net.sourceforge.taglets.simple.impl.TextFilterLogger

info(String) - Method in interface net.sourceforge.taglets.simple.Logger

Logs the specified information message.

initialize(String, String, boolean) - Method in class net.sourceforge.taglets.simple.block.DefinitionListBlockTaglet

Sets the CSS stylesheet class of the definition list as well as the header to use.

initialize(String, String, boolean) - Method in class net.sourceforge.taglets.simple.block.ParamBlockTaglet

Sets the CSS stylesheet class of the definition list as well as the header to use.

initialize(String, String) - Method in class net.sourceforge.taglets.simple.filter.RegexTextFilter

Initializes the regular expression pattern and replacement to use.

InlineTaglet - Interface in net.sourceforge.taglets.simple

Interface for "simple" inline taglets.

isDefaultConstructor(Doc) - Method in class net.sourceforge.taglets.simple.block.SinceBlockTaglet

Check if the specified tag holder denotes a default constructor.

isEmpty() - Method in class net.sourceforge.taglets.simple.filter.ParamTextFilter.Param

Checks if the replacement value is either null or the empty string.

isInitialized() - Method in class net.sourceforge.taglets.simple.filter.AbstractTextFilter

isInitialized() - Method in class net.sourceforge.taglets.simple.filter.ParamTextFilter

isInitialized() - Method in class net.sourceforge.taglets.simple.filter.RegexParamTextFilter

isInitialized() - Method in class net.sourceforge.taglets.simple.filter.RegexTextFilter

Check if the regular expression pattern and replacement replacement have been initialized.

isInitialized() - Method in interface net.sourceforge.taglets.simple.filter.TextFilter

Check if the filter has been properly initialized.

K

KEY_CLASS - Static variable in class net.sourceforge.taglets.simple.inline.TableInlineTaglet

Configuration key used to determine the table class.

KeyPrefixConfiguration - Class in net.sourceforge.taglets.simple.configuration

Configuration that delegates to another configuration by prefixing all keys with a well-defined prefix value.

KeyPrefixConfiguration(Configuration, String) - Constructor for class net.sourceforge.taglets.simple.configuration.KeyPrefixConfiguration

Creates a new KeyPrefixConfiguration.

KeyUtilities - Class in net.sourceforge.taglets.simple.configuration

Utility methods around key listing.

L

list(List, File, FileFilter) - Static method in class net.sourceforge.taglets.simple.shutdown.WildcardFileFilter

Appends all files contained at the specified file, matching the given filter to the result list.

list(File, String) - Static method in class net.sourceforge.taglets.simple.shutdown.WildcardFileFilter

Creates a file listing of all files matching the given file pattern.

listKeys(String) - Method in class net.sourceforge.taglets.simple.configuration.AbstractConfiguration

listKeys(String) - Method in class net.sourceforge.taglets.simple.configuration.KeyPrefixConfiguration

listKeys(String, Properties, String[]) - Static method in class net.sourceforge.taglets.simple.configuration.KeyUtilities

Returns a list of keys that match the specified prefix in the given properties object.

listKeys(String, Properties) - Static method in class net.sourceforge.taglets.simple.configuration.KeyUtilities

Returns a list of keys that match the specified prefix in the given properties object.

listKeys(String) - Method in interface net.sourceforge.taglets.simple.Configuration

Lists all configuration keys with the specified prefix.

listKeys(String) - Method in class net.sourceforge.taglets.simple.configuration.MultiplexingConfiguration

listKeys(String) - Method in class net.sourceforge.taglets.simple.configuration.PropertiesConfiguration

listKeys(String) - Method in class net.sourceforge.taglets.simple.configuration.SystemPropertyConfiguration

LITERAL_KEY - Static variable in class net.sourceforge.taglets.simple.filter.LiteralTextFilter

Parameter key for literal output filtering.

LiteralTextFilter - Class in net.sourceforge.taglets.simple.filter

Text filter that is used for literal text output.

LiteralTextFilter() - Constructor for class net.sourceforge.taglets.simple.filter.LiteralTextFilter

Creates a new literal text filter.

LiteralTextFilter(boolean) - Constructor for class net.sourceforge.taglets.simple.filter.LiteralTextFilter

Creates a new literal text filter with a default name and a preconfigured literal setting.

LiteralTextFilter(String) - Constructor for class net.sourceforge.taglets.simple.filter.LiteralTextFilter

Creates a new literal text filter.

Logger - Interface in net.sourceforge.taglets.simple

Logging interface to emit debugging and information messages, as well as warnings and errors.

M

MANDATORY - Static variable in class net.sourceforge.taglets.simple.block.SinceBlockTaglet

Key used to determine if since tags are mandatory.

MultiplexingConfiguration - Class in net.sourceforge.taglets.simple.configuration

Configuration that multiplexes a master and a slave configuration.

MultiplexingConfiguration(Configuration, Configuration) - Constructor for class net.sourceforge.taglets.simple.configuration.MultiplexingConfiguration

Creates a new multiplexing configuration for the specified master and slave.

N

net.sourceforge.taglets.simple - package net.sourceforge.taglets.simple

Simple Taglets interfaces.

net.sourceforge.taglets.simple.block - package net.sourceforge.taglets.simple.block

Default block taglet implementations.

net.sourceforge.taglets.simple.configuration - package net.sourceforge.taglets.simple.configuration

Provides concrete configuration implementations.

net.sourceforge.taglets.simple.filter - package net.sourceforge.taglets.simple.filter

Generic text filter interfaces and implementations.

net.sourceforge.taglets.simple.impl - package net.sourceforge.taglets.simple.impl

Abstract base clases for Simple Taglet implementations.

net.sourceforge.taglets.simple.inline - package net.sourceforge.taglets.simple.inline

Default inline taglet implementations.

net.sourceforge.taglets.simple.shutdown - package net.sourceforge.taglets.simple.shutdown

Default implementations of Shutdown Taglets.

NEW_TAG - Static variable in class net.sourceforge.taglets.simple.block.SinceBlockTaglet

Tag used for program elements that have not yet been released.

NO_FILL - Static variable in class net.sourceforge.taglets.simple.inline.TableInlineTaglet

Constant for the "nofill" table option.

NO_HEADER - Static variable in class net.sourceforge.taglets.simple.inline.TableInlineTaglet

Constant for the "noheader" table option.

P

PARAM_END - Static variable in class net.sourceforge.taglets.simple.filter.ParamTextFilter

Suffix of all parameters.

PARAM_START - Static variable in class net.sourceforge.taglets.simple.filter.ParamTextFilter

Prefix for all parameters.

ParamBlockTaglet - Class in net.sourceforge.taglets.simple.block

Block taglet that outputs its texts in form of a definition list.

ParamBlockTaglet(String) - Constructor for class net.sourceforge.taglets.simple.block.ParamBlockTaglet

Creates a new definition list BlockTaglet.

ParamBlockTaglet(String, TextFilter) - Constructor for class net.sourceforge.taglets.simple.block.ParamBlockTaglet

Creates a new definition list BlockTaglet.

Parameter - Interface in net.sourceforge.taglets.simple

Parameter interface for SimpleTaglets.

ParamInlineTaglet - Class in net.sourceforge.taglets.simple.inline

Simple inline taglet with parameter expansion support.

ParamInlineTaglet(String) - Constructor for class net.sourceforge.taglets.simple.inline.ParamInlineTaglet

Creates a new inline taglet with parameter expansion support.

ParamInlineTaglet(String, TextFilter) - Constructor for class net.sourceforge.taglets.simple.inline.ParamInlineTaglet

Creates a new inline taglet with parameter expansion support that uses the specified text filter.

PARAMS_DOC_ROOT - Static variable in class net.sourceforge.taglets.simple.impl.TextFilterTaglet

Parameter name for the documentation root directory.

PARAMS_KEY_PREFIX - Static variable in class net.sourceforge.taglets.simple.filter.ParamTextFilter

Prefix for all parameter keys.

PARAMS_QUALIFIED_NAME - Static variable in class net.sourceforge.taglets.simple.impl.TextFilterTaglet

Parameter name for the qualified name.

PARAMS_SIMPLE_NAME - Static variable in class net.sourceforge.taglets.simple.impl.TextFilterTaglet

Parameter name for the simple name.

ParamTextFilter - Class in net.sourceforge.taglets.simple.filter

Message filter that substitutes parameters.

ParamTextFilter() - Constructor for class net.sourceforge.taglets.simple.filter.ParamTextFilter

Creates a new parameter text filter.

ParamTextFilter.DefaultParam - Class in net.sourceforge.taglets.simple.filter

Parameter that returns a default value if the parameter replacement value is empty.

ParamTextFilter.DefaultParam(String, String) - Constructor for class net.sourceforge.taglets.simple.filter.ParamTextFilter.DefaultParam

Creates a new default parameter with the specified value and default value.

ParamTextFilter.OptionalParam - Class in net.sourceforge.taglets.simple.filter

Parameter that returns an optional value if the replacement value is not empty.

ParamTextFilter.OptionalParam(String, String) - Constructor for class net.sourceforge.taglets.simple.filter.ParamTextFilter.OptionalParam

Creates a new optional parameter for the given replacement value and optional value.

ParamTextFilter.Param - Class in net.sourceforge.taglets.simple.filter

Parameter class that handles parameter replacement.

ParamTextFilter.Param(String) - Constructor for class net.sourceforge.taglets.simple.filter.ParamTextFilter.Param

Creates a new parameter with the specified replacement value.

paramValue(String) - Method in class net.sourceforge.taglets.simple.filter.ParamTextFilter

Returns the value of the specified parameter.

PREFORMATTED_KEY - Static variable in class net.sourceforge.taglets.simple.filter.PreformattedTextFilter

Parameter key for preformatted output filtering.

PreformattedTextFilter - Class in net.sourceforge.taglets.simple.filter

Text filter that is used for preformatted text output.

PreformattedTextFilter() - Constructor for class net.sourceforge.taglets.simple.filter.PreformattedTextFilter

Creates a new preformatted text filter.

PropertiesConfiguration - Class in net.sourceforge.taglets.simple.configuration

Configuration that is backed by a Properties object.

PropertiesConfiguration(Configuration, Properties) - Constructor for class net.sourceforge.taglets.simple.configuration.PropertiesConfiguration

Creates a new properties configuration for the specified parent configuration and Properties object.

Q

QUALIFIED_NAME - Static variable in class net.sourceforge.taglets.simple.inline.ClassNameInlineTaglet

Inline tag option to produce the fully qualified class name.

R

read(InputStream, int) - Static method in class net.sourceforge.taglets.simple.impl.Streams

Reads the data from the specified input stream and returns it in form of a byte array.

read(File, String) - Static method in class net.sourceforge.taglets.simple.impl.Streams

Reads the specified file to memory as a string in the specified encoding.

REGEX_META_CHARACTERS - Static variable in class net.sourceforge.taglets.simple.shutdown.WildcardFileFilter

A string containing all regular expression meta characters.

RegexBlockTaglet - Class in net.sourceforge.taglets.simple.block

Regular expression block taglet.

RegexBlockTaglet(String) - Constructor for class net.sourceforge.taglets.simple.block.RegexBlockTaglet

Creates a new regular expression BlockTaglet.

RegexInlineTaglet - Class in net.sourceforge.taglets.simple.inline

Regular expression inline taglet.

RegexInlineTaglet(String) - Constructor for class net.sourceforge.taglets.simple.inline.RegexInlineTaglet

Creates a new regular expression InlineTaglet.

RegexParamTextFilter - Class in net.sourceforge.taglets.simple.filter

Regular expression filter with parameter expansion.

RegexParamTextFilter() - Constructor for class net.sourceforge.taglets.simple.filter.RegexParamTextFilter

Creates a new regular expression parameter text filter.

RegexReplacer - Class in net.sourceforge.taglets.simple.shutdown

Performs regular expression replacements on a list of files.

RegexReplacer(String) - Constructor for class net.sourceforge.taglets.simple.shutdown.RegexReplacer

Creates a new regular expression replacer with the given name.

RegexTextFilter - Class in net.sourceforge.taglets.simple.filter

Text filter that uses a regular expression pattern and replacement pattern.

RegexTextFilter() - Constructor for class net.sourceforge.taglets.simple.filter.RegexTextFilter

Creates a new regular expression text filter.

RegexTextFilter(String) - Constructor for class net.sourceforge.taglets.simple.filter.RegexTextFilter

Creates a new regular expression text filter with the given name.

relativePath(File) - Method in class net.sourceforge.taglets.simple.shutdown.WildcardFileFilter

Returns the canonical path name of the specified file, relative to the root directory of this wildcard file filter.

replace(String) - Method in class net.sourceforge.taglets.simple.filter.PreformattedTextFilter

Removes the first leading space in all text lines of the specified text.

replace(Logger, Matcher, String) - Method in class net.sourceforge.taglets.simple.filter.RegexParamTextFilter

replace(Logger, Matcher, String) - Method in class net.sourceforge.taglets.simple.filter.RegexTextFilter

Replaces the results in the matcher according to the replacement string.

replace(Logger, File, String) - Method in class net.sourceforge.taglets.simple.shutdown.RegexReplacer

Replaces the all tokens in the file specified.

replaceParams(String) - Method in class net.sourceforge.taglets.simple.filter.ParamTextFilter

Replaces all parameters in the specified text.

ROW_DELIMITER - Static variable in class net.sourceforge.taglets.simple.inline.TableInlineTaglet

The delimiter for rows.

S

setLiteral(boolean) - Method in class net.sourceforge.taglets.simple.filter.LiteralTextFilter

Sets the literal mode of this text filter.

setParameters(Parameter) - Method in class net.sourceforge.taglets.simple.impl.TextFilterTaglet

Sets the default parameter usable by parameter filters.

shutdown(Logger, File) - Method in class net.sourceforge.taglets.simple.shutdown.FileCopier

shutdown(Logger, File) - Method in class net.sourceforge.taglets.simple.shutdown.RegexReplacer

shutdown(Logger, File) - Method in interface net.sourceforge.taglets.simple.ShutdownSupport

Called once all JavaDoc documentation has been generated.

ShutdownSupport - Interface in net.sourceforge.taglets.simple

Extended interface for SimpleTaglets.

SIMPLE_NAME - Static variable in class net.sourceforge.taglets.simple.inline.ClassNameInlineTaglet

Inline tag option to produce the simple class name.

SimpleRegexBlockTaglet - Class in net.sourceforge.taglets.simple.block

Simple regular expression block taglet.

SimpleRegexBlockTaglet(String) - Constructor for class net.sourceforge.taglets.simple.block.SimpleRegexBlockTaglet

Creates a new regular expression BlockTaglet.

SimpleTaglet - Interface in net.sourceforge.taglets.simple

Base interface for all "simple" taglets.

SinceBlockTaglet - Class in net.sourceforge.taglets.simple.block

Since taglet implementation.

SinceBlockTaglet(String) - Constructor for class net.sourceforge.taglets.simple.block.SinceBlockTaglet

Creates a new since taglet.

splitCells(String) - Method in class net.sourceforge.taglets.simple.inline.TableInlineTaglet

Splits the specified row into several cells.

splitRows(String) - Method in class net.sourceforge.taglets.simple.inline.TableInlineTaglet

Split the specified table tag content into rows.

Streams - Class in net.sourceforge.taglets.simple.impl

I/O Stream utilities.

SystemPropertyConfiguration - Class in net.sourceforge.taglets.simple.configuration

Configuration that looks up its value in the system properties.

SystemPropertyConfiguration(Configuration) - Constructor for class net.sourceforge.taglets.simple.configuration.SystemPropertyConfiguration

Creates a new system property configuration that uses the specified parent.

T

TableInlineTaglet - Class in net.sourceforge.taglets.simple.inline

Taglet to create tabular data.

TableInlineTaglet(String) - Constructor for class net.sourceforge.taglets.simple.inline.TableInlineTaglet

Creates a new taglet that formats tabular data.

TextFilter - Interface in net.sourceforge.taglets.simple.filter

Interface for text filters that can work on any taglets.

TextFilterBlockTaglet - Class in net.sourceforge.taglets.simple.block

Block taglet that uses a text filter to process the input texts.

TextFilterBlockTaglet(String, TextFilter) - Constructor for class net.sourceforge.taglets.simple.block.TextFilterBlockTaglet

Creates a new regular expression BlockTaglet.

TextFilterInlineTaglet - Class in net.sourceforge.taglets.simple.inline

Inline taglet that uses a text filter for formatting.

TextFilterInlineTaglet(String, TextFilter) - Constructor for class net.sourceforge.taglets.simple.inline.TextFilterInlineTaglet

Creates a new regular expression InlineTaglet.

TextFilterLogger - Class in net.sourceforge.taglets.simple.impl

Text filter initialization logger.

TextFilterLogger(Logger, SimpleTaglet) - Constructor for class net.sourceforge.taglets.simple.impl.TextFilterLogger

Creates a new text filter logger for the specified taglet.

TextFilterTaglet - Class in net.sourceforge.taglets.simple.impl

Abstract simple taglet that features regular expression replacement of the text to print.

TextFilterTaglet(String, TextFilter) - Constructor for class net.sourceforge.taglets.simple.impl.TextFilterTaglet

Creates a new taglet that uses a text filter to create its output.

U

undefinedTag(Logger, DocletParameter) - Method in class net.sourceforge.taglets.simple.block.ConstantsBlockTaglet

undefinedTag(Logger, DocletParameter) - Method in class net.sourceforge.taglets.simple.block.SinceBlockTaglet

undefinedTag(Logger, DocletParameter) - Method in interface net.sourceforge.taglets.simple.UndefinedTagSupport

Called whenever the currently processed documentation element does not define this tag.

UndefinedTagSupport - Interface in net.sourceforge.taglets.simple

Extended interface for BlockTaglets.

unescape(String) - Method in class net.sourceforge.taglets.simple.filter.ParamTextFilter

Removes backslash escape sequences from the specified text.

US_ASCII - Static variable in class net.sourceforge.taglets.simple.filter.LiteralTextFilter

Encoding bound for 7-bit US-ASCII.

V

value() - Method in class net.sourceforge.taglets.simple.filter.ParamTextFilter.DefaultParam

value() - Method in class net.sourceforge.taglets.simple.filter.ParamTextFilter.OptionalParam

value() - Method in class net.sourceforge.taglets.simple.filter.ParamTextFilter.Param

Returns the parameter replacement value.

W

warning(String) - Method in class net.sourceforge.taglets.simple.impl.TextFilterLogger

warning(String) - Method in interface net.sourceforge.taglets.simple.Logger

Logs the specified warning message.

WildcardFileFilter - Class in net.sourceforge.taglets.simple.shutdown

Wildcard file filter that operates relative to a root directory.

WildcardFileFilter(File, String) - Constructor for class net.sourceforge.taglets.simple.shutdown.WildcardFileFilter

Creates a new wildcard file filter for the specified root directory and file pattern.

write(String, File, String) - Static method in class net.sourceforge.taglets.simple.impl.Streams

Writes the specified data string to the given file.

A B C D E F G H I K L M N P Q R S T U V W