Class AnsiFormat

java.lang.Object

com.diogonunes.jcolor.AnsiFormat

public class AnsiFormat
extends Object

Abstracts an Array of Attributes. Use it if you find this more readable than Attribute[].

Constructor Summary

Constructors

Constructor	Description
AnsiFormat(Attribute... attributes)	Creates a new format that bundles the given attributes.

Method Summary

Modifier and Type	Method	Description
String	format(String text)	Wraps the given text with the ANSI code defined by this format.
protected Attribute[]	toArray()	Returns the attributes of this format as an array.

Methods inherited from class Object

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

Constructor Details

AnsiFormat

public AnsiFormat(Attribute... attributes)

Creates a new format that bundles the given attributes.

Parameters:

attributes - All ANSI attributes to format a text.

Method Details

format

public String format(String text)

Wraps the given text with the ANSI code defined by this format.

Parameters:

text - String to format.

Returns:

The formatted string, ready to be printed.

toArray

protected Attribute[] toArray()

Returns the attributes of this format as an array.

Returns:

the attributes of this format as an array