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

A

AbstractArgumentsInvocationHandler<T extends Options<?>> - Class in org.hyphenType.dynamicproxy
 
AbstractArgumentsInvocationHandler(OptionValues<T>, Class<? extends Options<?>>, Class<? extends StatusCode>, String[]) - Constructor for class org.hyphenType.dynamicproxy.AbstractArgumentsInvocationHandler
TODO Comment.
addBothUIInput(Object) - Method in class org.hyphenType.unittesting.UnitTestingUserInput
Adds an object to both text and graphical UI inputs.
addGraphicalUIInput(Object) - Method in class org.hyphenType.unittesting.UnitTestingUserInput
 
addTextUIInput(Object) - Method in class org.hyphenType.unittesting.UnitTestingUserInput
 
ALIAS_DECLARATION_PREFIX - Static variable in class org.hyphenType.util.resourcebundles.AliasResourceBundle
 
AliasResourceBundle - Class in org.hyphenType.util.resourcebundles
 
alternatives - Variable in class org.hyphenType.datastructure.parser.option.StructureOption
 
ANNOTATION_SEPARATOR - Static variable in class org.hyphenType.util.DefaultAnnotation
 
annotationType() - Method in class org.hyphenType.util.DefaultAnnotation
 
ARGUMENT - Static variable in class org.hyphenType.wrapper.StandAloneAppWrapper
The especial argument that explicitly sets which is the main class.
arguments - Variable in class org.hyphenType.datastructure.parser.option.StructureOption
 
ArgumentsObject - Annotation Type in org.hyphenType.datastructure.annotations
 
ArgumentsProcessorEngine<U extends Annotation> - Interface in org.hyphenType.optionprocessors
A processor for arguments parsed.
arraySeparator - Variable in class org.hyphenType.datastructure.parser.option.StructureOptionValue
 
arrayUseFileSeparator - Variable in class org.hyphenType.datastructure.parser.option.StructureOptionValue
 

B

beforeExit(ExitStatusHelper) - Method in enum org.hyphenType.exit.CanonicalExitCode
 
beforeExit(ExitStatusHelper) - Method in interface org.hyphenType.exit.StatusCode
A call back method that is invoked by the method Options#exit(Enum) right before attempting to terminate the VM.
BooleanValidatorEngine - Class in org.hyphenType.optionprocessors.lib
Rules must be written in JavaScript and should refer to the names of the option methods.
BooleanValidatorEngine() - Constructor for class org.hyphenType.optionprocessors.lib.BooleanValidatorEngine
 
BooleanValidatorEngine.BooleanValidator - Annotation Type in org.hyphenType.optionprocessors.lib
 
BooleanValidatorEngine.Rule - Annotation Type in org.hyphenType.optionprocessors.lib
 
buildFormatter(Class<A>, Class<B>) - Static method in class org.hyphenType.documentation.DocumentationFormatterEngine
Builds a formatter based on the options interface and the formatter annotation.
buildInvocationHandler(OptionValues<T>, Class<? extends Options<?>>, Class<? extends StatusCode>, String[]) - Method in class org.hyphenType.optionsextractor.OptionsExtractor
Prepared to be replaced by a subclass.
buildInvocationHandler(OptionValues<T>, Class<? extends Options<?>>, Class<? extends StatusCode>, String[]) - Method in class org.hyphenType.unittesting.UnitTestingOptionExtractor
 
buildOptionsObject(Class<?>, String[]) - Method in class org.hyphenType.wrapper.StandAloneAppWrapper
Ready to be overridden in a subclass.

C

CanonicalExitCode - Enum in org.hyphenType.exit
The simplest status code one could possibly conceive.
compareTo(StructureOption) - Method in class org.hyphenType.datastructure.parser.option.StructureOption
 
compareTo(StructureArgument) - Method in class org.hyphenType.datastructure.parser.StructureArgument
 
ConcreteArgumentsInvocationHandler<T extends Options<?>> - Class in org.hyphenType.dynamicproxy
 
ConcreteArgumentsInvocationHandler(OptionValues<T>, Class<? extends Options<?>>, Class<? extends StatusCode>, String[]) - Constructor for class org.hyphenType.dynamicproxy.ConcreteArgumentsInvocationHandler
TODO Comment.
ConfigurableListResourceBundle - Class in org.hyphenType.util.resourcebundles
A simple list resource bundle whose content can be manipulated externally.
ConfigurableListResourceBundle(Object[][]) - Constructor for class org.hyphenType.util.resourcebundles.ConfigurableListResourceBundle
 
ConfigurableListResourceBundle(Map<?, ?>) - Constructor for class org.hyphenType.util.resourcebundles.ConfigurableListResourceBundle
 
consume() - Method in class org.hyphenType.lexerparser.LexTokenStream
 
convert(ResourceBundle) - Static method in class org.hyphenType.util.resourcebundles.AliasResourceBundle
Takes a resource bundle and creates a new one with the aliases replaced.
currentToken() - Method in class org.hyphenType.lexerparser.LexTokenStream
 
CustomizableValidatorEngine - Class in org.hyphenType.optionprocessors.lib
 
CustomizableValidatorEngine() - Constructor for class org.hyphenType.optionprocessors.lib.CustomizableValidatorEngine
 
CustomizableValidatorEngine.CustomizableValidator - Annotation Type in org.hyphenType.optionprocessors.lib
 
CustomizableValidatorEngine.Rule<T> - Interface in org.hyphenType.optionprocessors.lib
 

D

debugMode() - Static method in class org.hyphenType.debug.HTLogger
 
DEFAULT_DESCRIPTION_INDENT - Static variable in annotation type org.hyphenType.documentation.lib.StandardFormatterEngine.StandardFormatter
The default value of the property StandardFormatterEngine.StandardFormatter.descriptionIndent().
DEFAULT_DOUBLE_HYPHEN - Static variable in annotation type org.hyphenType.datastructure.annotations.ArgumentsObject
Default double hyphen.
DEFAULT_EQUALS - Static variable in annotation type org.hyphenType.datastructure.annotations.ArgumentsObject
Default equals string.
DEFAULT_MAX_COLUMN - Static variable in annotation type org.hyphenType.documentation.lib.StandardFormatterEngine.StandardFormatter
The default value of the property StandardFormatterEngine.StandardFormatter.maxColumn().
DEFAULT_PATTERN - Static variable in exception org.hyphenType.lexerparser.exceptions.MandatoryMapValueNotFoundException
 
DEFAULT_PATTERN - Static variable in exception org.hyphenType.lexerparser.exceptions.MandatorySimpleArgumentNotFoundException
 
DEFAULT_PATTERN - Static variable in exception org.hyphenType.lexerparser.exceptions.MandatoryValueNotFoundException
 
DEFAULT_PATTERN - Static variable in exception org.hyphenType.lexerparser.exceptions.RegexMismatchException
 
DEFAULT_PATTERN - Static variable in exception org.hyphenType.lexerparser.exceptions.StringParseException
 
DEFAULT_PATTERN - Static variable in exception org.hyphenType.lexerparser.exceptions.StringParsingErrorException
 
DEFAULT_RB_ENCODING - Static variable in annotation type org.hyphenType.datastructure.annotations.ArgumentsObject
Default encoding for the resource bundles.
DEFAULT_SINGLE_HYPHEN - Static variable in annotation type org.hyphenType.datastructure.annotations.ArgumentsObject
Default single hyphen.
DefaultAnnotation - Class in org.hyphenType.util
 
description - Variable in class org.hyphenType.datastructure.parser.option.StructureOption
 
Description - Annotation Type in org.hyphenType.documentation
Documents a property of a formatter annotation for developers.
DocumentationFormatterEngine<T extends Options<?>,V extends Annotation> - Class in org.hyphenType.documentation
 
DocumentationFormatterEngine() - Constructor for class org.hyphenType.documentation.DocumentationFormatterEngine
 

E

equals(Object) - Method in class org.hyphenType.datastructure.lexer.LexToken
 
equals(Object) - Method in class org.hyphenType.datastructure.parser.option.StructureOption
 
equals(Object) - Method in class org.hyphenType.datastructure.parser.simple.StructureSimpleArgument
 
equals(Object) - Method in class org.hyphenType.dynamicproxy.AbstractArgumentsInvocationHandler
 
equals(Object) - Method in class org.hyphenType.util.DefaultAnnotation
 
err() - Method in class org.hyphenType.unittesting.UnitTestingAppEngine
 
exit(T, Object...) - Method in interface org.hyphenType.datastructure.Options
Terminates the JVM or other current environment
exit(int, Object...) - Method in interface org.hyphenType.datastructure.Options
Terminates the JVM or other current environment
exit(Throwable) - Method in interface org.hyphenType.datastructure.Options
Terminates the JVM or other current environment.
exit(Enum<?>) - Method in class org.hyphenType.dynamicproxy.AbstractArgumentsInvocationHandler
TODO Comment.
exit(int) - Method in class org.hyphenType.dynamicproxy.AbstractArgumentsInvocationHandler
TODO Comment.
exit(Enum<?>) - Method in class org.hyphenType.dynamicproxy.ConcreteArgumentsInvocationHandler
TODO Comment.
exit(int) - Method in class org.hyphenType.dynamicproxy.ConcreteArgumentsInvocationHandler
TODO Comment.
exit(Enum<?>) - Method in class org.hyphenType.unittesting.MockArgumentsInvocationHandler
 
exit(int) - Method in class org.hyphenType.unittesting.MockArgumentsInvocationHandler
 
exitCallPoint() - Method in exception org.hyphenType.unittesting.NonExceptionalExit
 
exitCallPoint() - Method in class org.hyphenType.unittesting.UnitTestingAppEngine
Retrieves at which point the application under test called Options#exit(Enum) or Options#exit(int).
exitEnumCalled() - Method in class org.hyphenType.unittesting.MockArgumentsInvocationHandler
Useful to check whether the MockArgumentsInvocationHandler.exit(Enum) method was called or not.
exitEnumCalled() - Method in exception org.hyphenType.unittesting.NonExceptionalExit
 
exitEnumCalled() - Method in class org.hyphenType.unittesting.UnitTestingAppEngine
 
exitEnumCalled(T) - Method in class org.hyphenType.unittesting.UnitTestingOptionExtractor
Returns whether or not the method Options#exit(Enum) was called on the given options.
exitIntCalled() - Method in class org.hyphenType.unittesting.MockArgumentsInvocationHandler
Useful to check whether the MockArgumentsInvocationHandler.exit(int) method was called or not.
exitIntCalled() - Method in exception org.hyphenType.unittesting.NonExceptionalExit
 
exitIntCalled() - Method in class org.hyphenType.unittesting.UnitTestingAppEngine
 
exitIntCalled(T) - Method in class org.hyphenType.unittesting.UnitTestingOptionExtractor
Returns whether or not the method Options#exit(int) was called on the given options.
ExitMessageException - Exception in org.hyphenType.exit
The base exception that is trapped when a main class is executed and that can be used to find exit codes.
ExitMessageException(String...) - Constructor for exception org.hyphenType.exit.ExitMessageException
This constructor requires the caller to provide textual data that will be used to format error messages in exit status constants.
ExitStatusConstant - Annotation Type in org.hyphenType.exit
A message to decorate the exit status constants for the final users.
ExitStatusHelper - Class in org.hyphenType.exit
The object that is passed to the StatusCode.beforeExit(ExitStatusHelper) method.
ExitStatusHelper(Class<? extends Options<?>>, Enum<? extends StatusCode>, Throwable, Object...) - Constructor for class org.hyphenType.exit.ExitStatusHelper
Creates a helper containing the message extracted from the documentation formatter.
expandAnnotationArray(String, Annotation[], Class<?>) - Static method in class org.hyphenType.documentation.rbgenerator.RBGenerator
 

F

f() - Method in interface org.hyphenType.documentation.rbgenerator.RBGeneratorOptions
 
FIELD_SEPARATOR - Static variable in class org.hyphenType.util.DefaultAnnotation
 
fileName() - Method in interface org.hyphenType.documentation.rbgenerator.RBGeneratorOptions
 
fillWithResourceBundle(Annotation, ResourceBundle) - Static method in class org.hyphenType.util.DefaultAnnotation
 
formattedLocaleMessage(String, Object...) - Method in interface org.hyphenType.datastructure.Options
Equivalent to Options.localeMessage(String), but wraps a procedure that allows for replacement of variables within the messages.
formattedLocaleMessageDefault(String, String, Object...) - Method in interface org.hyphenType.datastructure.Options
Equivalent to Options.localeMessage(String), but wraps a procedure that allows for replacement of variables within the messages.
fromString(Class<? extends T>, String) - Static method in class org.hyphenType.util.soc.StringObjectConversion
Translates a string into an object.
fromString(Class<? extends T>, String, boolean) - Static method in class org.hyphenType.util.soc.StringObjectConversion
Translates a string into an object.
fromString(Class<? extends T>, String, boolean, String) - Static method in class org.hyphenType.util.soc.StringObjectConversion
Translates a string into an object.
fromString(Class<? extends T>, String, boolean, String, String, String) - Static method in class org.hyphenType.util.soc.StringObjectConversion
Translates a string into an object.
futureToken() - Method in class org.hyphenType.lexerparser.LexTokenStream
 

G

GenericEncodingControl - Class in org.hyphenType.util.resourcebundles
 
GenericEncodingControl(String) - Constructor for class org.hyphenType.util.resourcebundles.GenericEncodingControl
Creates a new control with the given encoding.
getAnnotation() - Method in class org.hyphenType.documentation.DocumentationFormatterEngine
 
getAnnotation(Class, Class<T>) - Static method in class org.hyphenType.util.DefaultAnnotation
 
getAnnotation(Method, Class<T>) - Static method in class org.hyphenType.util.DefaultAnnotation
 
getAnnotation(Field, Class<T>) - Static method in class org.hyphenType.util.DefaultAnnotation
 
getAnnotation(Enum<?>, Class<T>) - Static method in class org.hyphenType.util.DefaultAnnotation
 
getAnnotations(Class) - Static method in class org.hyphenType.util.DefaultAnnotation
 
getAnnotations(Method) - Static method in class org.hyphenType.util.DefaultAnnotation
 
getAnnotations(Field) - Static method in class org.hyphenType.util.DefaultAnnotation
 
getAnnotations(Enum<?>) - Static method in class org.hyphenType.util.DefaultAnnotation
 
getAnnotationWithDefaults(Class<? extends Annotation>) - Static method in class org.hyphenType.util.DefaultAnnotation
 
getArgsObject() - Method in class org.hyphenType.lexerparser.LexerParser
 
getArguments() - Method in exception org.hyphenType.exit.ExitMessageException
Arguments to format error messages.
getBasePrefix() - Method in class org.hyphenType.util.DefaultAnnotation
 
getChannels() - Method in class org.hyphenType.datastructure.parser.StructureArgument
 
getContents() - Method in class org.hyphenType.documentation.OptionListResourceBundle
 
getContents() - Method in class org.hyphenType.util.resourcebundles.ConfigurableListResourceBundle
 
getDescription() - Method in class org.hyphenType.datastructure.parser.StructureArgument
 
getIndex() - Method in class org.hyphenType.datastructure.parser.StructureArgument
 
getKeys() - Method in class org.hyphenType.util.I18NResourceBundle
 
getLocalizedMessage() - Method in exception org.hyphenType.lexerparser.exceptions.OptionValuesException
 
getMessage(String, String) - Method in class org.hyphenType.documentation.DocumentationFormatterEngine
 
getMessage() - Method in class org.hyphenType.exit.ExitStatusHelper
Gives access to the message associated with this exit status code.
getName() - Method in class org.hyphenType.datastructure.parser.StructureArgument
 
getOptionMapValue(StructureOptionMapValue) - Method in class org.hyphenType.lexerparser.OptionValues
 
getOptionsInterface() - Method in class org.hyphenType.lexerparser.LexerParser
 
getOptionsInterfaceValue(String, String) - Method in class org.hyphenType.documentation.DocumentationFormatterEngine
Retrieves messages from the resource bundles.
getOptionsInterfaceValue(String) - Method in class org.hyphenType.documentation.DocumentationFormatterEngine
Retrieves messages from the resource bundles.
getOptionValue(StructureOptionValue) - Method in class org.hyphenType.lexerparser.OptionValues
 
getParsedOptions() - Method in class org.hyphenType.lexerparser.LexerParser
 
getParsedOptionValue(StructureOption) - Method in class org.hyphenType.lexerparser.OptionValues
 
getRegex() - Method in class org.hyphenType.datastructure.parser.StructureArgument
 
getSimpleArguments() - Method in class org.hyphenType.lexerparser.LexerParser
 
getSimpleArgumentValue(StructureSimpleArgument) - Method in class org.hyphenType.lexerparser.OptionValues
 
getStatusCodeEnum() - Method in class org.hyphenType.unittesting.MockArgumentsInvocationHandler
Useful to analyze how the MockArgumentsInvocationHandler.exit(Enum) method was called.
getStatusCodeEnum() - Method in exception org.hyphenType.unittesting.NonExceptionalExit
 
getStatusCodeEnum() - Method in class org.hyphenType.unittesting.UnitTestingAppEngine
 
getStatusCodeEnum(T) - Method in class org.hyphenType.unittesting.UnitTestingOptionExtractor
Retrieves the status code of a certain options object.
getStatusCodeInt() - Method in class org.hyphenType.unittesting.MockArgumentsInvocationHandler
Useful to analyze how the MockArgumentsInvocationHandler.exit(int) method was called.
getStatusCodeInt() - Method in exception org.hyphenType.unittesting.NonExceptionalExit
 
getStatusCodeInt() - Method in class org.hyphenType.unittesting.UnitTestingAppEngine
 
getStatusCodeInt(T) - Method in class org.hyphenType.unittesting.UnitTestingOptionExtractor
Retrieves the status code (int) of a certain options object.
getStatusCodeUserDescription(Enum<?>) - Method in class org.hyphenType.documentation.DocumentationFormatterEngine
 
getThrowable() - Method in class org.hyphenType.exit.ExitStatusHelper
Gives access to the throwable responsible for this environment termination.
getValue(Method) - Method in class org.hyphenType.lexerparser.OptionValues
 

H

h() - Method in interface org.hyphenType.documentation.rbgenerator.RBGeneratorOptions
 
handleGetObject(String) - Method in class org.hyphenType.util.I18NResourceBundle
 
hasFutureToken() - Method in class org.hyphenType.lexerparser.LexTokenStream
 
hashCode() - Method in class org.hyphenType.datastructure.lexer.LexToken
 
hashCode() - Method in class org.hyphenType.datastructure.parser.option.StructureOption
 
hashCode() - Method in class org.hyphenType.datastructure.parser.simple.StructureSimpleArgument
 
hashCode() - Method in class org.hyphenType.dynamicproxy.AbstractArgumentsInvocationHandler
 
hashCode() - Method in class org.hyphenType.lexerparser.OptionValues
 
hashCode() - Method in class org.hyphenType.util.DefaultAnnotation
 
HTLogger - Class in org.hyphenType.debug
A logger that only outputs things to a PrintStream if the HTLogger.HYPHEN_TYPE_DEBUG_MODE environment variable is set to true (ignoring case).
HTLogger() - Constructor for class org.hyphenType.debug.HTLogger
 
HTMLFormatterEngine<T extends Options<?>> - Class in org.hyphenType.documentation.lib
A documentation formatter that generates HTML code as output.
HTMLFormatterEngine() - Constructor for class org.hyphenType.documentation.lib.HTMLFormatterEngine
 
HTMLFormatterEngine.HTMLFormatter - Annotation Type in org.hyphenType.documentation.lib
 
HYPHEN_TYPE_DEBUG_MODE - Static variable in class org.hyphenType.debug.HTLogger
System environment key to allow for users to change the debug mode when calling the JVM

I

I18NResourceBundle - Class in org.hyphenType.util
 
I18NResourceBundle(Class<? extends Options<?>>) - Constructor for class org.hyphenType.util.I18NResourceBundle
 
InputChannel - Enum in org.hyphenType.datastructure.annotations
 
InvalidOptionsInterfaceException - Exception in org.hyphenType.exceptions
TODO Create a complete description of all conditions in which an option interface can be invalid.
InvalidOptionsInterfaceException() - Constructor for exception org.hyphenType.exceptions.InvalidOptionsInterfaceException
 
InvalidOptionsInterfaceException(String, Throwable) - Constructor for exception org.hyphenType.exceptions.InvalidOptionsInterfaceException
 
InvalidOptionsInterfaceException(String) - Constructor for exception org.hyphenType.exceptions.InvalidOptionsInterfaceException
 
InvalidOptionsInterfaceException(Throwable) - Constructor for exception org.hyphenType.exceptions.InvalidOptionsInterfaceException
 
invoke(Object, Method, Object[]) - Method in class org.hyphenType.dynamicproxy.AbstractArgumentsInvocationHandler
 
invoke(Object, Method, Object[]) - Method in class org.hyphenType.util.DefaultAnnotation
 
invokeMain(Class<?>, String[]) - Method in class org.hyphenType.wrapper.StandAloneAppWrapper
Invokes the main method of the given class.
invokeMain(Class<?>, String[], boolean) - Method in class org.hyphenType.wrapper.StandAloneAppWrapper
Invokes the main method of the given class.
isDefaultAnnotation(Annotation) - Static method in class org.hyphenType.util.DefaultAnnotation
 
isGraphicalUIAvailable() - Method in class org.hyphenType.input.StandardUserInput
 
isGraphicalUIAvailable() - Method in class org.hyphenType.input.UserInput
 
isGraphicalUIAvailable() - Method in class org.hyphenType.unittesting.UnitTestingUserInput
 
isMandatory() - Method in class org.hyphenType.datastructure.parser.StructureArgument
 
isTextUIAvailable() - Method in class org.hyphenType.input.StandardUserInput
 
isTextUIAvailable() - Method in class org.hyphenType.input.UserInput
 
isTextUIAvailable() - Method in class org.hyphenType.unittesting.UnitTestingUserInput
 

K

KEY - Static variable in class org.hyphenType.wrapper.StandAloneAppWrapper
Manifest files can have a key value pair with this key to explicitly set which is the actual main class.
keyName - Variable in class org.hyphenType.datastructure.parser.option.StructureOptionMapValue
 

L

LexArgument - Class in org.hyphenType.datastructure.lexer.simple
 
LexArgument(String) - Constructor for class org.hyphenType.datastructure.lexer.simple.LexArgument
 
lexArguments(String...) - Method in class org.hyphenType.lexerparser.LexerParser
Classifies arguments and creates tokens based on it.
LexerParser<T extends Options<?>> - Class in org.hyphenType.lexerparser
A LexerParser is an object that can parse an array of strings and create a list of tokens from it.
LexerParser(Class<T>) - Constructor for class org.hyphenType.lexerparser.LexerParser
 
LexerParser(Class<T>, boolean) - Constructor for class org.hyphenType.lexerparser.LexerParser
 
LexOption - Class in org.hyphenType.datastructure.lexer.option
 
LexOption(String) - Constructor for class org.hyphenType.datastructure.lexer.option.LexOption
 
LexOptionMapValue - Class in org.hyphenType.datastructure.lexer.option
 
LexOptionMapValue(String) - Constructor for class org.hyphenType.datastructure.lexer.option.LexOptionMapValue
 
LexOptionValue - Class in org.hyphenType.datastructure.lexer.option
 
LexOptionValue(String) - Constructor for class org.hyphenType.datastructure.lexer.option.LexOptionValue
 
LexToken - Class in org.hyphenType.datastructure.lexer
 
LexToken(String) - Constructor for class org.hyphenType.datastructure.lexer.LexToken
 
LexTokenStream - Class in org.hyphenType.lexerparser
 
LexTokenStream(List<LexToken>) - Constructor for class org.hyphenType.lexerparser.LexTokenStream
 
localeMessage(String) - Method in interface org.hyphenType.datastructure.Options
Gets a message from the resource bundle of the current locale.
localeMessage(String, String) - Method in interface org.hyphenType.datastructure.Options
Gets a message from the resource bundle of the current locale.
log(String) - Static method in class org.hyphenType.debug.HTLogger
Logs a message to the PrintStream, if debug mode is true.
log(Throwable) - Static method in class org.hyphenType.debug.HTLogger
Logs the full stack trace of a throwable.

M

main(RBGeneratorOptions) - Method in class org.hyphenType.documentation.rbgenerator.RBGenerator
 
main(String...) - Static method in class org.hyphenType.wrapper.StandAloneAppWrapper
Standard main method.
main(Class<?>, String...) - Static method in class org.hyphenType.wrapper.StandAloneAppWrapper
A safer main method.
mainClassInvalid(String) - Static method in class org.hyphenType.wrapper.StandAloneAppWrapper
 
mandatory - Variable in class org.hyphenType.datastructure.parser.option.StructureOptionMapValue
 
mandatory - Variable in class org.hyphenType.datastructure.parser.option.StructureOptionValue
 
MandatoryMapValueNotFoundException - Exception in org.hyphenType.lexerparser.exceptions
 
MandatoryMapValueNotFoundException(Class<? extends Options<?>>, String, String, String, String) - Constructor for exception org.hyphenType.lexerparser.exceptions.MandatoryMapValueNotFoundException
 
MandatorySimpleArgumentNotFoundException - Exception in org.hyphenType.lexerparser.exceptions
 
MandatorySimpleArgumentNotFoundException(Throwable, Class<? extends Options<?>>, String) - Constructor for exception org.hyphenType.lexerparser.exceptions.MandatorySimpleArgumentNotFoundException
 
MandatoryValueNotFoundException - Exception in org.hyphenType.lexerparser.exceptions
 
MandatoryValueNotFoundException(Class<? extends Options<?>>, String, String) - Constructor for exception org.hyphenType.lexerparser.exceptions.MandatoryValueNotFoundException
 
map - Variable in class org.hyphenType.datastructure.parser.option.StructureOption
 
method - Variable in class org.hyphenType.datastructure.parser.StructureElement
 
METHOD_SEPARATOR - Static variable in class org.hyphenType.util.DefaultAnnotation
 
MockArgumentsInvocationHandler<T extends Options<?>> - Class in org.hyphenType.unittesting
A mock to replace ConcreteArgumentsInvocationHandler.
MockArgumentsInvocationHandler(OptionValues<T>, Class<? extends Options<?>>, Class<? extends StatusCode>, String[], boolean) - Constructor for class org.hyphenType.unittesting.MockArgumentsInvocationHandler
Sole constructor.

N

name - Variable in class org.hyphenType.datastructure.parser.option.StructureOptionValue
 
newBundle(String, Locale, String, ClassLoader, boolean) - Method in class org.hyphenType.util.resourcebundles.GenericEncodingControl
 
NonExceptionalExit - Exception in org.hyphenType.unittesting
A (strange) exception that is thrown to simulate JVM exit when we utilize MockArgumentsInvocationHandler.

O

Option - Annotation Type in org.hyphenType.datastructure.annotations
 
OptionArgument - Annotation Type in org.hyphenType.datastructure.annotations
 
OptionListResourceBundle - Class in org.hyphenType.documentation
 
OptionListResourceBundle(Class) - Constructor for class org.hyphenType.documentation.OptionListResourceBundle
 
OptionMapValue - Annotation Type in org.hyphenType.datastructure.annotations
 
Options<T extends Enum<?> & StatusCode> - Interface in org.hyphenType.datastructure
Interface that should be extended by all options interfaces.
options(String...) - Method in class org.hyphenType.optionsextractor.OptionsExtractor
 
options(UserInput, String...) - Method in class org.hyphenType.optionsextractor.OptionsExtractor
Factory method that creates an instance of the options interface specified in the constructor OptionsExtractor.OptionsExtractor(Class).
options() - Static method in class org.hyphenType.wrapper.StandAloneAppWrapper
Gives system-wide access to the options object.
optionsClass() - Method in interface org.hyphenType.documentation.rbgenerator.RBGeneratorOptions
 
OptionsExtractor<T extends Options<?>> - Class in org.hyphenType.optionsextractor
A factory for option objects, and the easiest way to get started with this tool.
OptionsExtractor(Class<T>) - Constructor for class org.hyphenType.optionsextractor.OptionsExtractor
Creates an OptionsExtractor object based on an options interface class.
OptionsExtractorException - Exception in org.hyphenType.optionsextractor
 
OptionValue - Annotation Type in org.hyphenType.datastructure.annotations
 
OptionValues<T extends Options<?>> - Class in org.hyphenType.lexerparser
Stores the values related to a data structure holding the structure of an options interface.
OptionValues(List<LexToken>, LexerParser<T>) - Constructor for class org.hyphenType.lexerparser.OptionValues
Although this constructor throws many exceptions, all exceptions extend OptionValuesException.
OptionValues(List<LexToken>, LexerParser<T>, UserInput) - Constructor for class org.hyphenType.lexerparser.OptionValues
Although this constructor throws many exceptions, all exceptions extend OptionValuesException.
OptionValuesException - Exception in org.hyphenType.lexerparser.exceptions
 
OptionValuesException(Class<? extends Options<?>>, String, Object...) - Constructor for exception org.hyphenType.lexerparser.exceptions.OptionValuesException
 
OptionValuesException(Throwable, Class<? extends Options<?>>, String, Object...) - Constructor for exception org.hyphenType.lexerparser.exceptions.OptionValuesException
 
org.hyphenType.datastructure - package org.hyphenType.datastructure
TODO Write.
org.hyphenType.datastructure.annotations - package org.hyphenType.datastructure.annotations
TODO Write.
org.hyphenType.datastructure.lexer - package org.hyphenType.datastructure.lexer
TODO Write.
org.hyphenType.datastructure.lexer.option - package org.hyphenType.datastructure.lexer.option
TODO Write.
org.hyphenType.datastructure.lexer.simple - package org.hyphenType.datastructure.lexer.simple
TODO Write.
org.hyphenType.datastructure.parser - package org.hyphenType.datastructure.parser
TODO Write.
org.hyphenType.datastructure.parser.option - package org.hyphenType.datastructure.parser.option
TODO Write.
org.hyphenType.datastructure.parser.simple - package org.hyphenType.datastructure.parser.simple
TODO Write.
org.hyphenType.debug - package org.hyphenType.debug
 
org.hyphenType.documentation - package org.hyphenType.documentation
TODO Write.
org.hyphenType.documentation.lib - package org.hyphenType.documentation.lib
TODO Write.
org.hyphenType.documentation.rbgenerator - package org.hyphenType.documentation.rbgenerator
TODO Write.
org.hyphenType.dynamicproxy - package org.hyphenType.dynamicproxy
TODO Write.
org.hyphenType.exceptions - package org.hyphenType.exceptions
TODO Write.
org.hyphenType.exit - package org.hyphenType.exit
TODO Write.
org.hyphenType.input - package org.hyphenType.input
TODO Write.
org.hyphenType.lexerparser - package org.hyphenType.lexerparser
TODO Write.
org.hyphenType.lexerparser.exceptions - package org.hyphenType.lexerparser.exceptions
 
org.hyphenType.optionprocessors - package org.hyphenType.optionprocessors
TODO Write.
org.hyphenType.optionprocessors.lib - package org.hyphenType.optionprocessors.lib
TODO Write.
org.hyphenType.optionsextractor - package org.hyphenType.optionsextractor
The Command Line Interface tool root package, which provides the OptionsExtractor class, the easiest class to start using the tool.
org.hyphenType.unittesting - package org.hyphenType.unittesting
TODO Write.
org.hyphenType.util - package org.hyphenType.util
TODO Write.
org.hyphenType.util.resourcebundles - package org.hyphenType.util.resourcebundles
TODO Write.
org.hyphenType.util.soc - package org.hyphenType.util.soc
 
org.hyphenType.wrapper - package org.hyphenType.wrapper
TODO Write.
out() - Method in class org.hyphenType.unittesting.UnitTestingAppEngine
 

P

preferredFormatter(Class<? extends Options<?>>) - Static method in class org.hyphenType.documentation.DocumentationFormatterEngine
Builds the preferred formatter.
print(String, String, int, int, int, boolean) - Method in class org.hyphenType.documentation.lib.StandardFormatterEngine
Generates a string that contains the textual representation of a title and a message, formatting using a certain indent and a maximum column.
printDocumentation() - Method in interface org.hyphenType.datastructure.Options
Prints the documentation using the preferred documentation formatter to the standard System.out.
printDocumentation(PrintStream) - Method in interface org.hyphenType.datastructure.Options
Prints the documentation using the preferred documentation formatter.
printDocumentation(Class<? extends Annotation>) - Method in interface org.hyphenType.datastructure.Options
Prints the documentation using the given documentation formatter to the standard System.out.
printDocumentation(Class<? extends Annotation>, PrintStream) - Method in interface org.hyphenType.datastructure.Options
Prints the documentation using the given documentation formatter.
printDocumentation() - Method in class org.hyphenType.documentation.DocumentationFormatterEngine
Prints the documentation to the default stdout (System.out).
printDocumentation(PrintStream) - Method in class org.hyphenType.documentation.DocumentationFormatterEngine
Prints the documentation to the given PrintStream.
printDocumentation(PrintStream, LexerParser<T>, V) - Method in class org.hyphenType.documentation.DocumentationFormatterEngine
 
printDocumentation(PrintStream, LexerParser<T>, HTMLFormatterEngine.HTMLFormatter) - Method in class org.hyphenType.documentation.lib.HTMLFormatterEngine
 
printDocumentation(PrintStream, LexerParser<T>, StandardFormatterEngine.StandardFormatter) - Method in class org.hyphenType.documentation.lib.StandardFormatterEngine
 
printDocumentation() - Method in class org.hyphenType.dynamicproxy.AbstractArgumentsInvocationHandler
TODO Comment.
printDocumentation(PrintStream) - Method in class org.hyphenType.dynamicproxy.AbstractArgumentsInvocationHandler
TODO Comment.
printDocumentation(Class<? extends Annotation>) - Method in class org.hyphenType.dynamicproxy.AbstractArgumentsInvocationHandler
TODO Comment.
printDocumentation(Class<? extends Annotation>, PrintStream) - Method in class org.hyphenType.dynamicproxy.AbstractArgumentsInvocationHandler
TODO Comment.
process(Class<T>, T, U) - Method in interface org.hyphenType.optionprocessors.ArgumentsProcessorEngine
Must call Options#exit(Enum) or Options#exit(int) if, and only if, the options violate the contract represented by this argument validator engine.
process(Class<T>, T, BooleanValidatorEngine.BooleanValidator) - Method in class org.hyphenType.optionprocessors.lib.BooleanValidatorEngine
 
process(Class<T>, T, CustomizableValidatorEngine.CustomizableValidator) - Method in class org.hyphenType.optionprocessors.lib.CustomizableValidatorEngine
 
PROPERTIES_PREFIX - Static variable in class org.hyphenType.documentation.OptionListResourceBundle
 

R

rawArguments() - Method in interface org.hyphenType.datastructure.Options
Retrieves the array of arguments as they were received from the user.
RBGenerator - Class in org.hyphenType.documentation.rbgenerator
 
RBGenerator() - Constructor for class org.hyphenType.documentation.rbgenerator.RBGenerator
 
RBGeneratorOptions - Interface in org.hyphenType.documentation.rbgenerator
 
readArray(StructureArgument, String, String) - Method in class org.hyphenType.input.UserInput
 
readFromGraphicalUI(Class<T>, String, String) - Method in class org.hyphenType.input.StandardUserInput
 
readFromGraphicalUI(Class<T>, String, String) - Method in class org.hyphenType.input.UserInput
 
readFromGraphicalUI(Class<T>, String, String) - Method in class org.hyphenType.unittesting.UnitTestingUserInput
 
readFromTextUI(Class<T>, String, String) - Method in class org.hyphenType.input.StandardUserInput
 
readFromTextUI(Class<T>, String, String) - Method in class org.hyphenType.input.UserInput
 
readFromTextUI(Class<T>, String, String) - Method in class org.hyphenType.unittesting.UnitTestingUserInput
 
readString(StructureArgument, String, String) - Method in class org.hyphenType.input.UserInput
 
RegexMismatchException - Exception in org.hyphenType.lexerparser.exceptions
 
RegexMismatchException(Class<? extends Options<?>>, String, String, String) - Constructor for exception org.hyphenType.lexerparser.exceptions.RegexMismatchException
 

S

saveStdoutInteraction(String) - Method in class org.hyphenType.unittesting.UnitTestingAppEngine
Writes the output written to stdout to a file.
saveStdoutInteractionHTML(String) - Method in class org.hyphenType.unittesting.UnitTestingAppEngine
Writes the output written to stdout to a file using HTML snippet format.
saveStdoutInteractionHTML(String, String, String) - Method in class org.hyphenType.unittesting.UnitTestingAppEngine
Writes the output written to stdout to a file using HTML snippet format.
searchArgument(String) - Method in class org.hyphenType.lexerparser.LexerParser
 
searchElement(Method) - Method in class org.hyphenType.lexerparser.LexerParser
 
searchOption(String) - Method in class org.hyphenType.lexerparser.LexerParser
 
searchOptionPrefixing(String) - Method in class org.hyphenType.lexerparser.LexerParser
 
set(Annotation, Method, Object) - Static method in class org.hyphenType.util.DefaultAnnotation
 
set(Annotation, String, Object) - Static method in class org.hyphenType.util.DefaultAnnotation
 
setDebugMode(boolean) - Static method in class org.hyphenType.debug.HTLogger
Allows it for programmatic change of the debug mode.
setGraphicalUIAvailable(boolean) - Method in class org.hyphenType.unittesting.UnitTestingUserInput
Sets whether the graphical user interface is available or not.
setOutput(PrintStream) - Static method in class org.hyphenType.debug.HTLogger
Replaces the PrintStream used by this class to log messages.
setTextUIAvailable(boolean) - Method in class org.hyphenType.unittesting.UnitTestingUserInput
Sets whether the textual user interface is available or not.
SimpleArgument - Annotation Type in org.hyphenType.datastructure.annotations
 
StandAloneAppWrapper - Class in org.hyphenType.wrapper
A wrapper that can be called instead of a standard main class.
StandAloneAppWrapper() - Constructor for class org.hyphenType.wrapper.StandAloneAppWrapper
 
StandardFormatterEngine<T extends Options<?>> - Class in org.hyphenType.documentation.lib
A documentation formatter inspired on the standard Unix way to show documentation in the command line.
StandardFormatterEngine() - Constructor for class org.hyphenType.documentation.lib.StandardFormatterEngine
 
StandardFormatterEngine.StandardFormatter - Annotation Type in org.hyphenType.documentation.lib
Annotation to configure the StandardFormatterEngine.
StandardUserInput - Class in org.hyphenType.input
 
StandardUserInput() - Constructor for class org.hyphenType.input.StandardUserInput
 
StatusCode - Interface in org.hyphenType.exit
Status code enumerations.
StringObjectConversion - Class in org.hyphenType.util.soc
Converts strings to objects and vice-versa.
StringParseException - Exception in org.hyphenType.lexerparser.exceptions
 
StringParseException(Throwable, Class<? extends Options<?>>, String) - Constructor for exception org.hyphenType.lexerparser.exceptions.StringParseException
 
StringParsingError - Exception in org.hyphenType.util.soc
An exception thrown for parsing errors.
StringParsingErrorException - Exception in org.hyphenType.lexerparser.exceptions
TODO Change the name of this class.
StringParsingErrorException(Throwable, Class<? extends Options<?>>, String, Class<?>) - Constructor for exception org.hyphenType.lexerparser.exceptions.StringParsingErrorException
 
StructureArgument - Class in org.hyphenType.datastructure.parser
 
StructureArgument(String, Method, boolean, int, String, List<InputChannel>, String) - Constructor for class org.hyphenType.datastructure.parser.StructureArgument
 
StructureElement - Class in org.hyphenType.datastructure.parser
 
StructureElement(Method) - Constructor for class org.hyphenType.datastructure.parser.StructureElement
 
StructureOption - Class in org.hyphenType.datastructure.parser.option
 
StructureOption(Method, String, List<String>, StructureOptionValue, StructureOptionMapValue, List<StructureOptionArgument>) - Constructor for class org.hyphenType.datastructure.parser.option.StructureOption
 
StructureOptionArgument - Class in org.hyphenType.datastructure.parser.option
 
StructureOptionArgument(String, Method, boolean, int, String, List<InputChannel>, String) - Constructor for class org.hyphenType.datastructure.parser.option.StructureOptionArgument
 
StructureOptionMapValue - Class in org.hyphenType.datastructure.parser.option
 
StructureOptionMapValue(Method, String, String, Class, boolean) - Constructor for class org.hyphenType.datastructure.parser.option.StructureOptionMapValue
 
StructureOptionValue - Class in org.hyphenType.datastructure.parser.option
 
StructureOptionValue(Method, String, boolean, String, boolean) - Constructor for class org.hyphenType.datastructure.parser.option.StructureOptionValue
 
StructureSimpleArgument - Class in org.hyphenType.datastructure.parser.simple
 
StructureSimpleArgument(Method, String, boolean, int, String, List<InputChannel>, String) - Constructor for class org.hyphenType.datastructure.parser.simple.StructureSimpleArgument
 
supportedLanguages() - Method in interface org.hyphenType.documentation.rbgenerator.RBGeneratorOptions
 

T

toPrimitive(Class, Object) - Static method in class org.hyphenType.util.soc.StringObjectConversion
Parses the object into a primitive.
toString() - Method in class org.hyphenType.datastructure.lexer.LexToken
 
toString() - Method in class org.hyphenType.datastructure.parser.option.StructureOption
 
toString() - Method in class org.hyphenType.datastructure.parser.simple.StructureSimpleArgument
 
toString() - Method in class org.hyphenType.dynamicproxy.AbstractArgumentsInvocationHandler
 
toString() - Method in class org.hyphenType.lexerparser.OptionValues
 
toString() - Method in class org.hyphenType.util.DefaultAnnotation
 

U

uncaughtThrowable() - Method in class org.hyphenType.unittesting.UnitTestingAppEngine
If the execution of the application under test threw any Throwable that was not caught by any exit status constant, this method will return this Throwable.
UnitTestingAppEngine - Class in org.hyphenType.unittesting
 
UnitTestingAppEngine(Class<?>, String...) - Constructor for class org.hyphenType.unittesting.UnitTestingAppEngine
 
UnitTestingAppEngine(Class<?>, UnitTestingUserInput, String...) - Constructor for class org.hyphenType.unittesting.UnitTestingAppEngine
 
UnitTestingOptionExtractor<T extends Options<?>> - Class in org.hyphenType.unittesting
An OptionsExtractor that is ready for unit tests.
UnitTestingOptionExtractor(Class<T>) - Constructor for class org.hyphenType.unittesting.UnitTestingOptionExtractor
Creates a new UnitTestingOptionExtractor object that will work as a factory for objects whose options interface's class is the class given as argument.
UnitTestingOptionExtractor(Class<T>, boolean) - Constructor for class org.hyphenType.unittesting.UnitTestingOptionExtractor
Creates a new UnitTestingOptionExtractor object in a way that allows the caller to chose whether or not calls to Options#exit(Enum) or Options#exit(int) will result into throwing a NonExceptionalExit exception.
UnitTestingUserInput - Class in org.hyphenType.unittesting
An user input to replace a standard user input during unit testing.
UnitTestingUserInput() - Constructor for class org.hyphenType.unittesting.UnitTestingUserInput
 
unparsedArguments() - Method in interface org.hyphenType.datastructure.Options
All the arguments that were ignored by the parsing process.
unusedArguments() - Method in class org.hyphenType.lexerparser.OptionValues
 
UserInput - Class in org.hyphenType.input
 
UserInput() - Constructor for class org.hyphenType.input.UserInput
 
UserInputException - Exception in org.hyphenType.input
 
UserInputException() - Constructor for exception org.hyphenType.input.UserInputException
 
UserInputException(String, Throwable) - Constructor for exception org.hyphenType.input.UserInputException
 
UserInputException(String) - Constructor for exception org.hyphenType.input.UserInputException
 
UserInputException(Throwable) - Constructor for exception org.hyphenType.input.UserInputException
 

V

validate(T) - Method in interface org.hyphenType.optionprocessors.lib.CustomizableValidatorEngine.Rule
 
value - Variable in class org.hyphenType.datastructure.lexer.LexToken
 
value - Variable in class org.hyphenType.datastructure.parser.option.StructureOption
 
valueName - Variable in class org.hyphenType.datastructure.parser.option.StructureOptionMapValue
 
valueOf(String) - Static method in enum org.hyphenType.datastructure.annotations.InputChannel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.hyphenType.exit.CanonicalExitCode
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.hyphenType.datastructure.annotations.InputChannel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.hyphenType.exit.CanonicalExitCode
Returns an array containing the constants of this enum type, in the order they are declared.
valueType - Variable in class org.hyphenType.datastructure.parser.option.StructureOptionMapValue
 

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

Copyright © 2013. All Rights Reserved.