org.vishia.util

Interface InfoAppend

All Known Subinterfaces:

EventThread_ifc, EventTimerThread_ifc

All Known Implementing Classes:

EventTimerThread, OrderListExecuter, StateComposite, StateCompositeFlat, StateDeepHistory, StateMachine, StateMachine.StateCompositeTop, StateParallel, StateShallowHistory, StateSimple

public interface InfoAppend

Interface common use-able to append or returns an information about the instance adequate meaning like toString() for debugging and showing.

Advantage in comparison of toString(): If a complex information should be necessary only one time a StringBuilder is need to create which gathers all info. Often the content is used on the fly, for example for

   StringBuilder buffer = new StringBuilder(100);
   anyInstance.infoAppend(buffer);
   buffer.append("some more information");
   System.out.append(buffer);
 

If this information should be stored it is possible persistent as reference of type CharSequence. A reference which may changed the StringBuilder content should not be used.
On the other hand infoAppend(StringBuilder).toString() builds a persistent String of this information. The copy of content is done here at least only.

The info should end with a semicolon. Therewith it is able to parse or use for example in an Excel-csv-Format.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	version Version, history and license.

Method Summary

Modifier and Type	Method and Description
java.lang.CharSequence	infoAppend(java.lang.StringBuilder u) Appends or returns tan information about the instance.

Field Detail

version

static final java.lang.String version

Version, history and license.

• 2015-01-04 Hartmut created.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

Method Detail

infoAppend

java.lang.CharSequence infoAppend(java.lang.StringBuilder u)

Appends or returns tan information about the instance. It is similar Object.toString() but it works with a given StringBuilder.
Application pattern:

 StringBuilder u = new StringBulder(1000);
 u.append(something_else);
 
 myInstance.infoAppend(u);     //uses this interface
 
 u.append(some_more);
 System.out.append(u);             //output the information
 String savedInfo = u.toString();  //save permanent.
 

Implementing pattern

 QOverride public infoAppend(StringBuilder u) {
   if(u == null){ u = new StringBuilder(); }  //it can be null!
   u.append(special_information).append(": ").append(somewhatElse);
   return u;
 }
 

Contiguity with toString: It uses the same information, assembled in a StringBuilder:

 QOverride public String toString(){ return infoAppend(null).toString()); } 
 

Parameters:

u - if not null then the info is appended to u, u is returned.
if null then a String can be returned if it is sufficient.

Returns:

u if given or a new StringBuilder instance which contains the info or a String if it is sufficient.