org.vishia.util

Class StringFormatter

java.lang.Object

org.vishia.util.StringFormatter

All Implemented Interfaces:

java.io.Flushable, java.lang.Appendable, StringFunctions_C.PrepareBufferPos

public final class StringFormatter
extends java.lang.Object
implements java.lang.Appendable, java.io.Flushable, StringFunctions_C.PrepareBufferPos

This class supports a formatted output of something in a string buffer. In completion to the capability of java.lang.String.format() (since Java-5) and the class java.util.Formatter this class provides

• a presentation of some hex formats and memory content as complete line.
• a so named picture driven formating, see setIntPicture(long, String) or setFloatPicture(long, String)
• the possibility of set and add content

To merge java.util.Formatter and this class you should assign the same StringBuffer to both classes.
The class contains add...-methods and knows internally a current position. The current position can be setted with pos(int). In the default overwrite mode the add methods do not insert in buffer with shifting the rest to right (like StringBuffer.insert()), but they overwrite the content at the currrent position. The wording 'add' means, the current position is increment, so the next add()-operation adds something behind the previous add()-operation. In the insert mode the content at pos_ is shifted to right.
Every pos(int)-operation is successfully. If the buffer in shorter as the required position, spaces will be filled onto the required position. So a buffer content can also be filled first right, than left.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	StringFormatter.Appendable_Intern Helper class only internally for static functions which outputs to Appendable, It appends a prepared number of characters to this buffer on pos_++

Field Summary

Fields

Modifier and Type	Field and Description
private StringFormatter.Appendable_Intern	appendable See StringFormatter.Appendable_Intern, only internal usage.
private boolean	bInsert True than add inserts, false than it overwrites.
private boolean	bShouldLineoutClose
protected java.lang.StringBuilder	buffer
private char	cDecimalSeparator
(package private) java.text.SimpleDateFormat	dateFormatNewer
(package private) java.text.SimpleDateFormat	dateFormatOlder
(package private) java.text.SimpleDateFormat	dateFormatToday
(package private) java.text.SimpleDateFormat	dateFormatYear
static short	k1 The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side.
static short	k2left The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side.
static short	k2right The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side.
static short	k4left The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side.
static short	k4right The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side.
static short	k6left The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side.
static short	k6right The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side.
static short	k8left The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side.
static short	k8right The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side.
protected java.lang.Appendable	lineout Destination to output a full line.
private static byte	mBytesInWordBigEndian If this bit is set in mode, the byte with the lower index is interpreted as higher part of word and is written left in insertHexLine().
private static byte	mNrofBytesInWord
protected int	pos_ The position of actual writing.
protected int	posLine_
(package private) java.lang.String	sDatePrefixNewer
(package private) java.lang.String	sDatePrefixOlder
(package private) java.lang.String	sDatePrefixToday
(package private) java.lang.String	sDatePrefixYear
private char	secondNewline The last written Character on append(char).
private java.lang.String	sNewline
private static java.lang.String	spaces
static java.lang.String	version Version, history and license.

Constructor Summary

Constructors

Constructor and Description
StringFormatter()
StringFormatter(java.lang.Appendable lineout, boolean shouldClose, java.lang.String newlineString, int defaultBufferLength) Constructs an instance with a linked line-out channel and a StringBuffer of the given length.
StringFormatter(int length) Constructs an instance with a StringBuffer of the given length.
StringFormatter(java.lang.String str) Constructs an instance with a StringBuffer initialized with the given string.
StringFormatter(java.lang.StringBuilder buffer) Constructs an instance with a existing StringBuffer.

Method Summary

Modifier and Type	Method and Description
StringFormatter	add(char ch)
StringFormatter	add(char[] str) Adds at the current position a char[].
StringFormatter	add(java.lang.CharSequence str) Adds on the current position a string.
StringFormatter	add(java.lang.String str) Adds at the current position a string.
StringFormatter	addBinary(int value, java.lang.String sPicture, java.lang.String sBitCharLo, java.lang.String sBitCharHi) Adds a number containing in a long variable in hexa form
StringFormatter	addBool(boolean value, java.lang.String hilo) Adds one character for a boolean value.
void	addBufferPos(char cc) Adds a character either on end (Appendable#append) or on a defined position
StringFormatter	addDate(java.util.Date date, java.text.SimpleDateFormat format)
StringFormatter	addFloat(double value, int digitsBeforePoint, int digitsAfterPoint) adds a double value in a fix point representation without exponent.
int	addFloatPicture(float src, java.lang.String pict) Writes a float value in technical representation with exponent as short char a..T NOTE: This algorithm is taken over from C++ routines in strpict.cpp written by JcHartmut in 1993..1999.
StringFormatter	addHex(long value, int nrofDigitsArg) Adds a number containing in a long variable in hexa form
StringFormatter	addHex44(long value) Adds a number in form 12ab'cd34, it is typical to show 4-byte-values at example addresses.
void	addHexBlock(byte[] data, int from, int to, short bytesInLine, short mode) Writes a block in hex.
StringFormatter	addHexLine(byte[] data, int idx, int nrofBytes, short mode) Adds at the current position a line of hex numbers.
static java.lang.String	addHexLn(byte[] data, int length, int idxStart) Adds a line with representation of byte content in a fixed nice format.
private StringFormatter	addHexWord_(byte[] data, int idx, short mode) Adds a number as one word readed from data in hexa form, internal routine without prepareBufferPos
StringFormatter	addHexWord(byte[] data, int idx, short mode) Adds a number as one word readed from data in hexa form
StringFormatter	addint(long nr, java.lang.String sPict) Sets a integer value at current position, use the picture to determine the number of characters etc.
StringFormatter	addIntPicture(long nr, java.lang.String sPict) Deprecated. see addint(long, java.lang.String)
StringFormatter	addReplaceLinefeed(java.lang.CharSequence str, java.lang.CharSequence replaceLinefeed, int maxCharsArg) Adds the given str at the current position but replaces line feed characters by given one.
StringFormatter	addStringLine(byte[] data, int idx, int nrofBytes, java.lang.String charsetName) Adds a line of ascii representation of bytes.
StringFormatter	append(char c) Appends one character and flushes a line on end-line character.
StringFormatter	append(java.lang.CharSequence csq) It invokes append(char) for any char.Therewith a \n and \r is handled specially.
StringFormatter	append(java.lang.CharSequence csq, int start, int end) It invokes append(char) for any char.Therewith a \n and \r is handled specially.
void	close() close of StringFormatter stores yet existing text in a aggregated lineout A lineout is the first argument of ctor StringFormatter(Appendable, boolean, String, int) Then this Stringformatter is reset().
java.lang.String	convertTimestampToday(long timestamp) Converts a timestamp in a String representation with dateFormatToday etc.
StringFormatter	end() Sets the current position to the end of the string.
void	flush()
int	flushLine(java.lang.String sNewline) Flushes the stored content in the lineout and adds the given sNewline
java.lang.CharSequence	getBuffer() Gets the accumulated content.
java.lang.String	getContent() Gets the accumulated content.
int	getPos() returns the current position for add in buffer.
StringFormatter	insert() sets the insert mode.
StringFormatter	insert(java.lang.String str) Inserts a String at current position with shifting the actual content to right.
int	length() returns the current length of string.
void	newline()
StringFormatter	overwrite() sets the overwrite mode.
StringFormatter	pos(int newPos) Sets the current write position to the given position.
StringFormatter	pos(int newPos, int minChars) Sets the current write position to the given position.
int	prepareBufferPos(int nrofChars) Ensures, that the space in buffer started on pos is writeable with setCharAt.
int	replace(java.lang.String search, int from, java.lang.CharSequence src) Replaces the given String in the buffer with a new CharSequence.
int	replaceHolder(java.lang.String name, java.lang.String value) Replaces a String "<&name>" with the given value.
StringFormatter	reset() Resets the internal buffer.
StringFormatter	setAt(int pos_, char ch)
void	setDecimalSeparator(char sep) Sets an deviant decimal separator for floating point digigs, country-specific.
boolean	setInsertMode(boolean insert) sets the insert or overwrite mode, returns the current mode before change.
java.lang.String	toString() Same as getContent, overwrites Object.toString().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

version

public static final java.lang.String version

Version, history and license.

• 2023-01-28 bugfix! The change on 2022-06-05 was really not proper tested. Using for emC test cases with JZtxtcmd preparation offers a big bug: A content with more as one lines (the test case lines) were not proper stored. The problem was: Using pos_ as insertion position, and not (posLine_ + pos_) which is necessary after this change, in many operations. The change was done: prepareBufferPos(int) returns the insertion pos, can be used, that is consequent. The prepareBufferPos(int) may also set the new position after insertion due to its argument 'nrofChars', but this is not done. Instead the using operations are responsible to increment pos_ by itself. It may be important that in special cases also posLine_ is incremented, that is done now correctly but cannot be done in prepareBufferPos(int). Hence for change later, have a boolean argument whether set the new position. Now it is primary correct.
• 2022-08-03 new addHexLine(byte[], int, int, short) programmed but not used and not tested yet.
• 2022-06-05: Hartmut now warning-free, all used with this. and some argument accesses
• 2022-06-05: Hartmut support of more as one line: After newline() the position counts from 0 for the next line, and a next line can be prepared. It is tested for a simple example in testJava_vishiaBase but not yet elaborately used. The other also proper possibility is: Store the line in an Appendable, so that the StringFormatter has anytime only one line. This may be better. The concept should be considered before elaborately usage. The idea was, for vertical test recording of signals.
• 2022-05-24: Hartmut The strPicture(long, String, String, char) is now contained in StringFunctions_C.strPicture(long, String, String, char, org.vishia.util.StringFunctions_C.PrepareBufferPos) because common usage. Tu fulfill, the interface StringFunctions_C.PrepareBufferPos is implemented here.
• 2022-03-04: Hartmut new: addHex(long, int) now uses StringFunctions_C.appendHex(Appendable, long, int). For that the StringFormatter.Appendable_Intern instance is necessary.
• 2022-03-04: Hartmut new: addBool(boolean, String), interesting for hardware simulation.
• 2022-02-14: Hartmut trouble with close() again. Now this class is not Closeable, because of too much sophisticated warnings. close() is now optional. It flushs, closes and removes the content if a lineout exists, else does nothing.
• 2020-03-14: Hartmut trouble with close(). Only if #lineout exists and the content was flushed, the content is deleted yet. That is always true. After close the content is able to evaluate respectively stored furthermore in the aggregated getContent() if no lineout is given. See documentation to close().
• 2018-09-20: Hartmut new #addHexBlock(byte[], int, int, short, short))
• 2018-09-17: addHex(long, int) with upper chars
• 2015-06-07: Hartmut chg: append(char) and flushLine(String), now output of the given line end is supported if the StringFormatter(Appendable, boolean, String, int) argument 'newlineString' is null.
• 2015-01-31: Hartmut add(String) additional to add(CharSequence) only for Java2C-translation. In Java it is equal.
• 2014-08-10: Hartmut bugfix: append(char): if more as one line feed 0d 0a 0d 0a follows, it was recognized as only one line feed.
• 2014-05-10: Hartmut new: implements Closeable, close(), ctor StringFormatter(Appendable, boolean, String, int) to close the aggregated appendable. Need for JZcmd
• 2014-03-13: Hartmut new pos(int, int)
• 2013-03-31: Hartmut new convertTimestampToday(long)
• 2013-01-19: Hartmut new: addReplaceLinefeed(CharSequence, CharSequence, int).
• 2009-05-03: Hartmut bugfix in strPicture: nr of inserted chars was incorrect.
• 2009-03-10: Hartmut new: addDateSeconds() and addDate()
• 2007-09-12: Hartmut www.vishia.org creation copy from vishia.stringScan.StringFormatter
• 2008-04-28: Hartmut setDecimalSeparator() to produce a Germany-MS-Excel-friendly format.
• 2007...: Creation
• 1999...: The basics for the #strPicture(long, String, String, char) was created in C++

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 ist 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

mNrofBytesInWord

private static final byte mNrofBytesInWord

See Also:

Constant Field Values

mBytesInWordBigEndian

private static final byte mBytesInWordBigEndian

If this bit is set in mode, the byte with the lower index is interpreted as higher part of word and is written left in insertHexLine(). Otherwise the byte with the lower index is interpreted as higher lower part of word and is written right.

See Also:

Constant Field Values

k1

public static final short k1

The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side. left = first byte of a byte[] array is written left sided (like big endian coding), right = first byte of a byte[] array is written right sided (like necessary in little endian coding)

See Also:

Constant Field Values

k2right

public static final short k2right

The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side. left = first byte of a byte[] array is written left sided (like big endian coding), right = first byte of a byte[] array is written right sided (like necessary in little endian coding)

See Also:

Constant Field Values

k2left

public static final short k2left

The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side. left = first byte of a byte[] array is written left sided (like big endian coding), right = first byte of a byte[] array is written right sided (like necessary in little endian coding)

See Also:

Constant Field Values

k4right

public static final short k4right

The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side. left = first byte of a byte[] array is written left sided (like big endian coding), right = first byte of a byte[] array is written right sided (like necessary in little endian coding)

See Also:

Constant Field Values

k4left

public static final short k4left

The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side. left = first byte of a byte[] array is written left sided (like big endian coding), right = first byte of a byte[] array is written right sided (like necessary in little endian coding)

See Also:

Constant Field Values

k6right

public static final short k6right

The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side. left = first byte of a byte[] array is written left sided (like big endian coding), right = first byte of a byte[] array is written right sided (like necessary in little endian coding)

See Also:

Constant Field Values

k6left

public static final short k6left

The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side. left = first byte of a byte[] array is written left sided (like big endian coding), right = first byte of a byte[] array is written right sided (like necessary in little endian coding)

See Also:

Constant Field Values

k8right

public static final short k8right

The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side. left = first byte of a byte[] array is written left sided (like big endian coding), right = first byte of a byte[] array is written right sided (like necessary in little endian coding)

See Also:

Constant Field Values

k8left

public static final short k8left

The constant determine the number of digits representing a (hex) value and the decision, use first byte left or right side. left = first byte of a byte[] array is written left sided (like big endian coding), right = first byte of a byte[] array is written right sided (like necessary in little endian coding)

See Also:

Constant Field Values

spaces

private static final java.lang.String spaces

See Also:

Constant Field Values

buffer

protected final java.lang.StringBuilder buffer

lineout

protected java.lang.Appendable lineout

Destination to output a full line. If not null, then the line will be written if a \n character is in the buffer.

bShouldLineoutClose

private final boolean bShouldLineoutClose

secondNewline

private char secondNewline

The last written Character on append(char). If it is a '\r' a following '\n' does not force a newline. If if is a '\n' a following '\r' does not force a newline.

pos_

protected int pos_

The position of actual writing.

posLine_

protected int posLine_

bInsert

private boolean bInsert

True than add inserts, false than it overwrites.

sNewline

private java.lang.String sNewline

cDecimalSeparator

private char cDecimalSeparator

sDatePrefixNewer

java.lang.String sDatePrefixNewer

dateFormatNewer

java.text.SimpleDateFormat dateFormatNewer

sDatePrefixToday

java.lang.String sDatePrefixToday

dateFormatToday

java.text.SimpleDateFormat dateFormatToday

sDatePrefixYear

java.lang.String sDatePrefixYear

dateFormatYear

java.text.SimpleDateFormat dateFormatYear

sDatePrefixOlder

java.lang.String sDatePrefixOlder

dateFormatOlder

java.text.SimpleDateFormat dateFormatOlder

appendable

private final StringFormatter.Appendable_Intern appendable

See StringFormatter.Appendable_Intern, only internal usage.

Constructor Detail

StringFormatter

public StringFormatter()

StringFormatter

public StringFormatter(java.lang.Appendable lineout,
                       boolean shouldClose,
                       java.lang.String newlineString,
                       int defaultBufferLength)

Constructs an instance with a linked line-out channel and a StringBuffer of the given length. If a '\n' character will be append(char) or append(CharSequence) or append(CharSequence, int, int) to this instance, the part till the '\n' will be written to the lineout and removed. It means the internal buffer contains only the current line. This current line can be formatted in the known kind.

Parameters:

lineout - Any appendable (Writer)

shouldClose - if true then closes the lineout if this is closed. If true lineout have to be instanceof Closeable.

newlineString - usual "\n", "\r\n" or "\r". If null then the newline characters or output as usual. See append(char).

defaultBufferLength - usual about 100..200 for the length of line. The buffer will be increased if a longer line is necessary.

StringFormatter

public StringFormatter(int length)

Constructs an instance with a StringBuffer of the given length.

Parameters:

length - length of the internal StringBuffer.

StringFormatter

public StringFormatter(java.lang.String str)

Constructs an instance with a StringBuffer initialized with the given string.

Parameters:

str - initial value.

StringFormatter

public StringFormatter(java.lang.StringBuilder buffer)

Constructs an instance with a existing StringBuffer. The StringBuffer content is unchanged first. The StringBuffer may be shared between several StringFormatter and can also be written directly.

Parameters:

buffer - The buffer.

Method Detail

toString

public java.lang.String toString()

Same as getContent, overwrites Object.toString(). Don't use it instead getContent(), use it only for debugging goals.

Overrides:

toString in class java.lang.Object

getContent

public java.lang.String getContent()

Gets the accumulated content.

Returns:

The string representing the accumulated content.

getBuffer

public java.lang.CharSequence getBuffer()

Gets the accumulated content.

Returns:

The buffer representing the accumulated content.

setDecimalSeparator

public void setDecimalSeparator(char sep)

Sets an deviant decimal separator for floating point digigs, country-specific.

reset

public StringFormatter reset()

Resets the internal buffer. If it is called after usage of the String getting with getContent(), no additional space is used.

end

public StringFormatter end()

Sets the current position to the end of the string.

pos

public StringFormatter pos(int newPos)

Sets the current write position to the given position.

pos

public StringFormatter pos(int newPos,
                           int minChars)

Sets the current write position to the given position. If minChars <0 then the position may be set to left. Existing text will be overridden. If minChars >=0 then the new position is at least the number of minChars right side to the current pos. If the pos_ is less the buffer.length, all characters right of pos_ in the buffer will be overridden on the next add- or append- operation. This condition is valid independent of this method. If the pos_ is more right than the length of the buffer, spaces will be included.

replaceHolder

public int replaceHolder(java.lang.String name,
                         java.lang.String value)

Replaces a String "<&name>" with the given value. It is similar JZtxtcmd-Placeholder-Syntax.

Parameters:

name -

value -

Returns:

-1 if not found, else the position of the replacing.

replace

public int replace(java.lang.String search,
                   int from,
                   java.lang.CharSequence src)

Replaces the given String in the buffer with a new CharSequence.

Parameters:

search - the String to replace

from - search from this position

src - the replaces string

Returns:

-1 no replacing, not found, else the position of the replacing.

length

public int length()

returns the current length of string.

getPos

public int getPos()

returns the current position for add in buffer.

prepareBufferPos

public int prepareBufferPos(int nrofChars)

Ensures, that the space in buffer started on pos is writeable with setCharAt. If the buffer content is less than pos + nrofChars, spaces were padded.

Specified by:

prepareBufferPos in interface StringFunctions_C.PrepareBufferPos

Parameters:

nrofChars - after pos to write somewhat.

Returns:

the position in buffer to save the content till pos + nrofChars prepared

add

public StringFormatter add(java.lang.CharSequence str)

Adds on the current position a string.

Parameters:

str - String

Returns:

this

add

public StringFormatter add(java.lang.String str)

Adds at the current position a string. It is extra for Java2C-translation, elsewhere the same like add(CharSequence)

Parameters:

str - String

Returns:

this

addReplaceLinefeed

public StringFormatter addReplaceLinefeed(java.lang.CharSequence str,
                                          java.lang.CharSequence replaceLinefeed,
                                          int maxCharsArg)

Adds the given str at the current position but replaces line feed characters by given one. This method can be used proper if a part of a multi-line-text should be presented in one line for example for logs.

Parameters:

str - to insert

replaceLinefeed - String with 4 characters, first replaces a 0x0a, second for 0x0d, third for 0x0c,4.for all other control keys.

maxCharsArg - limits length to insert

Returns:

this

add

public StringFormatter add(char ch)

add

public StringFormatter add(char[] str)

Adds at the current position a char[].

Parameters:

str - char array. 0-chars from backward are not added.

Returns:

this

insert

public StringFormatter insert(java.lang.String str)

Inserts a String at current position with shifting the actual content to right.

Parameters:

str -

Returns:

overwrite

public StringFormatter overwrite()

sets the overwrite mode. It is the default. In this mode add will overwrite the current content.

insert

public StringFormatter insert()

sets the insert mode. In this mode add will shift the content at pos_ to right.

setInsertMode

public boolean setInsertMode(boolean insert)

sets the insert or overwrite mode, returns the current mode before change.

Parameters:

insert - true than insert, false than overwrite.

Returns:

true if insert was current, false if overwrite was current.

addStringLine

public StringFormatter addStringLine(byte[] data,
                                     int idx,
                                     int nrofBytes,
                                     java.lang.String charsetName)

Adds a line of ascii representation of bytes. If the code is less than 0x20 (control chars), a '.' is shown instead.

Parameters:

data - byte data

idx - offset

bytes - nr of bytes

charsetName - encoding, typical "ISO-8859-1" or "US-ASCII", using "UTF-8" more as one byte may be present 1 char.

Returns:

addHexLine

public StringFormatter addHexLine(byte[] data,
                                  int idx,
                                  int nrofBytes,
                                  short mode)

Adds at the current position a line of hex numbers.

Parameters:

data - byte data

idx - offset

bytes - nr of bytes

mode - mode see k1 to k8Right

Returns:

this

addHexBlock

public void addHexBlock(byte[] data,
                        int from,
                        int to,
                        short bytesInLine,
                        short mode)
                 throws java.io.IOException

Writes a block in hex.

Parameters:

data -

from -

to - exclusive position. 0: till end. negativ: position back from end.

bytesInLine -

mode - nr of bytes in word, | mBytesInWordBigEndian if necessary.

Throws:

java.io.IOException

addHexWord

public StringFormatter addHexWord(byte[] data,
                                  int idx,
                                  short mode)

Adds a number as one word readed from data in hexa form

Parameters:

data - byte data

idx - offset

mode - nr of bytes and big/little endian, use k4BytePerWordLittleEndian etc.

Returns:

this itself

addHexWord_

private StringFormatter addHexWord_(byte[] data,
                                    int idx,
                                    short mode)

Adds a number as one word readed from data in hexa form, internal routine without prepareBufferPos

Parameters:

data - byte data

idx - offset

mode - nr of bytes and big/little endian, use k4BytePerWordLittleEndian etc.

Returns:

this itself

addHex

public StringFormatter addHex(long value,
                              int nrofDigitsArg)

Adds a number containing in a long variable in hexa form

Parameters:

value - the value

nrofDigits - if negativ then writes with upper cases

Returns:

this itself

addBool

public StringFormatter addBool(boolean value,
                               java.lang.String hilo)

Adds one character for a boolean value.

Parameters:

value - the value

hilo - must have two characters. "hl" write left character for true value, right char for false

Returns:

this itself

addBinary

public StringFormatter addBinary(int value,
                                 java.lang.String sPicture,
                                 java.lang.String sBitCharLo,
                                 java.lang.String sBitCharHi)

Adds a number containing in a long variable in hexa form

Parameters:

value - the value

mode - Ones of k1BytePerWordBigEndian to k4BytePerWordLittleEndian resp. k1MSD to k8LSD

sPicture - String as picture of output. A char 1 means, output the bit. Other chars are copied in output.

sBitCharLo - Characters for lo bit at the same position like sPicture

sBitCharHi - Characters for hi bit at the same position like sPicture

Returns:

this itself

addHex44

public StringFormatter addHex44(long value)

Adds a number in form 12ab'cd34, it is typical to show 4-byte-values at example addresses.

addFloat

public StringFormatter addFloat(double value,
                                int digitsBeforePoint,
                                int digitsAfterPoint)

adds a double value in a fix point representation without exponent.

Parameters:

value - The value

digitsBeforePoint - Number of digits before decimal separator. If the number of digits of the value is less, spaces will be outputted instead. The decimal separator will be set at the same position everytime independent of the value.

digitsAfterPoint - Number of digits after decimal separator. All digits will be shown.

Returns:

this itself.

addHexLn

public static java.lang.String addHexLn(byte[] data,
                                        int length,
                                        int idxStart)

Adds a line with representation of byte content in a fixed nice format. Use a combination of addHexLine(byte[], int, int, int) and [addStringLine(byte[], int, int, String) to write a special defined format. This method writes 4-digit hex values lo byte right and the ASCII-represantation inclusive a \n char on end. It is a static method working internal with StringFormatter.

addDate

public StringFormatter addDate(java.util.Date date,
                               java.text.SimpleDateFormat format)

setAt

public StringFormatter setAt(int pos_,
                             char ch)

addint

public StringFormatter addint(long nr,
                              java.lang.String sPict)

Sets a integer value at current position, use the picture to determine the number of characters etc.
The presentation of values using a so named 'picture' is supported. The picture is a String showing the representation of a number. Following some examples. Note: a character _ means a space.

picture	Example numbers
	0	1	-123	12345	12345678
+2221.111	A integer number will be shown with exactly 7 digits. A point is set between digits at the shown position. The sign is shown everytime, as + or - The number shows like a float point number. At example the value in integer is a milli-Value, the user can read it in a comfortable format.
	+___0.000	+___0.001	-___0.123	+__12.2345	+####.###
+3321.111	A integer number will be shown with a maximum of 7 digits, but a minimum of 5 digits. The sign is shown only if it is necessary. Because leftside there is a 3 a positive sign needs no space.
	_0.000	_0.001	-_0.123	12.345	##.###

The digits of the number are shown at any position of digit in the picture, The last significant digit is placed at right side of digit in the picture. Followed rules of meaning of the chars are in force:

char	meaning
0	The digit 0 in number is alway shown, also leftside or rightside.
1	A leftside ditit 0 in number is shown as 0, but a rightside 0 is shown as space.
2	A leftside or rightside digit 0 of number is shown as space, any middle digit 0 is shown as 0.
3	In differece to 2, a leftside or rightside digit 0 produces no output. With the number of 3-digits, the maximal shown number of digits is limited. At example with a picture "3331.03" only a maximum of 7 digits are shown, but a minimum of 3 digits.

Parameters:

value - A value as integer, it is a long type (64 bit). Range from -9223372036854775808 to 9223372036854775807, about 10 power 19. It is a possible style to apply float values with multiplication to show float values with a fix position of decimal point.

picture - The picture of digit.

Returns:

this to support concatenation.

addIntPicture

@Deprecated
public StringFormatter addIntPicture(long nr,
                                                  java.lang.String sPict)

Deprecated. see addint(long, java.lang.String)

addFloatPicture

public int addFloatPicture(float src,
                           java.lang.String pict)

Writes a float value in technical representation with exponent as short char a..T NOTE: This algorithm is taken over from C++ routines in strpict.cpp written by JcHartmut in 1993..1999.

The representation of the number uses always three digits left of point. The exponent is shown as short character:

• a, f p, n, u, m for ato, femto, pico, nano, micro, milli (10^-18 to 10^-3)
• . or space if the exponent is 0,
• k, M, G, T for kilo, Mega, Giga, Terra (10^3 to 10^12).

The parameters nDigit and mode controls the representation:

	nDigit, mode	Parameters: src - The number pict - picture of the float number. Returns: Number of chars written (to calculate column width). convertTimestampToday public java.lang.String convertTimestampToday(long timestamp) Converts a timestamp in a String representation with dateFormatToday etc. Parameters: timestamp - Returns: append public StringFormatter append(java.lang.CharSequence csq) throws java.io.IOException It invokes append(char) for any char.Therewith a \n and \r is handled specially. Specified by: append in interface java.lang.Appendable Throws: java.io.IOException See Also: Appendable.append(java.lang.CharSequence) newline public void newline() throws java.io.IOException Throws: java.io.IOException append public StringFormatter append(char c) throws java.io.IOException Appends one character and flushes a line on end-line character. If the char is a 0x0d or 0x0a (carriage return, line-feed) and the constructor StringFormatter(Appendable, boolean, String, int) was used with a given lineout, then the buffered line (buffer is output and a sNewline is added if given. It uses flushLine(String) If a 0x0a is given and the last char was 0x0d or vice versa, this second newline character is prevented because 0d 0a is only one line feed. 0a0d is recognized as one line feed too. If 0d0a0d is given, that are two newlines. If the text is mixed with 0d0a, 0a, 0d etc. both 0d or 0a are detected as end line character and the following alternate character is ignored. Specified by: append in interface java.lang.Appendable Throws: java.io.IOException Since: 2015-06 if the sNewline argument on StringFormatter(Appendable, boolean, String, int) is given with null, then all characters are output unchanged. But the functionality to flush a line on a 0d or 0a is supported all the same. See Also: Appendable.append(char) append public StringFormatter append(java.lang.CharSequence csq, int start, int end) throws java.io.IOException It invokes append(char) for any char.Therewith a \n and \r is handled specially. Specified by: append in interface java.lang.Appendable Throws: java.io.IOException See Also: Appendable.append(java.lang.CharSequence) flush public void flush() throws java.io.IOException Specified by: flush in interface java.io.Flushable Throws: java.io.IOException flushLine public int flushLine(java.lang.String sNewline) throws java.io.IOException Flushes the stored content in the lineout and adds the given sNewline Parameters: sNewline - null then does not append a newline, elsewhere usual "\r\n", "\r" etc. It is possible to set for example "\n " to force an indentation. Returns: Number of characters in the line flushed, maybe 0. Note: The sNewline is handled even though. Throws: java.io.IOException close public void close() throws java.io.IOException close of StringFormatter stores yet existing text in a aggregated lineout A lineout is the first argument of ctor StringFormatter(Appendable, boolean, String, int) Then this Stringformatter is reset(). If the lineout is closeable, it will be closed and removed. Then this operation returns with true. If the lineout is not closeable, it will be also removed. This instance is really closed. It may be garbaged. If a lineout is not aggregated, this operation does nothing. The content is preserved. It can be still evaluated. But it should not be written furthermore. Throws: java.io.IOException See Also: Closeable.close() addBufferPos public void addBufferPos(char cc) throws java.io.IOException Description copied from interface: StringFunctions_C.PrepareBufferPos Adds a character either on end (Appendable#append) or on a defined position Specified by: addBufferPos in interface StringFunctions_C.PrepareBufferPos Throws: java.io.IOException Skip navigation links Overview Package Class Tree Deprecated Index Help Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method