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

A

AbstractCoreException - Exception in de.smartics.exceptions

The base implementation of the core exception that supports unique identifying and exception codes for checked exceptions.

AbstractCoreException(Code) - Constructor for exception de.smartics.exceptions. AbstractCoreException

Constructor.

AbstractCoreException(String, Code) - Constructor for exception de.smartics.exceptions. AbstractCoreException

Constructor.

AbstractCoreException(Throwable, Code) - Constructor for exception de.smartics.exceptions. AbstractCoreException

Constructor.

AbstractCoreException(String, Throwable, Code) - Constructor for exception de.smartics.exceptions. AbstractCoreException

Constructor.

AbstractCoreRuntimeException - Exception in de.smartics.exceptions

The base implementation of the core runtime exception that supports unique identifying and exception codes for unchecked exceptions.

AbstractCoreRuntimeException(Code) - Constructor for exception de.smartics.exceptions. AbstractCoreRuntimeException

Constructor.

AbstractCoreRuntimeException(String, Code) - Constructor for exception de.smartics.exceptions. AbstractCoreRuntimeException

Constructor.

AbstractCoreRuntimeException(Throwable, Code) - Constructor for exception de.smartics.exceptions. AbstractCoreRuntimeException

Constructor.

AbstractCoreRuntimeException(String, Throwable, Code) - Constructor for exception de.smartics.exceptions. AbstractCoreRuntimeException

Constructor.

AbstractElementReport - Class in de.smartics.maven.exceptions

Generates a report on elements found in the source tree.

AbstractElementReport() - Constructor for class de.smartics.maven.exceptions. AbstractElementReport

AbstractExceptionContext - Class in de.smartics.exceptions.context

Provides exception relevant information for an exception context as an abstract class.

AbstractExceptionContext(Configuration) - Constructor for class de.smartics.exceptions.context. AbstractExceptionContext

Default constructor providing a configuration.

AbstractExceptionContext(InputStream) - Constructor for class de.smartics.exceptions.context. AbstractExceptionContext

Convenience constructor providing an input stream.

AbstractExceptionContext(Reader) - Constructor for class de.smartics.exceptions.context. AbstractExceptionContext

Convenience constructor providing a reader.

AbstractExceptionContext(URL) - Constructor for class de.smartics.exceptions.context. AbstractExceptionContext

Convenience constructor providing an URL.

AbstractExceptionContextManager< T extends ExceptionContext> - Class in de.smartics.exceptions.runtime

Provides configuration information for exceptions per class loader.

AbstractExceptionContextManager() - Constructor for class de.smartics.exceptions.runtime. AbstractExceptionContextManager

AbstractI18nExceptionContext - Class in de.smartics.exceptions.i18n.context

Provides exception relevant information for an exception context.

AbstractI18nExceptionContext(Configuration) - Constructor for class de.smartics.exceptions.i18n.context. AbstractI18nExceptionContext

Constructor.

AbstractLocalizedException - Exception in de.smartics.exceptions.i18n

The base implementation of exceptions that support Internationalization for checked exceptions.

AbstractLocalizedException(Code) - Constructor for exception de.smartics.exceptions.i18n. AbstractLocalizedException

Constructor.

AbstractLocalizedException(Code, String) - Constructor for exception de.smartics.exceptions.i18n. AbstractLocalizedException

Constructor.

AbstractLocalizedException(Throwable, Code) - Constructor for exception de.smartics.exceptions.i18n. AbstractLocalizedException

Constructor.

AbstractLocalizedException(Throwable, Code, String) - Constructor for exception de.smartics.exceptions.i18n. AbstractLocalizedException

Constructor.

AbstractLocalizedException(Throwable, Code, String, String) - Constructor for exception de.smartics.exceptions.i18n. AbstractLocalizedException

Constructor.

AbstractLocalizedRuntimeException - Exception in de.smartics.exceptions.i18n

The base implementation of exceptions that support Internationalization for unchecked exceptions.

AbstractLocalizedRuntimeException(Code) - Constructor for exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Constructor.

AbstractLocalizedRuntimeException(Code, String) - Constructor for exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Constructor.

AbstractLocalizedRuntimeException(Throwable, Code) - Constructor for exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Constructor.

AbstractLocalizedRuntimeException(Throwable, Code, String) - Constructor for exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Constructor.

AbstractLocalizedRuntimeException(Throwable, Code, String, String) - Constructor for exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Constructor.

AbstractSdocCodeMojo - Class in de.smartics.maven.exceptions.sdoccode

Base implementation to generate SDoc documentation files.

AbstractSdocCodeMojo() - Constructor for class de.smartics.maven.exceptions.sdoccode. AbstractSdocCodeMojo

AbstractSinkReportGenerator - Class in de.smartics.maven.exceptions

Simple generator that generates with a Maven sink.

AbstractSinkReportGenerator() - Constructor for class de.smartics.maven.exceptions. AbstractSinkReportGenerator

Default constructor.

B

BUNDLE_NAME_SUFFIX - Static variable in class de.smartics.exceptions.i18n.message. LocalizedInfo

The suffix for the auto generated bundle name.

bundleBaseName - Variable in class de.smartics.exceptions.i18n.message. LocalizedInfo

The fully qualified base name of the bundle to use.

C

canGenerateReport() - Method in class de.smartics.maven.exceptions. AbstractElementReport

capitalize(String) - Static method in class de.smartics.exceptions.i18n.message. Helper

This method transforms the first character to upper case and returns the result.

clazz - Variable in exception de.smartics.exceptions.i18n. PropertyAccessConfigurationException

The class that should contain the property but the information cannot be accessed.

Code - Interface in de.smartics.exceptions.core

This interface defines error and exception codes to identify exception classes.

CodeComparator - Class in de.smartics.exceptions.report.sort

Compares exception code instances.

CodeComparator() - Constructor for class de.smartics.exceptions.report.sort. CodeComparator

Default constructor.

CodeSortedSinkReportGenerator - Class in de.smartics.maven.exceptions.report

Simple generator that generates with a Maven sink.

CodeSortedSinkReportGenerator() - Constructor for class de.smartics.maven.exceptions.report. CodeSortedSinkReportGenerator

Default constructor.

CodeUtils - Class in de.smartics.exceptions.report.sort

Utilities handling Javadocs representing codes.

CodeUtils.CodeContainer - Class in de.smartics.exceptions.report.sort

Bundle of information about a code.

CodeUtils.CodeContainer(Code, ClassDoc, FieldDoc, PlaceHolderInfo) - Constructor for class de.smartics.exceptions.report.sort. CodeUtils.CodeContainer

Default constructor.

compare(T, T) - Method in class de.smartics.exceptions.code. DefaultCodeComparator

Compares the component identifier and then the code itself.

compare(T, T) - Method in class de.smartics.exceptions.code. NumberCodeComparator

Compares the component identifier and then the code itself.

compare(CodeUtils.CodeContainer, CodeUtils.CodeContainer) - Method in class de.smartics.exceptions.report.sort. CodeComparator

Uses DefaultCodeComparator to compare codes.

compare(CodeUtils.CodeContainer, CodeUtils.CodeContainer) - Method in class de.smartics.exceptions.report.sort. MixedCodeComparator

compareTo(PlaceHolderDescId) - Method in class de.smartics.exceptions.report.message. PlaceHolderDescId

COMPONENT_ID - Static variable in class de.smartics.exceptions.app. Constant

The constant used to identify exception codes for this module.

COMPONENT_ID - Static variable in class de.smartics.exceptions.i18n.app. Constant

The constant used to identify exception codes for this module.

componentId - Variable in class de.smartics.exceptions.code. NumberCodeInfo

The identifier of the component this code belongs to.

composeMessage(Throwable, Locale, ResourceBundle, String, MessageType) - Method in class de.smartics.exceptions.i18n.message. DefaultMessageComposer

Creates the message from the message template.

composeMessage(Throwable, Locale, ResourceBundle, String, MessageType) - Method in interface de.smartics.exceptions.i18n. MessageComposer

Creates the message from the message template.

CONFIGURATION_FILE - Static variable in class de.smartics.exceptions.context. ConfiguredExceptionContext

The name of the configuration file the context will read from the class path.

CONFIGURATION_FILE - Static variable in class de.smartics.exceptions.context. PropertiesConfiguredExceptionContext

The name of the configuration file the context will read from the class path.

ConfigurationException - Exception in de.smartics.exceptions.i18n

This configuration exception is thrown if the system encountered an inconsistent configuration or configuration information was missing.

ConfigurationException(ConfigurationExceptionCode, String) - Constructor for exception de.smartics.exceptions.i18n. ConfigurationException

Constructor.

ConfigurationException(ConfigurationExceptionCode) - Constructor for exception de.smartics.exceptions.i18n. ConfigurationException

Constructor.

ConfigurationException(Throwable, ConfigurationExceptionCode, String) - Constructor for exception de.smartics.exceptions.i18n. ConfigurationException

Constructor.

ConfigurationException(Throwable, ConfigurationExceptionCode) - Constructor for exception de.smartics.exceptions.i18n. ConfigurationException

Constructor.

ConfigurationExceptionCode - Enum in de.smartics.exceptions.i18n.app

Defines the exception codes for problems with the configuration of the library.

ConfiguredExceptionContext - Class in de.smartics.exceptions.context

The exception context is configured via commons-configuration.

ConfiguredExceptionContext() - Constructor for class de.smartics.exceptions.context. ConfiguredExceptionContext

Default constructor.

Constant - Class in de.smartics.exceptions.app

Defines constants for this application.

Constant - Class in de.smartics.exceptions.i18n.app

Defines constants for this application.

CopySdocCodeMojo - Class in de.smartics.maven.exceptions.sdoccode

Extracts the exception code information of a project and generates one XML document for each code in the projectdoc's appcode doctype format.

CopySdocCodeMojo() - Constructor for class de.smartics.maven.exceptions.sdoccode. CopySdocCodeMojo

CoreException - Interface in de.smartics.exceptions

Interface defines the core exception features.

createId() - Method in interface de.smartics.exceptions.core. IdFactory

Creates the identifier.

createId() - Method in class de.smartics.exceptions.id. IncrementFactory

Creates the identifier.

createId() - Method in class de.smartics.exceptions.id. SignedIncrementFactory

Creates the identifier.

createId() - Method in class de.smartics.exceptions.id. UuidFactory

Creates the identifier.

createKey(String) - Method in enum de.smartics.exceptions.i18n.message. MessageType

Returns the key with the message type resource key suffix ( MessageType.getMessageKeySuffix()) appended.

CSS_FILE - Static variable in class de.smartics.exceptions.cli. Main

The link reference to the CSS file to add to the head element of the generated HTML document.

D

de.smartics.exceptions - package de.smartics.exceptions

The core package for the exception handling.

de.smartics.exceptions.ant - package de.smartics.exceptions.ant

Provides an Ant task that create a report on the codes provided in the referenced application and libraries.

de.smartics.exceptions.app - package de.smartics.exceptions.app

de.smartics.exceptions.cli - package de.smartics.exceptions.cli

Provides classes that create a report on the codes provided in the referenced application and libraries.

de.smartics.exceptions.code - package de.smartics.exceptions.code

Provides code implementations.

de.smartics.exceptions.context - package de.smartics.exceptions.context

Provides context configuration for exceptions.

de.smartics.exceptions.core - package de.smartics.exceptions.core

Provides core information beans, interfaces and exceptions.

de.smartics.exceptions.i18n - package de.smartics.exceptions.i18n

The core package for the I18N exception handling.

de.smartics.exceptions.i18n.app - package de.smartics.exceptions.i18n.app

Provides classes used for the library to act as an application.

de.smartics.exceptions.i18n.context - package de.smartics.exceptions.i18n.context

Provides context configuration for exceptions.

de.smartics.exceptions.i18n.message - package de.smartics.exceptions.i18n.message

Provides classes for the internationalization of exception messages.

de.smartics.exceptions.id - package de.smartics.exceptions.id

Provides standard implementations for exception identifiers.

de.smartics.exceptions.ognl - package de.smartics.exceptions.ognl

Provides classes to parse OGNL expressions.

de.smartics.exceptions.report.generator - package de.smartics.exceptions.report.generator

Provides report generator implementations.

de.smartics.exceptions.report.message - package de.smartics.exceptions.report.message

de.smartics.exceptions.report.sort - package de.smartics.exceptions.report.sort

Provides utilities to sort the tabular content of the reports.

de.smartics.exceptions.runtime - package de.smartics.exceptions.runtime

Provides context management classes.

de.smartics.maven.exceptions - package de.smartics.maven.exceptions

Provides Mojo and base classes for the Maven report plugin.

de.smartics.maven.exceptions.report - package de.smartics.maven.exceptions.report

Provides implementations for report presentation.

de.smartics.maven.exceptions.sdoccode - package de.smartics.maven.exceptions.sdoccode

de.smartics.maven.exceptions.sdoccode.report - package de.smartics.maven.exceptions.sdoccode.report

DEFAULT_EXCEPTION_CONTEXT - Static variable in class de.smartics.exceptions.runtime. ExceptionContextManager

The default context if none is provided for a given class loader.

DefaultCodeComparator< T extends Code> - Class in de.smartics.exceptions.code

The default code comparator compares the component and then the code by lexicographical order.

DefaultCodeComparator() - Constructor for class de.smartics.exceptions.code. DefaultCodeComparator

Default constructor.

DefaultMessageComposer - Class in de.smartics.exceptions.i18n.message

The message composer creates messages from message templates by replacing the place holders with localized parameter values.

DefaultMessageComposer() - Constructor for class de.smartics.exceptions.i18n.message. DefaultMessageComposer

Default constructor.

E

EMPTY - Static variable in class de.smartics.exceptions.report.message. PlaceHolderInfo

The singleton to represent the immutable empty place holder info.

equals(Object) - Method in class de.smartics.exceptions.id. LongExceptionId

Returns true if the given object is semantically equal to the given object, false otherwise.

equals(Object) - Method in class de.smartics.exceptions.id. UuidExceptionId

Returns true if the given object is semantically equal to the given object, false otherwise.

equals(Object) - Method in class de.smartics.exceptions.report.message. PlaceHolderDescId

Returns true if the given object is semantically equal to the given object, false otherwise.

ExceptionCodeReport - Class in de.smartics.maven.exceptions

Generates exception code documentation.

ExceptionCodeReport() - Constructor for class de.smartics.maven.exceptions. ExceptionCodeReport

ExceptionCodesReportTask - Class in de.smartics.exceptions.ant

Ant task implementation to run exception codes report.

ExceptionCodesReportTask() - Constructor for class de.smartics.exceptions.ant. ExceptionCodesReportTask

ExceptionContext - Interface in de.smartics.exceptions.core

Defines access to the resources required by the exception infrastructure.

ExceptionContextManager - Class in de.smartics.exceptions.runtime

Provides configuration information for exceptions per class loader.

ExceptionContextManager() - Constructor for class de.smartics.exceptions.runtime. ExceptionContextManager

ExceptionContextProperty - Enum in de.smartics.exceptions.context

Provides properties for the configuration of an exception context.

ExceptionId< E> - Interface in de.smartics.exceptions.core

Interface to implement an exception identifier.

execute() - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Runs the Ant task to generate an exception codes report.

execute() - Method in class de.smartics.maven.exceptions. AbstractElementReport

Runs the report generation.

execute() - Method in class de.smartics.maven.exceptions.sdoccode. AbstractSdocCodeMojo

executeReport(Locale) - Method in class de.smartics.maven.exceptions. ExceptionCodeReport

ExportSdocCodeMojo - Class in de.smartics.maven.exceptions.sdoccode

Exports the SDoc documents.

ExportSdocCodeMojo() - Constructor for class de.smartics.maven.exceptions.sdoccode. ExportSdocCodeMojo

F

factory - Variable in class de.smartics.maven.exceptions. AbstractElementReport

The factory to create dependent artifacts.

fetchContext(ClassLoader) - Method in class de.smartics.exceptions.runtime. AbstractExceptionContextManager

Fetches the most appropriate context for the given class loader.

fetchContextFromService(ClassLoader) - Method in class de.smartics.exceptions.i18n. I18nExceptionContextManager

Returns the context configured by the service framework.

fetchContextFromService(ClassLoader) - Method in class de.smartics.exceptions.runtime. AbstractExceptionContextManager

Returns the context configured by the service framework.

fetchContextFromService(ClassLoader) - Method in class de.smartics.exceptions.runtime. ExceptionContextManager

Returns the context configured by the service framework.

G

genSrcDir - Variable in class de.smartics.maven.exceptions.sdoccode. CopySdocCodeMojo

The directory containing the generated documentation XML files.

getBundle(Locale) - Method in class de.smartics.maven.exceptions. AbstractElementReport

Returns the resource bundle for the given locale.

getBundleBaseName() - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedException

Delegates call to LocalizedInfo.getBundleBaseName() .

getBundleBaseName() - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Returns the fully qualified base name of the bundle to use.

getBundleBaseName() - Method in class de.smartics.exceptions.i18n.message. LocalizedInfo

Returns the fully qualified base name of the bundle to use.

getBundleName() - Method in class de.smartics.maven.exceptions. AbstractElementReport

Returns the name of the bundle to load to label report information.

getBundleName() - Method in class de.smartics.maven.exceptions. ExceptionCodeReport

Returns the name of the bundle to load to label report information.

getBundleProvider() - Method in class de.smartics.exceptions.i18n.context. AbstractI18nExceptionContext

Returns the bundle provider that helps to access resource bundles.

getBundleProvider() - Method in interface de.smartics.exceptions.i18n. I18nExceptionContext

Returns the bundle provider that helps to access resource bundles.

getBundleProvider(ClassLoader) - Static method in class de.smartics.exceptions.i18n. I18nExceptionContextManager

Convenience method to access the bundle provider for the given class loader.

getCause() - Method in exception de.smartics.exceptions. AbstractCoreException

Returns the cause of this throwable or null if the cause is nonexistent or unknown.

getCause() - Method in exception de.smartics.exceptions. AbstractCoreRuntimeException

Returns the cause of this throwable or null if the cause is nonexistent or unknown.

getCause() - Method in interface de.smartics.exceptions. CoreException

Returns the cause of this throwable or null if the cause is nonexistent or unknown.

getClassDoc() - Method in class de.smartics.exceptions.report.sort. CodeUtils.CodeContainer

Returns the Javadoc information collected at class level.

getClasspath() - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Returns the classpath to search for exception code classes.

getClazz() - Method in exception de.smartics.exceptions.i18n. PropertyAccessConfigurationException

Returns the class that should contain the property but the information cannot be accessed.

getCode() - Method in exception de.smartics.exceptions. AbstractCoreException

Returns the error or exception code of the exception.

getCode() - Method in exception de.smartics.exceptions. AbstractCoreRuntimeException

Returns the error or exception code of the exception.

getCode() - Method in class de.smartics.exceptions.code. NumberCodeInfo

Returns the string representation of the code.

getCode() - Method in class de.smartics.exceptions.code. TwoNumberCodeInfo

Returns the string representation of the code.

getCode() - Method in interface de.smartics.exceptions.core. Code

Returns the string representation of the code.

getCode() - Method in interface de.smartics.exceptions. CoreException

Returns the error or exception code of the exception.

getCode() - Method in enum de.smartics.exceptions.i18n.app. ConfigurationExceptionCode

Returns the string representation of the code.

getCode() - Method in enum de.smartics.exceptions.i18n.app. ParseExceptionCode

Returns the string representation of the code.

getCode() - Method in class de.smartics.exceptions.report.sort. CodeUtils.CodeContainer

Returns the instance of the code.

getCodeList(ProjectConfiguration<?>, Collection<Doc>) - Static method in class de.smartics.exceptions.report.sort. CodeUtils

getCodeList(ProjectConfiguration<?>, Collection<Doc>, Comparator<CodeUtils.CodeContainer>) - Static method in class de.smartics.exceptions.report.sort. CodeUtils

getComponentId() - Method in class de.smartics.exceptions.code. NumberCodeInfo

Returns the identifier of the component this code belongs to.

getComponentId() - Method in interface de.smartics.exceptions.core. Code

Returns the component identifier that raised an exception with this code.

getComponentId() - Method in enum de.smartics.exceptions.i18n.app. ConfigurationExceptionCode

Returns the component identifier that raised an exception with this code.

getComponentId() - Method in enum de.smartics.exceptions.i18n.app. ParseExceptionCode

Returns the component identifier that raised an exception with this code.

getComponentName() - Method in enum de.smartics.exceptions.context. ExceptionContextProperty

Returns the name of the component the property belongs to.

getComponentName() - Method in enum de.smartics.exceptions.i18n.context. I18nExceptionContextProperty

getContext(ClassLoader) - Method in class de.smartics.exceptions.runtime. AbstractExceptionContextManager

Returns the exception configuration for the given class loader.

getCssFile() - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Returns the link reference to the CSS file to add to the head element of the generated HTML document.

getDefaultExceptionContext() - Method in class de.smartics.exceptions.i18n. I18nExceptionContextManager

Returns the default context provided by the subclass.

getDefaultExceptionContext() - Method in class de.smartics.exceptions.runtime. AbstractExceptionContextManager

Returns the default context provided by the subclass.

getDefaultExceptionContext() - Method in class de.smartics.exceptions.runtime. ExceptionContextManager

Returns the default context provided by the subclass.

getDefaultValue() - Method in enum de.smartics.exceptions.context. ExceptionContextProperty

Returns the default value to use if a given property is not specified.

getDefaultValue() - Method in enum de.smartics.exceptions.i18n.context. I18nExceptionContextProperty

Returns the default value to use if a given property is not specified.

getDescription() - Method in class de.smartics.exceptions.report.message. PlaceHolderDesc

Returns the description of the place holder.

getDescription(Locale) - Method in class de.smartics.maven.exceptions. AbstractElementReport

getDisplayId() - Method in class de.smartics.exceptions.code. NumberCodeInfo

Returns the string representation of the code.

getDisplayId() - Method in class de.smartics.exceptions.code. TwoNumberCodeInfo

Returns the string representation of the code.

getDisplayId() - Method in interface de.smartics.exceptions.core. Code

Returns the string representation of the code.

getDisplayId() - Method in enum de.smartics.exceptions.i18n.app. ConfigurationExceptionCode

Returns the string representation of the code.

getDisplayId() - Method in enum de.smartics.exceptions.i18n.app. ParseExceptionCode

Returns the string representation of the code.

getExpression() - Method in class de.smartics.exceptions.ognl. OgnlExpression

Returns the reference to the parsed expression instance.

getFactory(ClassLoader) - Static method in class de.smartics.exceptions.i18n. I18nExceptionContextManager

Convenience method to access the ID factory for the given class loader.

getFactory(ClassLoader) - Static method in class de.smartics.exceptions.runtime. ExceptionContextManager

Convenience method to access the ID factory for the given class loader.

getFieldDoc() - Method in class de.smartics.exceptions.report.sort. CodeUtils.CodeContainer

Returns the Javadoc information collected at field level.

getId() - Method in exception de.smartics.exceptions. AbstractCoreException

Returns the unique identifier of the exception.

getId() - Method in exception de.smartics.exceptions. AbstractCoreRuntimeException

Returns the unique identifier of the exception.

getId() - Method in interface de.smartics.exceptions.core. ExceptionId

Returns the implementing type of the identifier.

getId() - Method in interface de.smartics.exceptions. CoreException

Returns the unique identifier of the exception.

getId() - Method in class de.smartics.exceptions.id. LongExceptionId

Returns the implementing type of the identifier.

getId() - Method in class de.smartics.exceptions.id. UuidExceptionId

Returns the implementing type of the identifier.

getIdFactory() - Method in class de.smartics.exceptions.context. AbstractExceptionContext

Returns the factory for generating identifiers.

getIdFactory() - Method in interface de.smartics.exceptions.core. ExceptionContext

Returns the factory for generating identifiers.

getIndex() - Method in class de.smartics.exceptions.i18n.message. MessageParamParser.MessageParamInfo

Returns the index of the placeholder the information should be written to.

getIndex() - Method in exception de.smartics.exceptions.i18n.message. ParseException

Returns the index within the input string where the parsing error occurred.

getInput() - Method in exception de.smartics.exceptions.i18n.message. ParseException

Returns the input that cannot be parsed.

getInstance() - Static method in class de.smartics.exceptions.i18n. I18nExceptionContextManager

Returns the reference to the singleton.

getInstance() - Static method in class de.smartics.exceptions.runtime. ExceptionContextManager

Returns the reference to the singleton.

getLocalizedMessage() - Method in interface de.smartics.exceptions. CoreException

Creates a localized description of this throwable.

getLocalizedMessage() - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedException

Returns the localized message for the given locale.

getLocalizedMessage(Locale) - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedException

Returns the localized message for the given locale.

getLocalizedMessage(Locale, ClassLoader) - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedException

Returns the localized message for the given locale.

getLocalizedMessage(String, Locale, MessageType, ClassLoader) - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedException

Returns the localized message for the given locale.

getLocalizedMessage() - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Returns the localized message according to the system's default locale.

getLocalizedMessage(Locale) - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Returns the localized message for the given locale.

getLocalizedMessage(Locale, ClassLoader) - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Returns the localized message for the given locale.

getLocalizedMessage(String, Locale, MessageType, ClassLoader) - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Returns the localized message for the given locale.

getLocalizedMessage(Throwable, Locale, ClassLoader) - Method in class de.smartics.exceptions.i18n.message. LocalizedInfo

Returns the localized message for the given locale.

getLocalizedMessage(Throwable, String, Locale, MessageType, ClassLoader) - Method in class de.smartics.exceptions.i18n.message. LocalizedInfo

Returns the localized message for the given locale.

getLocalizedSingleLineMessage(Throwable, Locale, ClassLoader, boolean) - Method in class de.smartics.exceptions.i18n.message. LocalizedInfo

Returns the localized message for the given locale.

getLocalizedTextMessage() - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedException

Returns the localized message for the given locale as formatted multi-line text.

getLocalizedTextMessage(Locale) - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedException

Returns the localized message for the given locale as formatted multi-line text.

getLocalizedTextMessage(Locale, ClassLoader) - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedException

Returns the localized message for the given locale as formatted multi-line text.

getLocalizedTextMessage(Throwable, Locale, ClassLoader) - Method in class de.smartics.exceptions.i18n.message. LocalizedInfo

Returns the structured and localized message for the given locale, returning each part of information that is provided.

getMajorNumber() - Method in interface de.smartics.exceptions.code. NumberCode

Returns the major number of the code defines a group of codes.

getMajorNumber() - Method in class de.smartics.exceptions.code. NumberCodeInfo

Returns the major number of the code defines a group of codes.

getMajorNumber() - Method in enum de.smartics.exceptions.i18n.app. ConfigurationExceptionCode

Returns the major number of the code defines a group of codes.

getMajorNumber() - Method in enum de.smartics.exceptions.i18n.app. ParseExceptionCode

Returns the major number of the code defines a group of codes.

getMessage() - Method in interface de.smartics.exceptions. CoreException

Returns the detail message string of this throwable.

getMessage() - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedException

Returns the detail message string of this throwable.

getMessage(MessageType) - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedException

Calls AbstractLocalizedException.getMessage(java.util.Locale, de.smartics.exceptions.i18n.message.MessageType) with argument list ( Locale.getDefault(), <messageType>).

getMessage(Locale, MessageType) - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedException

Returns the message for the given message type.

getMessage(MessageType) - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Returns the message for the given message type and the system's default locale.

getMessage() - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Returns the detail message string of this throwable.

getMessage(Locale, MessageType) - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Returns the message for the given message type.

getMessage(MessageType) - Method in interface de.smartics.exceptions.i18n. LocalizedException

Returns the message for the given message type and the system's default locale.

getMessage(Locale, MessageType) - Method in interface de.smartics.exceptions.i18n. LocalizedException

Returns the message for the given message type.

getMessage(ResourceBundle, String, String) - Static method in class de.smartics.exceptions.report.generator. StringFunction

Returns the value associated with the given key in the given bundle.

getMessageComposer() - Method in class de.smartics.exceptions.i18n.context. AbstractI18nExceptionContext

Returns the implementation to use for the message composer.

getMessageComposer() - Method in interface de.smartics.exceptions.i18n. I18nExceptionContext

Returns the implementation to use for the message composer.

getMessageComposer(ClassLoader) - Static method in class de.smartics.exceptions.i18n. I18nExceptionContextManager

Convenience method to access the message composer for the given class loader.

getMessageKeySuffix() - Method in enum de.smartics.exceptions.i18n.message. MessageType

Returns the suffix for the resource keys to fetch a specific type of message.

getMessageParamInfos(MessageParam) - Method in enum de.smartics.exceptions.i18n.message. MessageType

Returns the index information specified in the message parameter for the message type.

getMessages() - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedException

Returns the messages in one string.

getMessages(Locale) - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedException

Returns the messages in one string.

getMessages() - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Returns the messages in one string.

getMessages(Locale) - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Returns the messages in one string.

getMessages(Locale) - Method in interface de.smartics.exceptions.i18n. LocalizedException

Returns the messages in one string.

getMessages() - Method in interface de.smartics.exceptions.i18n. LocalizedException

Returns the messages in one string.

getMessageTemplateId() - Method in class de.smartics.exceptions.i18n.context. AbstractI18nExceptionContext

Returns the identifier of a template to be used for rendering the exception information.

getMessageTemplateId() - Method in interface de.smartics.exceptions.i18n. I18nExceptionContext

Returns the identifier of a template to be used for rendering the exception information.

getMessageType() - Method in class de.smartics.exceptions.report.message. PlaceHolderDescId

Returns the type of the indexed message.

getMethodName() - Method in exception de.smartics.exceptions.i18n. MethodAccessConfigurationException

Returns the name of the getter method that has been tried to accessed.

getMinorNumber() - Method in interface de.smartics.exceptions.code. NumberCode

Returns the minor number gives additional information about the problem.

getMinorNumber() - Method in class de.smartics.exceptions.code. NumberCodeInfo

Returns the minor number gives additional information about the problem.

getMinorNumber() - Method in enum de.smartics.exceptions.i18n.app. ConfigurationExceptionCode

Returns the minor number gives additional information about the problem.

getMinorNumber() - Method in enum de.smartics.exceptions.i18n.app. ParseExceptionCode

Returns the minor number gives additional information about the problem.

getName() - Method in enum de.smartics.exceptions.context. ExceptionContextProperty

Returns the property name.

getName() - Method in enum de.smartics.exceptions.i18n.context. I18nExceptionContextProperty

Returns the property name.

getName(Locale) - Method in class de.smartics.maven.exceptions. AbstractElementReport

getOgnlPath() - Method in class de.smartics.exceptions.i18n.message. MessageParamParser.MessageParamInfo

Returns the OGNL path to the value inside the value to use.

getOgnlPath() - Method in class de.smartics.exceptions.report.message. PlaceHolderDesc

Returns the path to the value that substitutes the place holder.

getOutputDirectory() - Method in class de.smartics.maven.exceptions. AbstractElementReport

getOutputName() - Method in class de.smartics.maven.exceptions. ExceptionCodeReport

getParamName() - Method in class de.smartics.exceptions.report.message. PlaceHolderDesc

Returns the descriptive name of the place holder.

getParentMessageParamInfos(ParentMessageParam) - Method in enum de.smartics.exceptions.i18n.message. MessageType

Returns the index information for the parent attributes specified in the message parameter for the message type.

getPlaceHolderDesc(PlaceHolderDescId) - Method in class de.smartics.exceptions.report.message. PlaceHolderInfo

Returns the place holder description identifier by the given id.

getPlaceHolderDescOrDefault(PlaceHolderDescId) - Method in class de.smartics.exceptions.report.message. PlaceHolderInfo

Returns the place holder description identifier by the given id.

getPlaceHolderDescs(MessageType) - Method in class de.smartics.exceptions.report.message. PlaceHolderInfo

Returns an iteration over the place holder descriptions in their natural order.

getPlaceHolderId() - Method in class de.smartics.exceptions.report.message. PlaceHolderDesc

Returns the ID of the place holder.

getPlaceHolderIndex() - Method in class de.smartics.exceptions.report.message. PlaceHolderDesc

Returns the index of the place holder within a message of the given message type.

getPlaceHolderIndex() - Method in class de.smartics.exceptions.report.message. PlaceHolderDescId

Returns the index of the place holder within a message of the given message type.

getPlaceHolderInfo() - Method in class de.smartics.exceptions.report.sort. CodeUtils.CodeContainer

Returns the descriptions of the place holders.

getPlaceHolderMessageType() - Method in class de.smartics.exceptions.report.message. PlaceHolderDesc

Returns the type of the indexed message.

getProject() - Method in class de.smartics.maven.exceptions. AbstractElementReport

Returns the maven project.

getProject() - Method in class de.smartics.maven.exceptions.sdoccode. AbstractSdocCodeMojo

Returns the maven project.

getProjectName() - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Returns the name of the project to collect information for.

getPropertyName() - Method in exception de.smartics.exceptions.i18n. PropertyAccessConfigurationException

Returns the name of the property that cannot be accessed.

getReportEncoding() - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Returns the encoding of the report documentation.

getReportExcludes() - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Returns the semicolon separated excluded directories.

getReportFile() - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Returns the name of the report file to write.

getReportGeneratorClass() - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Returns the class name of the report generator instance to use.

getReportIncludes() - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Returns the semicolon separated included directories.

getResourceKey() - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedException

Delegates call to LocalizedInfo.getResourceKey().

getResourceKey() - Method in exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

Returns the localization key to fetch messages from message bundles.

getResourceKey() - Method in class de.smartics.exceptions.i18n.message. LocalizedInfo

Returns the localization key to fetch messages from message bundles.

getSiteRenderer() - Method in class de.smartics.maven.exceptions. AbstractElementReport

getSourceEncoding() - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Returns the encoding of the Java source files.

getSourcepath() - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Returns the source path to search for Javadoc for the exception code classes found on the classpath.

getStackTrace() - Method in interface de.smartics.exceptions. CoreException

Provides programmatic access to the stack trace information printed by Throwable.printStackTrace().

getTemplateId() - Method in enum de.smartics.exceptions.i18n.message. MessageTemplate

Returns the identifier of the template.

getThrowableHandleMode() - Method in class de.smartics.exceptions.context. AbstractExceptionContext

Returns the configuration to control the handling of throwables.

getThrowableHandleMode() - Method in interface de.smartics.exceptions.core. ExceptionContext

Returns the configuration to control the handling of throwables.

getTime() - Method in exception de.smartics.exceptions. AbstractCoreException

Returns the time the exception has been raised.

getTime() - Method in exception de.smartics.exceptions. AbstractCoreRuntimeException

Returns the time the exception has been raised.

getTime() - Method in interface de.smartics.exceptions. CoreException

Returns the time the exception has been raised.

getType() - Method in enum de.smartics.exceptions.context. ExceptionContextProperty

getType() - Method in enum de.smartics.exceptions.i18n.context. I18nExceptionContextProperty

getValue(OgnlContext, Object) - Method in class de.smartics.exceptions.ognl. OgnlExpression

Returns the value for the given context on the given root object.

getValueRange() - Method in enum de.smartics.exceptions.context. ExceptionContextProperty

getValueRange() - Method in enum de.smartics.exceptions.i18n.context. I18nExceptionContextProperty

H

handleGeneratedDocuments() - Method in class de.smartics.maven.exceptions.sdoccode. AbstractSdocCodeMojo

Handles the generated documents.

handleGeneratedDocuments() - Method in class de.smartics.maven.exceptions.sdoccode. CopySdocCodeMojo

Handles the generated documents.

handleGeneratedDocuments() - Method in class de.smartics.maven.exceptions.sdoccode. ExportSdocCodeMojo

hashCode() - Method in class de.smartics.exceptions.id. LongExceptionId

Returns the hashcode of the object.

hashCode() - Method in class de.smartics.exceptions.id. UuidExceptionId

Returns the hashcode of the object.

hashCode() - Method in class de.smartics.exceptions.report.message. PlaceHolderDescId

Returns the hash code of the object.

Helper - Class in de.smartics.exceptions.i18n.message

Provides helper methods for this package.

Helper - Class in de.smartics.exceptions.runtime

Provides helper methods for this package.

HtmlReportGenerator - Class in de.smartics.exceptions.report.generator

Simple generator that generates a HTML file for exception codes.

HtmlReportGenerator() - Constructor for class de.smartics.exceptions.report.generator. HtmlReportGenerator

Default constructor.

I

I18nExceptionContext - Interface in de.smartics.exceptions.i18n

Defines access to the resources required by the exception infrastructure.

I18nExceptionContextManager - Class in de.smartics.exceptions.i18n

Provides configuration information for exceptions per class loader.

I18nExceptionContextManager() - Constructor for class de.smartics.exceptions.i18n. I18nExceptionContextManager

I18nExceptionContextProperty - Enum in de.smartics.exceptions.i18n.context

Provides properties for the configuration of an I18N exception context.

idFactory - Variable in class de.smartics.exceptions.context. AbstractExceptionContext

The factory for generating identifiers.

IdFactory - Interface in de.smartics.exceptions.core

A factory to create instances of ExceptionId.

IncrementFactory - Class in de.smartics.exceptions.id

The factory that created ExceptionIds that provides a number that is larger than zero.

IncrementFactory() - Constructor for class de.smartics.exceptions.id. IncrementFactory

Default constructor with counter initialized with 1.

IncrementFactory(long) - Constructor for class de.smartics.exceptions.id. IncrementFactory

Convenience constructor.

index - Variable in exception de.smartics.exceptions.i18n.message. ParseException

The index within the input string where the parsing error occurred.

info - Variable in exception de.smartics.exceptions. AbstractCoreException

Reference to common exception information.

info - Variable in exception de.smartics.exceptions. AbstractCoreRuntimeException

Reference to common exception information.

input - Variable in exception de.smartics.exceptions.i18n.message. ParseException

The input that cannot be parsed.

INSTANCE - Static variable in class de.smartics.exceptions.report.sort. MixedCodeComparator

Singleton instance for reuse.

isEmpty() - Method in class de.smartics.exceptions.report.message. PlaceHolderInfo

Checks if the place holder info is empty.

isMandatory() - Method in enum de.smartics.exceptions.context. ExceptionContextProperty

isMandatory() - Method in enum de.smartics.exceptions.i18n.context. I18nExceptionContextProperty

J

JAVA_CLASS_PATH - Static variable in class de.smartics.exceptions.cli. Main

The semicolon separated class root directories.

JAVA_SOURCE_ENCODING - Static variable in class de.smartics.exceptions.cli. Main

The encoding of the Java source files.

JAVA_SOURCE_PATH - Static variable in class de.smartics.exceptions.cli. Main

The semicolon separated source root directories.

javadocDir - Variable in class de.smartics.maven.exceptions. AbstractElementReport

Specifies the path to the directory the maven-javadoc-report generates the Javadoc HTML files.

L

loadService(Class<T>, ClassLoader) - Static method in class de.smartics.exceptions.runtime. Helper

Loads the service from the META-INF/services and therefore mimics the ServiceLoader functionality of JSE 1.6 to some extend.

locale - Variable in class de.smartics.maven.exceptions. AbstractElementReport

The locale to use regardless of the report.

locale - Variable in class de.smartics.maven.exceptions.sdoccode. AbstractSdocCodeMojo

The locale to use regardless of the report.

LocalizedException - Interface in de.smartics.exceptions.i18n

Provides access to the localized exception implementations through a common interface.

localizedInfo - Variable in exception de.smartics.exceptions.i18n. AbstractLocalizedException

The localized information controls the localization information.

localizedInfo - Variable in exception de.smartics.exceptions.i18n. AbstractLocalizedRuntimeException

The localized information controls the localization information.

LocalizedInfo - Class in de.smartics.exceptions.i18n.message

Controls the localized information for a throwable.

LocalizedInfo(Code, String, String) - Constructor for class de.smartics.exceptions.i18n.message. LocalizedInfo

Default constructor.

localRepository - Variable in class de.smartics.maven.exceptions. AbstractElementReport

Local Repository.

logLevel - Variable in class de.smartics.maven.exceptions. AbstractElementReport

Specifies the log level used for this plugin.

LongExceptionId - Class in de.smartics.exceptions.id

An implementation where the exception identifier is modeled as a long value.

LongExceptionId(long) - Constructor for class de.smartics.exceptions.id. LongExceptionId

Default constructor that creates the identifier instance.

M

Main - Class in de.smartics.exceptions.cli

Runs the report generator.

Main() - Constructor for class de.smartics.exceptions.cli. Main

Default constructor.

main(String...) - Static method in class de.smartics.exceptions.cli. Main

Launches the program.

majorNumber - Variable in class de.smartics.exceptions.code. NumberCodeInfo

The major number of the code defines a group of codes.

maxIndex(String) - Static method in class de.smartics.exceptions.i18n.message. MessageTemplateAnalyser

Find the greatest place holder index in the message.

MESSAGE_BUNDLE - Static variable in class de.smartics.exceptions.app. Constant

The name of the message bundle for all messages being logged.

MessageComposer - Interface in de.smartics.exceptions.i18n

The message composer creates messages from message templates by replacing the place holders with localized parameter values.

MessageParam - Annotation Type in de.smartics.exceptions.i18n.message

Adds information to a field of an exception about which parameter in a message it provides information.

MessageParamParser - Class in de.smartics.exceptions.i18n.message

This class provides methods to parse message parameter.

MessageParamParser.MessageParamInfo - Class in de.smartics.exceptions.i18n.message

Contains the index information for one message parameter.

MessageParamParser.MessageParamInfo(int, String) - Constructor for class de.smartics.exceptions.i18n.message. MessageParamParser.MessageParamInfo

Default constructor.

MessageTemplate - Enum in de.smartics.exceptions.i18n.message

Defines the valid identifiers for message templates.

MessageTemplateAnalyser - Class in de.smartics.exceptions.i18n.message

Analyses a message template.

MessageType - Enum in de.smartics.exceptions.i18n.message

Defines the valid message types to be displayed.

MethodAccessConfigurationException - Exception in de.smartics.exceptions.i18n

This exception is thrown if the configuration is not valid so that the system cannot evaluate the exception property.

MethodAccessConfigurationException(ConfigurationExceptionCode, String, Class<?>, String) - Constructor for exception de.smartics.exceptions.i18n. MethodAccessConfigurationException

Constructor.

MethodAccessConfigurationException(Throwable, ConfigurationExceptionCode, String, Class<?>, String) - Constructor for exception de.smartics.exceptions.i18n. MethodAccessConfigurationException

Constructor.

methodName - Variable in exception de.smartics.exceptions.i18n. MethodAccessConfigurationException

The name of the getter method that has been tried to accessed.

minorNumber - Variable in class de.smartics.exceptions.code. NumberCodeInfo

The minor number gives additional information about the problem.

MixedCodeComparator - Class in de.smartics.exceptions.report.sort

Compares exception code information instances.

MixedCodeComparator() - Constructor for class de.smartics.exceptions.report.sort. MixedCodeComparator

Default constructor.

N

NumberCode - Interface in de.smartics.exceptions.code

A specific code interface that deals with number codes.

NumberCodeComparator< T extends NumberCode> - Class in de.smartics.exceptions.code

The default code comparator compares the component and then the code numerical by major and minor number.

NumberCodeComparator() - Constructor for class de.smartics.exceptions.code. NumberCodeComparator

Default constructor.

NumberCodeInfo - Class in de.smartics.exceptions.code

This Code implementation models the exception code as a number.

NumberCodeInfo(Integer) - Constructor for class de.smartics.exceptions.code. NumberCodeInfo

Convenience constructor.

NumberCodeInfo(String, Integer) - Constructor for class de.smartics.exceptions.code. NumberCodeInfo

Convenience constructor.

NumberCodeInfo(String, Integer, Integer) - Constructor for class de.smartics.exceptions.code. NumberCodeInfo

Default constructor.

O

OgnlExpression - Class in de.smartics.exceptions.ognl

Wrapper for an OGNL expression.

OgnlExpression(String) - Constructor for class de.smartics.exceptions.ognl. OgnlExpression

Default constructor.

output - Variable in class de.smartics.maven.exceptions.sdoccode. AbstractSdocCodeMojo

The file to write to.

outputDirectory - Variable in class de.smartics.maven.exceptions. AbstractElementReport

Specifies the directory where the report will written to.

P

PackageSortedSinkReportGenerator - Class in de.smartics.maven.exceptions.report

Simple generator that generates with a Maven sink.

PackageSortedSinkReportGenerator() - Constructor for class de.smartics.maven.exceptions.report. PackageSortedSinkReportGenerator

Default constructor.

ParentMessageParam - Annotation Type in de.smartics.exceptions.i18n.message

Adds information to a field of the parent exception about which parameter in a message it provides information.

parse(String) - Static method in class de.smartics.exceptions.i18n.message. MessageParamParser

Splits the input string into message param informations.

ParseException - Exception in de.smartics.exceptions.i18n.message

This exception is thrown if a string cannot be parsed because information is missing or the format syntax is violated.

ParseException(ParseExceptionCode, String, String, int) - Constructor for exception de.smartics.exceptions.i18n.message. ParseException

Constructor.

ParseException(ParseExceptionCode, String, int) - Constructor for exception de.smartics.exceptions.i18n.message. ParseException

Constructor.

ParseException(Throwable, ParseExceptionCode, String, String, int) - Constructor for exception de.smartics.exceptions.i18n.message. ParseException

Constructor.

ParseException(Throwable, ParseExceptionCode, String, int) - Constructor for exception de.smartics.exceptions.i18n.message. ParseException

Constructor.

ParseExceptionCode - Enum in de.smartics.exceptions.i18n.app

Defines the parsing exception codes for this package.

parseParentMessageParam(String) - Static method in class de.smartics.exceptions.i18n.message. MessageParamParser

Parses the content of the parent message parameter.

PlaceHolderDesc - Class in de.smartics.exceptions.report.message

Information about a place holder.

PlaceHolderDesc(PlaceHolderDesc, MessageType) - Constructor for class de.smartics.exceptions.report.message. PlaceHolderDesc

Copy constructor with a new message type.

PlaceHolderDesc(PlaceHolderDescId, String, String, String) - Constructor for class de.smartics.exceptions.report.message. PlaceHolderDesc

Default constructor.

PlaceHolderDescId - Class in de.smartics.exceptions.report.message

Identifies a place holder description by its index an message type.

PlaceHolderDescId(int) - Constructor for class de.smartics.exceptions.report.message. PlaceHolderDescId

Convenience constructor for a place holder for any message type.

PlaceHolderDescId(int, MessageType) - Constructor for class de.smartics.exceptions.report.message. PlaceHolderDescId

Default constructor.

PlaceHolderHandler - Class in de.smartics.exceptions.report.message

Utilities to read place holder information from a class file.

PlaceHolderHandler(ProjectConfiguration<?>) - Constructor for class de.smartics.exceptions.report.message. PlaceHolderHandler

Utility class pattern.

PlaceHolderInfo - Class in de.smartics.exceptions.report.message

Contains the information about a set of place holders.

PlaceHolderInfo() - Constructor for class de.smartics.exceptions.report.message. PlaceHolderInfo

Default constructor.

pluginArtifacts - Variable in class de.smartics.maven.exceptions. AbstractElementReport

The plugin's dependencies to build the classpath for tools to be called.

pluginArtifacts - Variable in class de.smartics.maven.exceptions.sdoccode. AbstractSdocCodeMojo

The plugin's dependencies to build the classpath for tools to be called.

project - Variable in class de.smartics.maven.exceptions. AbstractElementReport

The Maven project.

project - Variable in class de.smartics.maven.exceptions.sdoccode. AbstractSdocCodeMojo

The Maven project.

PROJECT_NAME - Static variable in class de.smartics.exceptions.cli. Main

The name of the project to collect information for.

PropertiesConfiguredExceptionContext - Class in de.smartics.exceptions.context

The exception context is configured via a single properties file.

PropertiesConfiguredExceptionContext() - Constructor for class de.smartics.exceptions.context. PropertiesConfiguredExceptionContext

Default constructor.

PropertyAccessConfigurationException - Exception in de.smartics.exceptions.i18n

This exception is thrown if the configuration is not valid so that the system cannot evaluate the exception property.

PropertyAccessConfigurationException(ConfigurationExceptionCode, String, Class<?>) - Constructor for exception de.smartics.exceptions.i18n. PropertyAccessConfigurationException

Constructor.

PropertyAccessConfigurationException(Throwable, ConfigurationExceptionCode, String, Class<?>) - Constructor for exception de.smartics.exceptions.i18n. PropertyAccessConfigurationException

Constructor.

PropertyInfo - Annotation Type in de.smartics.exceptions.i18n.message

Adds information to a field to look for the getter and setter method.

propertyName - Variable in exception de.smartics.exceptions.i18n. PropertyAccessConfigurationException

The name of the property that cannot be accessed.

provideProperties(BaseConfiguration) - Static method in class de.smartics.exceptions.context. SystemDefaultExceptionContext

Sets the properties relevant to this implementation to the given configuration.

provideSink() - Method in class de.smartics.maven.exceptions. AbstractElementReport

Ensures that a writeable sink is provided.

putPlaceHolderDesc(PlaceHolderDesc) - Method in class de.smartics.exceptions.report.message. PlaceHolderInfo

Sets the description with its identifier to the map of place holder descriptions.

R

readPlaceholderDesc(ClassLoader, FieldDoc) - Method in class de.smartics.exceptions.report.message. PlaceHolderHandler

Reads the UsedBy annotation from the field documentation and analyzes the referenced class for place holder information.

REPORT_ENCODING - Static variable in class de.smartics.exceptions.cli. Main

The encoding of the report documentation.

REPORT_EXCLUDES - Static variable in class de.smartics.exceptions.cli. Main

The semicolon separated excluded directories.

REPORT_FILE - Static variable in class de.smartics.exceptions.cli. Main

The name of the report file to write.

REPORT_GENERATOR - Static variable in class de.smartics.exceptions.cli. Main

The class name of the report generator instance to use.

REPORT_INCLUDES - Static variable in class de.smartics.exceptions.cli. Main

The semicolon separated included directories.

resolver - Variable in class de.smartics.maven.exceptions. AbstractElementReport

The resolver for resolving artifacts.

resourceKey - Variable in class de.smartics.exceptions.i18n.message. LocalizedInfo

The localization key to fetch messages from message bundles.

run(ProjectConfiguration<XMLStreamWriter>) - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Delegates call to run(ProjectConfiguration,XMLStreamWriter) .

run(ProjectConfiguration<XMLStreamWriter>, XMLStreamWriter) - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Runs the reporting with the given configuration and writer.

run(String...) - Method in class de.smartics.exceptions.cli. Main

Runs with system properties.

run(ProjectConfiguration<XMLStreamWriter>) - Method in class de.smartics.exceptions.cli. Main

Delegates call to Main.run(ProjectConfiguration,XMLStreamWriter) .

run(ProjectConfiguration<XMLStreamWriter>, XMLStreamWriter) - Method in class de.smartics.exceptions.cli. Main

Runs the reporting with the given configuration and writer.

S

SdocCodeBuilder - Class in de.smartics.maven.exceptions.sdoccode.report

Creates the content for a projectdoc code doctype instance.

SdocCodeReportGenerator - Class in de.smartics.maven.exceptions.sdoccode.report

Writes individual reports in the projectdoc's code doctype.

SdocCodeReportGenerator() - Constructor for class de.smartics.maven.exceptions.sdoccode.report. SdocCodeReportGenerator

Default constructor.

setClasspath(Path) - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Sets the classpath to search for exception code classes.

setClasspathRef(Reference) - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Sets the classpath via an Ant reference to search for exception code classes.

setContext(ClassLoader, T) - Method in class de.smartics.exceptions.runtime. AbstractExceptionContextManager

Sets the configuration for the given class loader.

setCssFile(String) - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Sets the link reference to the CSS file to add to the head element of the generated HTML document.

setProject(MavenProject) - Method in class de.smartics.maven.exceptions. AbstractElementReport

Sets the maven project.

setProject(MavenProject) - Method in class de.smartics.maven.exceptions.sdoccode. AbstractSdocCodeMojo

Sets the maven project.

setProjectName(String) - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Sets the name of the project to collect information for.

setReportEncoding(String) - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Sets the encoding of the report documentation.

setReportExcludes(String) - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Sets the semicolon separated excluded directories.

setReportFile(String) - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Sets the name of the report file to write.

setReportGeneratorClass(String) - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Sets the class name of the report generator instance to use.

setReportIncludes(String) - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Sets the semicolon separated included directories.

setSourceEncoding(String) - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Sets the encoding of the Java source files.

setSourcepath(Path) - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Sets the source path to search for Javadoc for the exception code classes found on the classpath.

setSourcepathRef(Reference) - Method in class de.smartics.exceptions.ant. ExceptionCodesReportTask

Sets the source path via an Ant reference to search for Javadoc for the exception code classes found on the classpath.

setStackTrace(StackTraceElement[]) - Method in interface de.smartics.exceptions. CoreException

Sets the stack trace elements that will be returned by Throwable.getStackTrace() and printed by Throwable.printStackTrace() and related methods.

setValue(OgnlContext, Object, Object) - Method in class de.smartics.exceptions.ognl. OgnlExpression

Sets the value dependent on the OGNL expression.

SignedIncrementFactory - Class in de.smartics.exceptions.id

The factory that created ExceptionIds that provides a long number Counting starts per default at 1, continues to Integer.MAX_VALUE, to the negatives, ends with zero and starts at 1 (without a warning) again.

SignedIncrementFactory() - Constructor for class de.smartics.exceptions.id. SignedIncrementFactory

Default constructor with counter initialized with 1.

SignedIncrementFactory(long) - Constructor for class de.smartics.exceptions.id. SignedIncrementFactory

Convenience constructor.

siteRenderer - Variable in class de.smartics.maven.exceptions. AbstractElementReport

The Doxia site renderer.

skip - Variable in class de.smartics.maven.exceptions.sdoccode. AbstractSdocCodeMojo

A simple flag to skip the generation of the XML files.

split(String) - Static method in class de.smartics.exceptions.i18n.message. Helper

Parses the string and returns the comma separated elements as a list of String objects.

split(String, String) - Static method in class de.smartics.exceptions.i18n.message. Helper

Parses the string and returns the delimiter separated elements as a list of String objects.

StringFunction - Class in de.smartics.exceptions.report.generator

Utilities for this package.

SystemDefaultExceptionContext - Class in de.smartics.exceptions.context

An exception context with a UUID factory for default configuration.

SystemDefaultExceptionContext() - Constructor for class de.smartics.exceptions.context. SystemDefaultExceptionContext

Default constructor.

SystemDefaultI18nExceptionContext - Class in de.smartics.exceptions.i18n.context

An exception context with a UUID factory for default configuration.

SystemDefaultI18nExceptionContext() - Constructor for class de.smartics.exceptions.i18n.context. SystemDefaultI18nExceptionContext

Default constructor.

T

throwableHandleMode - Variable in class de.smartics.exceptions.context. AbstractExceptionContext

The configuration to control the handling of throwables.

ThrowableHandleMode - Enum in de.smartics.exceptions.core

Defines the modes how exceptions should be handled by the framework.

toSink(Object) - Method in class de.smartics.maven.exceptions. AbstractSinkReportGenerator

Makes the cast.

toString() - Method in exception de.smartics.exceptions. AbstractCoreException

Returns the string representation of the object for debugging.

toString() - Method in exception de.smartics.exceptions. AbstractCoreRuntimeException

Returns the string representation of the object for debugging.

toString() - Method in class de.smartics.exceptions.code. NumberCodeInfo

Returns the string representation of the object.

toString() - Method in enum de.smartics.exceptions.context. ExceptionContextProperty

Returns the string representation of the object.

toString() - Method in interface de.smartics.exceptions.core. Code

Returns the string representation of the code.

toString() - Method in interface de.smartics.exceptions.core. ExceptionId

Returns the string representation of the ID.

toString() - Method in enum de.smartics.exceptions.i18n.app. ConfigurationExceptionCode

Returns the string representation of the object.

toString() - Method in enum de.smartics.exceptions.i18n.app. ParseExceptionCode

Returns the string representation of the object.

toString() - Method in enum de.smartics.exceptions.i18n.context. I18nExceptionContextProperty

Returns the string representation of the object.

toString() - Method in class de.smartics.exceptions.id. LongExceptionId

Returns the UUID as a string.

toString() - Method in class de.smartics.exceptions.id. UuidExceptionId

Returns the UUID as a string.

toString() - Method in class de.smartics.exceptions.report.message. PlaceHolderDesc

Returns the string representation of the object.

toString() - Method in class de.smartics.exceptions.report.message. PlaceHolderDescId

Returns the string representation of the object.

truncateCause() - Method in exception de.smartics.exceptions. AbstractCoreException

Truncates the cause from the exception dependent on the ThrowableHandleMode set to the thread-local context.

truncateCause() - Method in exception de.smartics.exceptions. AbstractCoreRuntimeException

Truncates the cause from the exception dependent on the ThrowableHandleMode set to the thread-local context.

truncateCause() - Method in interface de.smartics.exceptions. CoreException

Truncates the cause from the exception dependent on the ThrowableHandleMode set to the thread-local context.

TwoNumberCodeInfo - Class in de.smartics.exceptions.code

This Code implementation models the exception code as a number.

TwoNumberCodeInfo(Integer) - Constructor for class de.smartics.exceptions.code. TwoNumberCodeInfo

Convenience constructor.

TwoNumberCodeInfo(String, Integer) - Constructor for class de.smartics.exceptions.code. TwoNumberCodeInfo

Convenience constructor.

TwoNumberCodeInfo(String, Integer, Integer) - Constructor for class de.smartics.exceptions.code. TwoNumberCodeInfo

Default constructor.

U

UsedBy - Annotation Type in de.smartics.exceptions.i18n.message

Provides a reference to a class or resource that uses the annotated element.

UuidExceptionId - Class in de.smartics.exceptions.id

An implementation where the exception identifier is modelled as an UUID.

UuidExceptionId() - Constructor for class de.smartics.exceptions.id. UuidExceptionId

Constructor to create an instance with a random UUID.

UuidExceptionId(UUID) - Constructor for class de.smartics.exceptions.id. UuidExceptionId

Default constructor that creates an instance with the given UUID.

UuidFactory - Class in de.smartics.exceptions.id

The factory that created ExceptionIds that provide UUIDs.

UuidFactory() - Constructor for class de.smartics.exceptions.id. UuidFactory

V

valueOf(String) - Static method in enum de.smartics.exceptions.context. ExceptionContextProperty

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum de.smartics.exceptions.core. ThrowableHandleMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum de.smartics.exceptions.i18n.app. ConfigurationExceptionCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum de.smartics.exceptions.i18n.app. ParseExceptionCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum de.smartics.exceptions.i18n.context. I18nExceptionContextProperty

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum de.smartics.exceptions.i18n.message. MessageTemplate

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum de.smartics.exceptions.i18n.message. MessageType

Returns the enum constant of this type with the specified name.

values() - Static method in enum de.smartics.exceptions.context. ExceptionContextProperty

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

values() - Static method in enum de.smartics.exceptions.core. ThrowableHandleMode

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

values() - Static method in enum de.smartics.exceptions.i18n.app. ConfigurationExceptionCode

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

values() - Static method in enum de.smartics.exceptions.i18n.app. ParseExceptionCode

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

values() - Static method in enum de.smartics.exceptions.i18n.context. I18nExceptionContextProperty

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

values() - Static method in enum de.smartics.exceptions.i18n.message. MessageTemplate

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

values() - Static method in enum de.smartics.exceptions.i18n.message. MessageType

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

W

write(Object, ProjectConfiguration, ReportData) - Method in class de.smartics.maven.exceptions.report. CodeSortedSinkReportGenerator

Writes the content of the report data to the stream.

writeContent(Object, ProjectConfiguration, ReportData) - Method in class de.smartics.maven.exceptions. AbstractSinkReportGenerator

writeContent(File, ProjectConfiguration<File>, ReportData) - Method in class de.smartics.maven.exceptions.sdoccode.report. SdocCodeReportGenerator

writeDocumentContent() - Method in class de.smartics.maven.exceptions.sdoccode.report. SdocCodeBuilder

Writes the content to the document.

writeFooter(Object, ProjectConfiguration) - Method in class de.smartics.maven.exceptions. AbstractSinkReportGenerator

writeInfoFooter(Object, ProjectConfiguration) - Method in class de.smartics.maven.exceptions. AbstractSinkReportGenerator

writeInfoHeader(Object, ProjectConfiguration, String, ClassDoc) - Method in class de.smartics.maven.exceptions. AbstractSinkReportGenerator

Writes the header and introduction text on a section 2.

writeInfoSubFooter(Object, ProjectConfiguration) - Method in class de.smartics.maven.exceptions. AbstractSinkReportGenerator

writeInfoSubHeader(Object, ProjectConfiguration, String) - Method in class de.smartics.maven.exceptions. AbstractSinkReportGenerator

writeReportElementInfo(XMLStreamWriter, ProjectConfiguration<XMLStreamWriter>, FieldDoc) - Method in class de.smartics.exceptions.report.generator. HtmlReportGenerator

writeReportElementInfo(Object, ProjectConfiguration, FieldDoc) - Method in class de.smartics.maven.exceptions. AbstractSinkReportGenerator

writeReportElementInfo(OutputStream, ProjectConfiguration<File>, CodeUtils.CodeContainer) - Method in class de.smartics.maven.exceptions.sdoccode.report. SdocCodeReportGenerator

writeTableHeader(XMLStreamWriter, ProjectConfiguration<XMLStreamWriter>) - Method in class de.smartics.exceptions.report.generator. HtmlReportGenerator

writeTableHeader(Object, ProjectConfiguration) - Method in class de.smartics.maven.exceptions. AbstractSinkReportGenerator

Writes the table header.

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