com.unboundid.util

Class FormattableColumn

java.lang.Object

com.unboundid.util.FormattableColumn

All Implemented Interfaces:

java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class FormattableColumn
extends java.lang.Object
implements java.io.Serializable

This class provides a data structure with information about a column to use with the ColumnFormatter.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CSV_QUOTE_ESCAPE_CHARACTER_PROPERTY A system property that can be used to specify what character should be used when escaping quotation marks in the output.

Constructor Summary

Constructors

Constructor and Description
FormattableColumn(int width, HorizontalAlignment alignment, java.lang.String... labelLines) Creates a new formattable column with the provided information.

Method Summary

Methods

Modifier and Type	Method and Description
void	format(java.lang.StringBuilder buffer, java.lang.String text, OutputFormat format) Appends a formatted representation of the provided text to the given buffer.
HorizontalAlignment	getAlignment() Retrieves the alignment for this column.
java.lang.String[]	getLabelLines() Retrieves the lines to use as the label for this column.
java.lang.String	getSingleLabelLine() Retrieves a single-line representation of the label.
int	getWidth() Retrieves the width for this column.
static void	setCSVQuoteEscapeCharacter(char c) Specifies the character that should be used to escape the double quote character in CSV-formatted values.
java.lang.String	toString() Retrieves a string representation of this formattable column.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this formattable column to the provided buffer.

Methods inherited from class java.lang.Object

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

Field Detail

CSV_QUOTE_ESCAPE_CHARACTER_PROPERTY

@NotNull
public static final java.lang.String CSV_QUOTE_ESCAPE_CHARACTER_PROPERTY

A system property that can be used to specify what character should be used when escaping quotation marks in the output. If set, the value of the property should be a single character, and it is recommended to be either the double quote character or the backslash character.

Constructor Detail

FormattableColumn

public FormattableColumn(int width,
                 @NotNull
                 HorizontalAlignment alignment,
                 @NotNull
                 java.lang.String... labelLines)

Creates a new formattable column with the provided information.

Parameters:

width - The width to use for this column. It must be greater than or equal to 1.

alignment - The alignment to use for this column. It must not be null.

labelLines - The lines to use as the label for this column. It must not be null.

Method Detail

getWidth

public int getWidth()

Retrieves the width for this column.

Returns:

The width for this column.

getAlignment

@NotNull
public HorizontalAlignment getAlignment()

Retrieves the alignment for this column.

Returns:

The alignment for this column.

getLabelLines

@NotNull
public java.lang.String[] getLabelLines()

Retrieves the lines to use as the label for this column.

Returns:

The lines to use as the label for this column.

getSingleLabelLine

@NotNull
public java.lang.String getSingleLabelLine()

Retrieves a single-line representation of the label. If there are multiple header lines, then they will be concatenated and separated by a space.

Returns:

A single-line representation of the label.

format

public void format(@NotNull
          java.lang.StringBuilder buffer,
          @NotNull
          java.lang.String text,
          @NotNull
          OutputFormat format)

Appends a formatted representation of the provided text to the given buffer.

Parameters:

buffer - The buffer to which the text should be appended. It must not be null.

text - The text to append to the buffer. It must not be null.

format - The format to use for the text. It must not be null.

setCSVQuoteEscapeCharacter

public static void setCSVQuoteEscapeCharacter(char c)

Specifies the character that should be used to escape the double quote character in CSV-formatted values. RFC 4180 states that it should be a double quote character (that is, a single double quote should be formatted as '""'), and that is now the default behavior, but the LDAP SDK formerly used a backslash as an escape character (like '\"'), and this method can be used to restore that behavior if desired. Alternatively, this can be accomplished without any change to the application source code by launching the JVM with the com.unboundid.util.FormattableColumn.csvQuoteEscapeCharacter system property set to a value that contains only the backslash character.

Parameters:

c - The character to use to escape the double quote character in CSV-formatted values. This is only recommended to be the double quote character or the backslash character.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this formattable column.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this formattable column.

toString

public void toString(@NotNull
            java.lang.StringBuilder buffer)

Appends a string representation of this formattable column to the provided buffer.

Parameters:

buffer - The buffer to which the string representation should be appended.