Package adams.core

Interface Summary

Interface	Description
AdditionalDataProvider	Interface for GOE classes that provide additional information apart from the globalInfo() method.
AdditionalInformationHandler	Interface for GOE classes that provide additional information apart from the globalInfo() method.
ArrayProvider	For classes that can generate data either as an array or one-by-one.
AtomicMoveSupporter	Interface for classes that support atomic file move operations.
BufferSupporter	Interface for classes that support a buffer size.
ClassCompatibilityChecker	Interface for compatibility checkers.
ClassCrossReference	Interface for object that cross-reference other classes.
CleanUpHandler	Interface for classes that support cleaning up of memory.
CloneHandler<T>	Interface for getting around the problem with Java's design flaw in regards to interfaces cannot specify the clone method.
CrossReference	Ancestor for cross-reference interfaces.
CustomDisplayStringProvider	For classes that do not implement the OptionHandler interface and want to provide a custom display string in the GenericObjectEditor, which is more descriptive than the class name.
DateValueSupporter	Interface for classes that support date values.
DebugOutputHandler	For classes that support debugging output of some kind.
DeepCopyOperator	Interface for option handlers that can perform optional deep copies.
Destroyable	Interface for classes that need some further cleaning up that cannot be done with the CleanUpHandler, as it is destructive.
EnumWithCustomDisplay<T extends Enum>	For Enum classes that require a custom display string.
EnumWithCustomParsing<T extends Enum>	Interface for enums that have a custom parse method.
ErrorProvider	Interface for classes that record error messages.
ExampleProvider	Interface for classes that provide examples for usage, etc.
FailureIndicator	Interface for classes that need to indicate a failure.
GlobalInfoSupporter	Interface for classes that provide information on the class in the GenericObjectEditor.
HelpProvider	Interface for classes that provide some kind of help.
Iteratable	For classes that support iteration.
JsonSupporter	For classes that support JSON objects, e.g., displaying them.
LenientModeSupporter	Interface for classes that support a lenient or strict mode.
Mergeable<T>	For objects that allow merging.
MetaDataProvider	For classes that provide additional information for their objects.
MetaDataSupporter	Interface for objects that support meta-data.
MultiAttemptSupporter	Interface for classes that support multiple attempts.
MultiAttemptWithWaitSupporter	Interface for classes that support multiple attempts, but allow a waiting interval in between attempts.
OptionalRandomizable	Interface for classes that have support optional randomization.
OptionalThreadLimiter	Interface for classes that have optional thread limits.
PasswordPrompter	Interface for classes that prompt the user to enter a password.
PasswordSupporter	Interface for classes that handle a password.
Pausable	Interface for objects that can be paused and resumed.
QuickInfoSupporter	Interface for classes that return a short string describing their setup or internal state.
Randomizable	For classes that support seeded randomization in some sense.
SerializableObject	Interface for classes that handle their own serialization/deserialization.
ShallowCopySupporter<T>	Interface for classes that support shallow copying, i.e., basically only the setup without the internal state.
SizeOfHandler	Interface for classes that allow querying the objct size.
StatusMessageHandler	Interface for classes that can display a message string.
StatusMessageHandlerExt	Interface for classes that can display a message string, either left or right.
Stoppable	Interface for objects that can be stopped externally.
StoppableWithFeedback	Interface for objects that can be stopped externally.
TechnicalInformationHandler	For classes that are based on some kind of publications.
TextSupporter	Interface for classes that can supply text.
ThreadLimiter	Interface for classes that allow limiting the number of threads in use.
UniqueIDHandler	Interface for objects that support unique IDs.
VariablesHandler	Interface for classes that encapsulate (local) variable support.
VariablesInspectionHandler	Interface for classes that can restrict the inspection of certain classes.
VariableUpdater	Interface for classes that update variables.
VariableUser	Interface for classes that use variables.

Class Summary

Class	Description
AbstractDataBackedIndex<T>	Ancestor for index classes that can use names as index as well as the placeholders like 'first' and 'last'.
AbstractDataBackedRange<T>	Ancestor for range classes that allow additional names in the range string, just like placeholders for 'first', 'second', etc).
AbstractDataBackedRange.InvertedStringLengthComparator	Simply compares the length of the strings, with longer strings rating lower.
AbstractDataBackedUnorderedRange<T>	Ancestor for unordered range classes that allow additional names in the range string, just like placeholders for 'first', 'second', etc).
AbstractDataBackedUnorderedRange.InvertedStringLengthComparator	Simply compares the length of the strings, with longer strings rating lower.
AbstractFileBasedHistory<T extends File>	History for file objects.
AbstractHistory<T>	Ancestor for classes maintaining a history of objects.
AbstractPersistentHistory<T>	Ancestor of classes for maintaining a history of objects that are stored on disk.
ByteFormat	Formatting class for turning byte amounts into kb, mb, etc.
ByteFormatString	Wrapper for byte format strings.
ClassCompatibility	Class that determines compatibility between inputs and outputs.
ClassLister	Determines the classnames of superclasses that are to be displayed in the GUI for instance.
ClassListerJson	Same as ClassLister, but with support for outputting JSON when calling the main method.
CompareUtils	Utility class for comparisons.
ConfigurableEnumeration<T extends ConfigurableEnumeration.AbstractItem>	A more flexible way for enumerations.
ConfigurableEnumeration.AbstractItem<E extends ConfigurableEnumeration>	Represents a single item of an enumeration.
Constants	Contains some commonly used constants.
DateFormat	A threadsafe class for date formatting/parsing.
DateTime	A thin wrapper to distinguish between date and date/time.
DateTimeMsec	A thin wrapper to distinguish between date/teim and date/time msec.
DateUtils	A helper class for common Date-related operations.
DefaultCompare	Compares two Comparable objects.
DiffUtils	A helper class for generating diffs between two files, lists of strings.
DiffUtils.Filler	A helper class for the side-by-side diff.
DiffUtils.SideBySideDiff	Container object for a side-by-side diff.
EnumHelper	Helper class for enum-related operations.
ExcelHelper	Helper class for Excel-related stuff.
FileHistory	History for File objects.
FileNameCompare	Compares two File objects.
FindClass	For locating classes on the classpath.
FindClass.Listener	For collecting URLs.
IEEE754	Helper class for dealing with ieee754 encoded floats.
Index	A simple class that translates human-readable 1-based index strings (including "first", "second", "third", "last_2", "last_1" and "last") into integer indices.
ListHelper	Helper class for lists.
LittleEndian	Helper class for conversions related to Little-Endian.
LRUCache<K,V>	An LRU cache, based on LinkedHashMap. This cache has a fixed maximum number of elements (cacheSize).
Memory	A little helper class for Memory management.
MessageCollection	Container for collecting messages.
MicroSecondFormat	Formatting class for turning byte amounts into kb, mb, etc.
MicroSecondFormatString	Wrapper for microsecond format strings.
NamedCounter	Provides counters that can be referenced by a name.
NamedCounter.CounterComparator	Comparator for sorting the names based on the counts associated with them.
NewInstance	For instantiating objects, with or without custom constructor.
NumericStringCompare	Compares the numeric portion of two String objects by extracting it using the supplied regexp.
ObjectCopyHelper	Helper class for copying objects.
ODFHelper	Helper class for PDF-related stuff.
Performance	A convenience class for accessing the performance tuning parameters.
PlaceholderDirectoryHistory	History for PlaceholderDirectory objects.
PlaceholderFileHistory	History for PlaceholderFile objects.
Placeholders	A class for accessing the system-wide defined placeholders.
Properties	Enhanced java.util.Properties class.
PropertiesBasedEnumeration<T extends ConfigurableEnumeration.AbstractItem>	Enumeration that uses properties as backend.
PropertiesToCode	Turns a Properties object into Java code.
PublishSubscribeHandler	Manages publishing of data to subscribed listeners.
QuickInfoHelper	Helper class for assembling quick info strings returned by classes implementing QuickInfoSupporter.
Range	A class for managing a range of 1-based indices, e.g., 1-5, 3,7,9 or 1-7,9 (including "first", "second", "third", "last_2", "last_1" and "last").
Range.SubRange	Represents a sub-range, either a single number of from-to.
SecondFormat	Formatting class for turning byte amounts into kb, mb, etc.
SecondFormatString	Wrapper for microsecond format strings.
SerializableObjectHelper	Helper class for serializing an object's member variables.
SerializationHelper	A helper class for determining serialVersionUIDs and checking whether classes contain one and/or need one.
SerializedObject	Class for storing an object in serialized form in memory.
Shortening	Helper class for shortening operations.
SimpleTimer	Simple class for generating timings.
SizeOf	Helper class for measuring the size of objects using Maxim Zakharenkov's SizeOf agent or simply the length of the byte array generated by serialization.
StaticClassLister	Loads class names listed in props files, for cases when dynamic class discovery is not available (e.g., JUnit tests).
StoppableUtils	Methods for objects implementing the Stoppable interface.
StoppableUtils.StoppableObserver	Observer that records all the objects that implement the Stoppable interface.
StringHistory	History for arbitrary strings.
SystemInfo	Gathers information about system properties.
TechnicalInformation	Used for paper references in the Javadoc and for BibTex generation.
Time	A thin wrapper to distinguish between date and time.
TimeIt	Helper class for timing code execution.
TimeMsec	A thin wrapper to distinguish between date and time/msec.
Trie	A class representing a Trie data structure for strings.
Trie.TrieIterator	Represents an iterator over a trie
Trie.TrieNode	Represents a node in the trie.
UniqueIDs	Class for creating unique IDs.
UnorderedRange	Like Range, but enforces no ordering on indices.
Utils	Class implementing some simple utility methods.
VariableName	Wrapper around the name of a variable (= string).
VariableNameNoUpdate	Wrapper around the name of a variable (= string).
VariableNameValuePair	Wrapper for a name/value pair of a variable.
Variables	A container for storing variables and their values.
VariablesFinder	Option traverser for locating variables.
VariablesUtils	Helper methods around variable handling.
WrapperHashSet<E>	An extended HashSet that wraps its objects in a wrapper object before storing them in a HashSet.
WrapperHashSet.Wrapper	The class that wraps.

Enum Summary

Enum	Description
AutoOnOff	Enum that has three states: auto|on|off.
BasicDateTimeType	Basic date/time types.
BusinessDays	Enum for defining business days.
ByteFormat.Unit	The available units.
DateTimeType	Lists various date/time types.
JsonDataType	The data types for JSON.
MicroSecondFormat.Unit	The available units.
ObjectCopyHelper.CopyType	How to copy an object.
PositionType	Enumeration for positions.
PropertiesDataType	Data types that the Properties class handles.
SecondFormat.Unit	The available units.
ShorteningType	Determines where to shorten the comments.
TechnicalInformation.Field	the possible fields.
TechnicalInformation.Type	the different types of information.
TriState	Enum that enhances a boolean to have a third state: not set.
XPathResult	Enumeration for the types of output XPath can generate.

Exception Summary

Exception	Description
StoppedException	Specialized exception that can be thrown when a Stoppable scheme has been stopped.