Package eu.simuline.util

Utility classes: very inhomogeneous. These are used in projects Arith, Relana, ArithIntOctave and Testhelpers. Currently linked, but in the long run, either eliminated or in a separate project. To decide this, it must be analyzed which projects need which classes. | Class | Arith | Relana | ArithIntOct.. | Testhelp.. | | ------------------------- | ------- | ------ | ------------- | ----------- | | AbstractMultiSet | - | - | - | - | | ArraysExt |ContFrac | | | | | BasicTypesCompatibilityChecker- | - | - | - | - | internal | BitSetList | buffer | | | | | Caster | - | - | - | - |internal | CollectionsExt | multip | - | - | - | | Comparators | l2ra | - | - | - | | CyclicArrayList |graphDv | - | - | - | | CyclicIterator |graphDv | - | - | - | | CyclicList |graphDv | - | - | - | | DataModel |fpga | - | - | - | | DetOs |fpga | | | | | EmptyCyclicListException | - | - | - |internal | FIFOList | - | - | - | - |internal | Finder | tex | - | parser | - | | HashMultiSet | - | - | - | - | | JavaPath | - | - | - | x | | ListMap |fpga | - | - | - | sgml | ListSet | - | - | - | - | internal | MultiSet | x | - | - | - | | MultiSetIterator | x | - | - | - | | NotYetImplementedException | | | | | PathFinder | - | - | - | - | | RealRepresentation | - | - | - | - | | SoftEnum | - | - | - | - | | SortedMultiSet | x | - | - | - | | StringPool | - | - | - | - | | Strings | tex | - | - | x | | SwingWorker | - | - | - | - | | TreeMultiSet | x | - | - | - | | TwoSidedList | x | | | | | VMArgs | - | - | - | - |

• Framework providing the MultiSets, plain and sorted SortedMultiSet, both interfaces and implementing classes: AbstractMultiSet which is the base class of all concrete classes. There are two, HashMultiSet which is just a MultiSet and TreeMultiSet which is even a SortedMultiSet. **** bad design: immutable. of TreeMultiSet set and of HashMultiSet
• Cyclic lists: CyclicList, CyclicArrayList and CyclicIterator, and also EmptyCyclicListException
• Two sided lists: TwoSidedList
• Extension classes CollectionsExt and ArraysExt
• very inhomogeneous rest.

x ***** NOT YET COMPLETE.

Interface Summary

Interface	Description
CyclicIterator<E>	An iterator over a CyclicList.
CyclicList<E>	An ordered cyclic list.
Finder.Callable	To be implemented by java classes to apply a filter to a file and give feedback whether this filter succeeded.
JavaPath.FileWrapper	Wrapps a file directly found within a directory or within a zip-archive which also includes jar-archives.
MultiSet<T>	Represents a set with multiplicities.
MultiSet.Multiplicity	Represents the multiplicity of an entry of the enclosing multi-set.
MultiSetIterator<E>	Generalization of iterator suitable e.g. for sets to MultiSets.
PathFinder.Callable	To be implemented by java classes to apply a filter to a path and give feedback whether this filter succeeded.
RealRepresentation.Cutter	A Cutter is used to shorten numbers.
SortedMultiSet<T>	Represents a sorted set with multiplicities.

Class Summary

Class	Description
AbstractMultiSet<MAP extends Map<T,MultiSet.Multiplicity>,T>	Represents an abstract MultiSet based on a Map.
AbstractMultiSet.MultiplicityImpl	Serves as a wrapper object for a multiplicity AbstractMultiSet.MultiplicityImpl.mult.
AbstractMultiSet.MultiSetIteratorImpl<T>	A canonical implementation of MultiSetIterator defining also the methods modifying the underlying MultiSet, namely AbstractMultiSet.MultiSetIteratorImpl.remove(), AbstractMultiSet.MultiSetIteratorImpl.setMult(int) and AbstractMultiSet.MultiSetIteratorImpl.removeMult(int).
ArraysExt<E>	An add on to the class Arrays.
ArraysExt.ArrayComparator<O>	Comparator class which implements a kind of lexical ordering on arrays based on the ordering of the components defined by atomic.
BasicTypesCompatibilityChecker	Provides methods to map basic types to their wrappers, to map wrapper types to the corresponding basic types and for compatibility checks.
BitSetList	Implements a list of integers 0 and 1 stored as bits in a BitSet.
Caster	Provides ways to transform instances of various classes into one another.
Caster.Trivial	This is a trivial caster.
CollectionsExt<E>	An add on of the core class Collections.
CollectionsExt.AbstractImmutableCollection<C extends Collection<E>,E>	A class of Collections of elements of class E extending C initially throwing an UnsupportedOperationException when trying to modify the collection either directly or via its iterator(s) or via a transparent view like List.subList(int, int).
CollectionsExt.AbstractImmutableMultiSet<C extends MultiSet<E>,E>	A MultiSet which prevents being modified by throwing an exception for the modifying methods.
CollectionsExt.ImmutableCollection<E>	A collection which prevents being modified by throwing an exception for the modifying methods.
CollectionsExt.ImmutableCyclicList<E>	Represents an immutable cyclic list by throwing an exception when invoking a method which modifies this list.
CollectionsExt.ImmutableList<E>	A list which prevents being modified by throwing an exception for the modifying methods.
CollectionsExt.ImmutableMultiplicity	An immutable implementation of the multiplicity interface.
CollectionsExt.ImmutableMultiSet<E>	A multi-set which prevents being modified by throwing an exception for the modifying methods.
CollectionsExt.ImmutableSet<E>	A set which prevents being modified by throwing an exception for the modifying methods.
CollectionsExt.ImmutableSortedMultiSet<E>	A sorted multi-set which prevents being modified by throwing an exception for the modifying methods.
CollectionsExt.ImmutableSortedSet<E>	A sorted set which prevents being modified by throwing an exception for the modifying methods.
CollectionsExt.NonModifyingCyclicIterator<E>	An interator which prevents modification on the underlying list, by throwing an exception for the modifying methods.
Comparators<E>	Collection of static methods related with Comparators.
Comparators.AsListed<E>	Implements an ordering given by the list Comparators.AsListed.seq.
Comparators.Cascade<E>	Represents a comparator which is a cascade of comparators: Starting with the first comparator in Comparators.Cascade.seq asks the next comparator if the current one detects equality.
CyclicArrayList<E>	Resizable-array implementation of the CyclicList interface.
CyclicArrayList.CyclicArrayIterator<E>	An iterator over a CyclicList.
FIFOList<E>	The FIFOList class represents a first-in-first-out (FIFO) stack of objects.
Finder	Emulates the unix shell command find which is invoked as find [-H] [-L] [-P] [-Olevel] [-D help|tree|search|stat|rates|opt|exec] [path...]
Finder.AndFilter	One of the logical operations of filters: Returns a filter which passes a file iff all original filters in Finder.AndFilter.filters do so.
Finder.ExecFilter	Filter executing a shell command and passes the file received if the shell command succeeds according to its return code.
Finder.ExecJavaFilter	Filter executing a java class implementing Finder.Callable which passes the file received if the method Finder.Callable.call(File) succeeds according to its return code.
Finder.Filter	Represents a file filter.
Finder.NameFilter	Filters files by name.
Finder.NegFilter	One of the logical operations of filters: Returns a filter which passes a file iff the original filter Finder.NegFilter.tbNegFilter does not.
Finder.OrFilter	One of the logical operations of filters: Returns a filter which passes a file iff at least one of the original filters in Finder.OrFilter.filters do so.
Finder.Primary	The most basic kind of finder: Method Finder.path(File) returns an instance of this.
Finder.Secondary	A finder wrapping a Finder.Filter.
HashMultiSet<T>	Represents a set with multiplicities based on a HashMap.
JavaPath	Represents a path to find class and source files on.
JavaPath.OrdFileWrapper	Represents an ordinary file JavaPath.OrdFileWrapper.file on a file system.
JavaPath.ZipEntryWrapper	Represents a file JavaPath.ZipEntryWrapper.entry which is an entry in a zip-file JavaPath.ZipEntryWrapper.zipFile.
ListMap<K,V>	A SortedMap with ordering given by the ordering by which the keys are added.
ListSet<E>	This class implements the Set interface, backed by a java.util.ArrayList.
PathFinder	Emulates the unix shell command find which is invoked as find [-H] [-L] [-P] [-Olevel] [-D help|tree|search|stat|rates|opt|exec] [path...]
PathFinder.AndFilter	One of the logical operations of filters: Returns a filter which passes a path iff all original filters in PathFinder.AndFilter.filters do so.
PathFinder.ExecFilter	Filter executing a shell command and passes the path received if the shell command succeeds according to its return code.
PathFinder.ExecJavaFilter	Filter executing a java class implementing PathFinder.Callable which passes the path received if the method PathFinder.Callable.call(Path) succeeds according to its return code.
PathFinder.Filter	Represents a path filter.
PathFinder.NameFilter	Filters paths by name.
PathFinder.NegFilter	One of the logical operations of filters: Returns a filter which passes a path iff the original filter PathFinder.NegFilter.tbNegFilter does not.
PathFinder.OrFilter	One of the logical operations of filters: Returns a filter which passes a path iff at least one of the original filters in PathFinder.OrFilter.filters do so.
PathFinder.Primary	The most basic kind of finder: Method PathFinder.path(Path) returns an instance of this.
PathFinder.Secondary	A finder wrapping a PathFinder.Filter.
RealRepresentation	Describes the representation of a real value, which may be either a double, resp. a Double-value or a BigDecimal for use in tables.
RealRepresentation.BigDecimalRep	Describes the representation of a BigDecimal-value.
RealRepresentation.Desc	Describes the way the real number represented by RealRepresentation is displayed as a string.
RealRepresentation.DoubleRep	Describes the representation of a double, resp. a Double-value.
RealRepresentation.Number2SignUnsigned	Container for number splitted into sign and unsigned.
SoftEnum<E extends SoftEnum<E>>	This class is inspired by Enum and is intended as common base class of classes we shall call 'soft enums'.
StringPool	Provides various strings used in various classes, e.g. in messages.
Strings	Collection of static methods related to strings.
SwingWorker	This is the 3rd version of SwingWorker (also known as SwingWorker 3), an abstract class that you subclass to perform GUI-related work in a dedicated thread.
SwingWorker.ThreadVar	Class to maintain reference to current worker thread under separate synchronization control.
TreeMultiSet<T>	Represents a sorted set with multiplicities based on a TreeMap.
TwoSidedList<E>	Compared to a classical list, the first index of this list may well be positive and negative indices are allowed as well.
VMArgs

Enum Summary

Enum	Description
CollectionsExt.Modification	Enumerates the kinds of modifications on a Collection.
CyclicArrayList.StateIter	Enumeration of the state of an iterator.
DataModel	Enumerates categories of data models and determines the current data model.
DetOs	Enumerates the most important operating system and determines the current operating system.
JavaPath.ClsSrc	Determines whether a class file or a source file is meant.
TwoSidedList.Direction	Used as an argument for methods adding or removing elements from this list to determine in which direction this list has to shrink or grow.

Exception Summary

Exception	Description
EmptyCyclicListException	Thrown by various methods in CyclicList.
NotYetImplementedException	Thrown if a place in the code is reached, where implementation is not finished.