Package org.vishia.util

This package contains commonly use able classes without any other dependency.

See: Description

Interface Summary

Interface	Description
Arguments.SetArgument	Interface for implementation of setting arguments.
CalculatorExpr.ExpressionType	Common interface to check and maybe change the type of expression.
CompleteConstructionAndStart	This interface supports a building and startup-process of static instances in three stage.
DataAccess.Conversion	Interface to convert between data.
FileFunction.AddFileToList
FileFunctions.AddFileToList
FilePath.FilePathEnvAccess	An implementation of this interface should be provided by the user if absolute paths and script variables should be used.
FilesToList.AddFileToList
GetTypeToUse	This interface is used to mark functionality to get a type to use with an instance.
IndexMultiTable.Provide<Key>	This interface is necessary to provide tables and the minimum and maximum value for any user specific type.
InfoAppend	Interface common use-able to append or returns an information about the instance adequate meaning like toString() for debugging and showing.
InfoFormattedAppend	Interface for a unique kind to add informations to a given StringFormatter instance.
IterableIterator<T>	This interface implements both a Iterator and a Iterable.
Java4C	This class contains annotations for the Java-to-C translation.
MarkMask_ifc	This is a universal interface to mark instances to support selection.
Removeable	This interface can be used on all classes which are intent to support removing of all referenced data and resources.
ReplaceAlias_ifc
SetLineColumn_ifc	This interface is used to mark functionality to set a line and column information.
SetSrcInfo_ifc	This interface is used to mark functionality to set the original source information.
SortedTree<Type extends SortedTree<Type>>	Interface to access data which are organized in a sorted tree.
SortedTreeWalkerCallback<TypeNode,TypeStartInfo>	A Callback interface for walking through any tree with more as one children per node.
StringFunctions_C.PrepareBufferPos	This interface is used also for StringFormatter to use similar approaches for setCharAt and append.
ThreadRun.Step
ToStringBuilder	This is an interface to support a more powerful toSString() capability.
TreeNode_ifc<DerivedNode extends TreeNode_ifc<DerivedNode,Data>,Data>	Interface for instances, which are organized with the TreeNodeBase class.
TreeNodeCallback<DerivedNode extends TreeNodeBase<DerivedNode,?,?>>	This interface is used as callback for any walk action through a tree structure.
TreeNodeNamed_ifc

Class Summary

Class	Description
AccessPolicy	This interface determines how a field can be accessed or how the reference-return value of an operation can be used.
ApplMain	This is a new replacement for the org.vishia.mainCmd.MainCmd which is now deprecated.
Arguments	This is a base class for simple argument handling of main(...) arguments.
Arguments.Argument	Class to describe one argument.
Assert	Deprecated use ExcUtil
CalculatorExpr	This class provides a calculator for expressions.
CalculatorExpr.Data	It is the data instance for the caluclation.
CalculatorExpr.ExprTypes
CalculatorExpr.Operand	Operand for a part of the expression, refer from CalculatorExpr.Operation.
CalculatorExpr.Operation	An Operation in the list of operations.
CalculatorExpr.Operator	An operator for the current value (accu), the given second value maybe the operand from the CalculatorExpr.Operation, or for some additional values in stack.
CalculatorExpr.Operators	This class contains all Operators as static references.
CalculatorExpr.SetExprBase	This class and its inner class CalculatorExpr.SetExprBase.SetExpr is a helper class which contains a CalculatorExpr as composite.
CalculatorExpr.Value	A value, maybe a constant, any given Object or an access description to a java program element.
CallbackTemplate<DerivedNode extends TreeNodeBase<DerivedNode,?,?>>
CheckVs	Deprecated use ExcUtil
Conversion	This class contains some conversion routine.
Copy
DataAccess	This class contains methods to access and set data and invoke methods with symbolic access using reflection mechanism.
DataAccess.Conversions	This inner class contains all possible automatic special conversions.
DataAccess.DataAccessSet	This class extends its outer class and provides the capability to set the data path especially from a ZBNF parser result.
DataAccess.DatapathElement	Class holds one element for access to data.
DataAccess.DatapathElementClass	Variant of a DatapathElement which can contain a ClassLoader for a new Java class or a static method invocation or a Class which's field, method or constructor should access.
DataAccess.Dst	Result of an DataAccess#access(List, Object, Map, boolean, boolean, boolean, Dst) to store a value.
DataAccess.IntegerIx	Wrapper around the index as integer.
DataAccess.ObjMethod
DataAccess.SetDatapathElement	This class extends a DataAccess.DatapathElement and provides the capability to set the data path especially from a ZBNF parser result, see ZbnfJavaOutput.
DataAccess.Test
DataAccess.Variable<T>	This class wraps any Object which is used for a variable.
DataShow	This class supports output of the content of any instance maybe with associated other Objects.
DateOrder	This class contains the current time stamp of creation and a counted number of instances which are created in the same millisecond.
Debugutil
Docu_UML_simpleNotation	This is a only-documentation class for simple UML notation.
ExcUtil
FileAppend	This class is a alternative to java.io.FileWriter.
FileAppend.Wr
FileCompare	This class contains a functionality to compare file also in sub directories.
FileCompare.Result	Class contains the comparison result for two files or sub directories in both trees.
FileFunction	This class is a container for some static routines and sub classes to deal with file content.
FileFunction.FileCheckPath	Not ready yet.
FileFunctions	This class contains some static file and command line functions.
FileFunctions.FileAndBasePath	This class holds a File with its Basepath.
FileFunctions.FilesWithBasePath	Temporary class used only inside FileFunctions.addFilesWithBasePath(java.io.File, java.lang.String, java.util.List<org.vishia.util.FileFunctions.FileAndBasePath>).
FileFunctions.ListWrapper	This class supports the call of FileFunctions.addFileToList(String, List).
FileList	This class creates a list which information about a file tree and supports change timestamp of given files (touch).
FileList.Args
FilePath	This class holds a path to a file with its parts: base path, directory path, name, extension, drive letter etc and supports getting String-paths in several forms - absolute, relative, name only, extension, with slash or backslash etc.
FilePath.XXXZbnfFilepath	Deprecated This is the only one reason that the fields of FilePath are fine graduated.
FilepathFilter	This class helps to check whether a String given path and name matches to a mask String.
FilepathFilter.NameFilter
FilepathFilter.PathFilter
FilepathFilterM	Filter for a file path maybe with wildcards in the directory path and also with a multi selection.
FileSet	A Fileset instance contains some FilePath maybe with a common path.
FilesToList	This class uses the Files.walkFileTree(Path, FileVisitor) capability to gather files to a list with a given path with wildcards.
FilesToList.FileCheckPath
FileSystem	This class supports some functions of file system access as enhancement of the class java.io.File independently of other classes of vishia packages, only based on Java standard.
FileWriter	Deprecated use instead FileAppend
IndexMultiTable<Key extends java.lang.Comparable<Key>,Type>	This class contains sorted references of objects (values) with a sorting key (usual String or Integer) in one or more tables of a defined size.
IndexMultiTable_Table<Key extends java.lang.Comparable<Key>,Type>	One Table for a IndexMultiTable.
IndexMultiTable.IteratorHelper<Key extends java.lang.Comparable<Key>,Type>	This class contains the data for a IndexMultiTable.IteratorImpl for one table.
IndexMultiTable.XXXTable<Key extends java.lang.Comparable<Key>,Type>	One table contains keys and values in two array lists in sorted order.
IndexMultiTableInteger<Type>	This class contains sorted references of objects with an integer key in tables of a limited size, but more as one table (a tree) if necessary.
IndexMultiTableInteger.IteratorHelper	This class contains the data for a IndexMultiTableInteger.IteratorImpl for one table.
IndexMultiTableInteger.IteratorImpl<Type>	This class is the Iterator for the outer class.
InfoFormattedAppend.PrepareToString	Helper for simple application in toString().
IntegerBlockArray	This class is a int array.
IterableIndirect<Tsrc,Tdst>	Iterator which returns an indirect instance because of a given Iterable.
IterableMapValue<T>	This class prepares an Map.entrySet() to an Iterable over the values.
IteratorArrayMask<T>	An instance of this class iterates over an array and returns elements which are marked with the mask.
IteratorMask<T>
KeyCode	This class helps to present key codes and other events in combination with shift, alt, control in a maybe readable form.
LeapSeconds	This class supports the handling with Leap seconds.
MessageQueue<EntryType>
MinMaxTime	This class helps to measurement the cycle- and calculation times of any cyclically routine.
Num	Contains some numeric operations able to use in JzTxtCmd
ObjectId	This class manages identifications of Objects (instances).
ObjectId.InstancesOfType
ObjectValue
OrderListExecuter	Deprecated use EventTimerThread
OutputTwice	This class outputs to 2 destination, for example an opened file and System.out.
OutTextPreparer	This class helps to prepare output texts with data.
OutTextPreparer.Argument
OutTextPreparer.CallCmd
OutTextPreparer.Cmd
OutTextPreparer.CmdString
OutTextPreparer.DataTextPreparer	Instances of this class holds the data for one OutTextPreparer instance but maybe for all invocations.
OutTextPreparer.DebugCmd
OutTextPreparer.ExecCmd
OutTextPreparer.ForCmd
OutTextPreparer.IfCmd
OutTextPreparer.SetCmd
PathCheck	This class helps to check names whether they match with a path.
PipeRingBuffer	This class is a RingBuffer which can use as pipe.
ReadChars3Stream	This class helps to convert a special ASCII format in a byte[].
RetOrException	This class offers some static routines to handle exception situations with a special return value or with an exception.
SelectMask	This is a standard implementation of the universal interface to mark instances as select-able and to support selection.
ShortenString	Method to shorten strings to a maximum length.
ShortenString.StringNr
Sort
SortedList	This abstract class supports sorting Objects in a list with a string-oriented key.
SortedStringList	Implementation of SortedList for String Objects.
SortedTreeNode<Type extends SortedTree<Type>>	Commonly implementation of a Node in a sorted tree.
SpecialCharStrings	This class helps to handle with special chars in Strings.
StdHexFormatWriter	This class writes binary data in the Intel-Standard-Hex-Format.
StringAdd	This is a small helper class to add something to build a String for optimized calculate time and space effort.
StringArray
StringCmp	The routines of this class are used to compare Strings especially for tests.
StringFormatter	This class supports a formatted output of something in a string buffer.
StringFunctions	This class contains static String functions without any other dependency able to use with CharSequence (instead java.lang.String).
StringFunctions_B
StringFunctions_C	Contains routines to convert String to number format.
StringFunctions_C.PrepareAppendablePos	Implementation of the StringFunctions_C.PrepareBufferPos for a simple Appendable
StringPart	The StringPart class represents a flexible valid part of a character string which's spread is changeable.
StringPart.Part	This class presents a part of the parent CharSequence of this class.
StringPartAppend	This class combines an Appendable with the capability of StringPartScan.
StringPartFromFile	Deprecated use StringPartFromFileLines
StringPartFromFileLines	This class extends the StringPartScan to determine the content with reading the String from a file, from a file resource in jar file or from any other opened resource as Reader.
StringPartScan	This class extends the capability of StringPartBase for scanning capability.
StringSeq	This class wraps any CharSequence and provides comparable features like String for commonly usage.
TestOrg	This class supports testing.
ThreadContext
ThreadRun	This class builds a Thread which runs a routine in a cycle.
TimedValues	This class offers a head structure for timed values, typically measurement values.
TimedValues.Track
Timeshort	This class supports working with a short time which may be count in microseconds or any other unit, and its conversion to an absolute time stamp.
TreeNodeBase<DerivedNode extends TreeNodeBase<DerivedNode,Data,IfcType> & SortedTree<IfcType>,Data,IfcType extends SortedTree<IfcType>>	This class is a base class for data, which are organized itself in a tree node structure.
TreeNodeBase.MetaNode<DerivedNode extends TreeNodeBase<DerivedNode,Data,IfcType> & SortedTree<IfcType>,Data,IfcType extends SortedTree<IfcType>>
TreeNodeBase.TreeNode<Data>	This class provides a ready to use TreeNode without additional functionality like TreeNodeBase.
TreeNodeHtmlOutput	Outputs the content of a TreeNode_ifc in a html format to view internal data for debugging.
TreeNodeUniqueKey<T>	* UML-Diagramm, presentation style see Docu_UML_simpleNotation:
TreeWalkerPathCheck	This class is a tree walker which checks the names of nodes with a mask path.
Writer_Appendable	This class creates a java.io.Writer instance with a given Appendable.

Enum Summary

Enum	Description
IndexMultiTable.KindofAdd
OutTextPreparer.ECmd
SortedTreeWalkerCallback.Result	It is similar FileVisitResult.
TreeNodeCallback.Result	It is similar FileVisitResult.

Exception Summary

Exception	Description
UnexpectedException	Use this exception type if an exception is not expected.

Annotation Types Summary

Annotation Type	Description
AccessPolicy.ChangeAccess	Annotation for an argument or field which is definite changed especially it is an reference as argument of an operation.
AccessPolicy.NonPersist	Annotation for a argument.
AccessPolicy.ReadOnly	Annotation for an operation which do not modify its instance or for a reference which cannot be used to modify the data.
AccessPolicy.ReadOnlyRet	Annotation for an operation which do not modify its instance and which's returned reference is @ReadOnly itself, can only be assigned to a @ReadOnly reference.
DataShow.ExcludeShowContent	If a Field is designated with this annotation then the content is not shown.
Java4C.ByteStringJc	The byte[] array is provided in C like a MemC reference.
Java4C.ConstRef	Produces a const modifier for a reference (refers a const object).
Java4C.ConstThis	Produces a const modifier for the thiz- reference.
Java4C.DynamicCall	Designates that the following variable is a variable for dynamic call, a method-table-reference.
Java4C.EmbeddedData	Defines that the instance is embedded in C.
Java4C.Exclude	The method or field is not existing for C-translation.
Java4C.ExcludeBlock	This annotation to any local variable of a block forces exclusion of this block for C translation.
Java4C.ExcludeCond	A boolean variable designated with this annotation forces that an if-block which tests this variable is not translated to C.
Java4C.ExcludeImpl	The implementation of the method is not translated to C.
Java4C.ExcludeInterface	In C the class does not implement the named interface.
Java4C.ExtendsOnlyMethods	The class contains only methods.
Java4C.FixArraySize	Sets that the following array has a fix size.
Java4C.Inline	The method is translated building a simple macro or inline method for C++.
Java4C.InstanceType	A reference in C refers always this instance type though the reference has a lesser type.
Java4C.InThCxtLocal	Marks that reference which's instance created with new Type().. is located in C in the thread context.
Java4C.InThCxtRet	Marks that reference which's instance created with new Type().. is located in C in the thread context.
Java4C.NonPersistent	The String is used only non-Persist or a CharSequence is used as non-Persist String.
Java4C.NoObject	Defines that the class Type{ ... } does not base on ObjectJc in C.
Java4C.NoStackTrace	The method does not create an own stack trace for debug and error handling support.
Java4C.ParseError	Only a help for forcing a Java2C parsing error especially for sophisticated Java2XMI conversion behaviour, only for test.
Java4C.PtrVal	The array which is designated with PtrVal is provided in C with a PtrVal_Type reference.
Java4C.Retinline	The method is translated building a simple macro or inline method for C++ which returns a value.
Java4C.ReturnInThreadCxt	Marks that the returned instance is located in the thread context.
Java4C.ReturnNew
Java4C.ReturnThis	Marks that this is returned to support concatenation.
Java4C.SimpleArray	Sets that the following array has not a Array head structure - not an ObjectArrayJ.
Java4C.SimpleArrayRef	Sets the following array as simple reference.
Java4C.SimpleArraySize	Sets that the following array as a simple embedded Array with the given size.
Java4C.SimpleRef	Sets the following association as simple pointer in C, without garbage collection usage.
Java4C.SimpleVariableRef	Sets the following array as simple reference.
Java4C.StackInstance	Defines that the Type instance = new Type(args); is only used in this method, in Java garbaged after the end of the method and therefore it is possible to create an instance as Stack variable in C language.
Java4C.StringBuilderInStack
Java4C.StringBuilderInThreadCxt
Java4C.StringJc	The CharSequence reference should be used as a StringJc instance.
Java4C.ToStringNonPersist	The String is designated as non-persistent, especially located in ThreadContext.
Java4C.ZeroTermString	Declare the String as const char* in C-language.

Package org.vishia.util Description

This package contains commonly use able classes without any other dependency. They are groups of functionality:

• String-handling: StringFunctions, StringPart, StringFormatter
• File-handling: FileSystem,
• Sorting: IndexMultiTableInteger, SortedTree
• Event handing and State machines: Event, org.vishia.util.StateSimpleBase