com.tomasteubner.common.core.util

Class ArrayFormatter

java.lang.Object

com.tomasteubner.common.core.util.ArrayFormatter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ArrayFormatter
extends Object
implements Closeable, Flushable

A class for formatting arrays as strings.

Author:

Tomas Teubner

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_POSTFIX The default postfix terminating the array's string representation.
static String	DEFAULT_PREFIX The default prefix starting the array's string representation.
static String	DEFAULT_SEPARATOR The default separator between array elements.

Constructor Summary

Constructors

Constructor and Description
ArrayFormatter() Simplified constructor based on a new Formatter.
ArrayFormatter(Formatter formatter) Simplified constructor using default prefix, separator and postfix.
ArrayFormatter(Formatter formatter, String prefix, String separator, String postfix) Main constructor.

Method Summary

Modifier and Type	Method and Description
static String	asString(boolean[] a, String conversion) Represent boolean array as String using default prefix, separator and postfix.
static String	asString(boolean[] a, String conversion, String prefix, String separator, String postfix) Represent boolean array as String.
static String	asString(byte[] a, String conversion) Represent byte array as String using default prefix, separator and postfix.
static String	asString(byte[] a, String conversion, String prefix, String separator, String postfix) Represent byte array as String.
static String	asString(double[] a, String conversion) Represent double array as String using default prefix, separator and postfix.
static String	asString(double[] a, String conversion, String prefix, String separator, String postfix) Represent double array as String.
static String	asString(float[] a, String conversion) Represent float array as String using default prefix, separator and postfix.
static String	asString(float[] a, String conversion, String prefix, String separator, String postfix) Represent float array as String.
static String	asString(int[] a, String conversion) Represent integer array as String using default prefix, separator and postfix.
static String	asString(int[] a, String conversion, String prefix, String separator, String postfix) Represent integer array as String.
static String	asString(long[] a, String conversion) Represent long array as String using default prefix, separator and postfix.
static String	asString(long[] a, String conversion, String prefix, String separator, String postfix) Represent long array as String.
static String	asString(short[] a, String conversion) Represent short array as String using default prefix, separator and postfix.
static String	asString(short[] a, String conversion, String prefix, String separator, String postfix) Represent short array as String.
static <T> String	asString(T[] a, String conversion) Represent array of objects as String using default prefix, separator and postfix.
static <T> String	asString(T[] a, String conversion, String prefix, String separator, String postfix) Represent array of objects as String.
void	close() Closes the formatter this ArrayFormatter is based upon.
void	flush() Flushed the formatter this ArrayFormatter is based upon.
ArrayFormatter	format(boolean[] a, String conversion) Writes a formatted boolean array to this object's destination.
ArrayFormatter	format(byte[] a, String conversion) Writes a formatted byte array to this object's destination.
ArrayFormatter	format(double[] a, String conversion) Writes a formatted double array to this object's destination.
ArrayFormatter	format(float[] a, String conversion) Writes a formatted float array to this object's destination.
ArrayFormatter	format(int[] a, String conversion) Writes a formatted integer array to this object's destination.
ArrayFormatter	format(long[] a, String conversion) Writes a formatted long array to this object's destination.
ArrayFormatter	format(short[] a, String conversion) Writes a formatted short array to this object's destination.
ArrayFormatter	format(String format, Object... args) Writes a formatted string to this object's destination.
<T> ArrayFormatter	format(T[] a, String conversion) Writes a formatted array of objects to this object's destination.
int	getLimit() Return the maximum number of array elements displayed for each array formatted.
String	getMoreFormat() Return format used to indicate the number of elements suppressed at the end of the array.
Appendable	out() Return the Appendable this formatter writes to.
void	setLimit(int limit) Set the maximum number of array elements displayed for each array formatted.
void	setMoreFormat(String moreFormat) Set format used to indicate the number of elements suppressed at the end of the array.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SEPARATOR

public static final String DEFAULT_SEPARATOR

The default separator between array elements.

See Also:

Constant Field Values

DEFAULT_PREFIX

public static final String DEFAULT_PREFIX

The default prefix starting the array's string representation.

See Also:

Constant Field Values

DEFAULT_POSTFIX

public static final String DEFAULT_POSTFIX

The default postfix terminating the array's string representation.

See Also:

Constant Field Values

Constructor Detail

ArrayFormatter

public ArrayFormatter(Formatter formatter,
                      String prefix,
                      String separator,
                      String postfix)

Main constructor.

Parameters:

formatter - the Formatter this ArrayFormatter will be based on

prefix - the prefix starting the array's string representation.

separator - the separator between array elements.

postfix - the postfix terminating the array's string representation.

ArrayFormatter

public ArrayFormatter(Formatter formatter)

Simplified constructor using default prefix, separator and postfix.

Parameters:

formatter - the Formatter this ArrayFormatter will be based on

ArrayFormatter

public ArrayFormatter()

Simplified constructor based on a new Formatter.

Method Detail

getLimit

public int getLimit()

Return the maximum number of array elements displayed for each array formatted. The initial default value is 100.

Returns:

maximum number of array elements

setLimit

public void setLimit(int limit)

Set the maximum number of array elements displayed for each array formatted.

Parameters:

limit - maximum number or 0 if no limit

getMoreFormat

public String getMoreFormat()

Return format used to indicate the number of elements suppressed at the end of the array. Default is ", ...(%1$d)".

Returns:

the format

setMoreFormat

public void setMoreFormat(String moreFormat)

Set format used to indicate the number of elements suppressed at the end of the array.

Parameters:

moreFormat - suitable to display an integer

format

public ArrayFormatter format(boolean[] a,
                             String conversion)

Writes a formatted boolean array to this object's destination.

Parameters:

a - the array

conversion - conversion string used on each array element

Returns:

this object

format

public ArrayFormatter format(byte[] a,
                             String conversion)

Writes a formatted byte array to this object's destination.

Parameters:

a - the array

conversion - conversion string used on each array element

Returns:

this object

format

public ArrayFormatter format(short[] a,
                             String conversion)

Writes a formatted short array to this object's destination.

Parameters:

a - the array

conversion - conversion string used on each array element

Returns:

this object

format

public ArrayFormatter format(int[] a,
                             String conversion)

Writes a formatted integer array to this object's destination.

Parameters:

a - the array

conversion - conversion string used on each array element

Returns:

this object

format

public ArrayFormatter format(long[] a,
                             String conversion)

Writes a formatted long array to this object's destination.

Parameters:

a - the array

conversion - conversion string used on each array element

Returns:

this object

format

public ArrayFormatter format(float[] a,
                             String conversion)

Writes a formatted float array to this object's destination.

Parameters:

a - the array

conversion - conversion string used on each array element

Returns:

this object

format

public ArrayFormatter format(double[] a,
                             String conversion)

Writes a formatted double array to this object's destination.

Parameters:

a - the array

conversion - conversion string used on each array element

Returns:

this object

format

public <T> ArrayFormatter format(T[] a,
                                 String conversion)

Writes a formatted array of objects to this object's destination.

Parameters:

a - the array

conversion - conversion string used on each array element

Returns:

this object

format

public ArrayFormatter format(String format,
                             Object... args)

Writes a formatted string to this object's destination.

Parameters:

format - a format string for the objects

args - the objects

Returns:

this object

close

public void close()
           throws IOException

Closes the formatter this ArrayFormatter is based upon.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

flush

public void flush()
           throws IOException

Flushed the formatter this ArrayFormatter is based upon.

Specified by:

flush in interface Flushable

Throws:

IOException

out

public Appendable out()

Return the Appendable this formatter writes to.

Returns:

the Appendable

asString

public static String asString(boolean[] a,
                              String conversion,
                              String prefix,
                              String separator,
                              String postfix)

Represent boolean array as String.

Parameters:

a - the array

conversion - the conversion used on each element

prefix - the prefix at the start of the string representation

separator - the separator between elements

postfix - the postfix after the end of the string representation

Returns:

the formatted string

asString

public static String asString(boolean[] a,
                              String conversion)

Represent boolean array as String using default prefix, separator and postfix.

Parameters:

a - the array

conversion - the conversion used on each element

Returns:

the formatted string

asString

public static String asString(byte[] a,
                              String conversion,
                              String prefix,
                              String separator,
                              String postfix)

Represent byte array as String.

Parameters:

a - the array

conversion - the conversion used on each element

prefix - the prefix at the start of the string representation

separator - the separator between elements

postfix - the postfix after the end of the string representation

Returns:

the formatted string

asString

public static String asString(byte[] a,
                              String conversion)

Represent byte array as String using default prefix, separator and postfix.

Parameters:

a - the array

conversion - the conversion used on each element

Returns:

the formatted string

asString

public static String asString(short[] a,
                              String conversion,
                              String prefix,
                              String separator,
                              String postfix)

Represent short array as String.

Parameters:

a - the array

conversion - the conversion used on each element

prefix - the prefix at the start of the string representation

separator - the separator between elements

postfix - the postfix after the end of the string representation

Returns:

the formatted string

asString

public static String asString(short[] a,
                              String conversion)

Represent short array as String using default prefix, separator and postfix.

Parameters:

a - the array

conversion - the conversion used on each element

Returns:

the formatted string

asString

public static String asString(int[] a,
                              String conversion,
                              String prefix,
                              String separator,
                              String postfix)

Represent integer array as String.

Parameters:

a - the array

conversion - the conversion used on each element

prefix - the prefix at the start of the string representation

separator - the separator between elements

postfix - the postfix after the end of the string representation

Returns:

the formatted string

asString

public static String asString(int[] a,
                              String conversion)

Represent integer array as String using default prefix, separator and postfix.

Parameters:

a - the array

conversion - the conversion used on each element

Returns:

the formatted string

asString

public static String asString(long[] a,
                              String conversion,
                              String prefix,
                              String separator,
                              String postfix)

Represent long array as String.

Parameters:

a - the array

conversion - the conversion used on each element

prefix - the prefix at the start of the string representation

separator - the separator between elements

postfix - the postfix after the end of the string representation

Returns:

the formatted string

asString

public static String asString(long[] a,
                              String conversion)

Represent long array as String using default prefix, separator and postfix.

Parameters:

a - the array

conversion - the conversion used on each element

Returns:

the formatted string

asString

public static String asString(float[] a,
                              String conversion,
                              String prefix,
                              String separator,
                              String postfix)

Represent float array as String.

Parameters:

a - the array

conversion - the conversion used on each element

prefix - the prefix at the start of the string representation

separator - the separator between elements

postfix - the postfix after the end of the string representation

Returns:

the formatted string

asString

public static String asString(float[] a,
                              String conversion)

Represent float array as String using default prefix, separator and postfix.

Parameters:

a - the array

conversion - the conversion used on each element

Returns:

the formatted string

asString

public static String asString(double[] a,
                              String conversion,
                              String prefix,
                              String separator,
                              String postfix)

Represent double array as String.

Parameters:

a - the array

conversion - the conversion used on each element

prefix - the prefix at the start of the string representation

separator - the separator between elements

postfix - the postfix after the end of the string representation

Returns:

the formatted string

asString

public static String asString(double[] a,
                              String conversion)

Represent double array as String using default prefix, separator and postfix.

Parameters:

a - the array

conversion - the conversion used on each element

Returns:

the formatted string

asString

public static <T> String asString(T[] a,
                                  String conversion,
                                  String prefix,
                                  String separator,
                                  String postfix)

Represent array of objects as String.

Parameters:

a - the array

conversion - the conversion used on each element

prefix - the prefix at the start of the string representation

separator - the separator between elements

postfix - the postfix after the end of the string representation

Returns:

the formatted string

asString

public static <T> String asString(T[] a,
                                  String conversion)

Represent array of objects as String using default prefix, separator and postfix.

Parameters:

a - the array

conversion - the conversion used on each element

Returns:

the formatted string