org.opends.quicksetup.util

Class PlainTextProgressMessageFormatter

java.lang.Object

org.opends.quicksetup.util.PlainTextProgressMessageFormatter

All Implemented Interfaces:

ProgressMessageFormatter

public class PlainTextProgressMessageFormatter
extends Object
implements ProgressMessageFormatter

This is an implementation of the ProgressMessageFormatter class that provides format in plain text.

Constructor Summary

Constructors

Constructor and Description
PlainTextProgressMessageFormatter()

Method Summary

Methods

Modifier and Type	Method and Description
LocalizableMessage	getFormattedAfterUrlClick(String url, LocalizableMessage lastText) Returns the log formatted representation after the user has clicked on a url.
LocalizableMessage	getFormattedDone() Returns the plain text representation of the 'Done' text string.
LocalizableMessage	getFormattedError() Returns the plain text representation of the 'Error' text string.
LocalizableMessage	getFormattedError(LocalizableMessage text, boolean applyMargin) Returns the plain text representation of an error for a given text.
LocalizableMessage	getFormattedError(Throwable t, boolean applyMargin) Returns the plain text representation of an error message for a given throwable.
LocalizableMessage	getFormattedLog(LocalizableMessage text) Returns the plain text representation of a log message for a given text.
LocalizableMessage	getFormattedLogError(LocalizableMessage text) Returns the plain text representation of a log error message for a given text.
LocalizableMessage	getFormattedPoint() Returns the formatted representation of a point.
LocalizableMessage	getFormattedProgress(LocalizableMessage text) Returns the formatted representation of a progress message for a given text.
LocalizableMessage	getFormattedSuccess(LocalizableMessage text) Returns the plain text representation of a success message for a given text.
LocalizableMessage	getFormattedSummary(LocalizableMessage text) Returns the plain text representation of the text that is the summary of the installation process (the one that goes in the UI next to the progress bar).
LocalizableMessage	getFormattedText(LocalizableMessage text) Returns the text representation of the text without providing any style.
LocalizableMessage	getFormattedWarning(LocalizableMessage text, boolean applyMargin) Returns the plain text representation of a warning for a given text.
LocalizableMessage	getFormattedWithPoints(LocalizableMessage text) Returns the plain text representation of the argument text to which we add points.
LocalizableMessage	getLineBreak() Returns the line break in plain text.
LocalizableMessage	getSpace() Returns the formatted representation of a space.
LocalizableMessage	getTab() Returns the tab in plain text.
LocalizableMessage	getTaskSeparator() Returns the task separator in plain text.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlainTextProgressMessageFormatter

public PlainTextProgressMessageFormatter()

Method Detail

getFormattedText

public LocalizableMessage getFormattedText(LocalizableMessage text)

Returns the text representation of the text without providing any style.

Specified by:

getFormattedText in interface ProgressMessageFormatter

Parameters:

text - the source text from which we want to get the text representation

Returns:

the text representation for the given text.

getFormattedSummary

public LocalizableMessage getFormattedSummary(LocalizableMessage text)

Returns the plain text representation of the text that is the summary of the installation process (the one that goes in the UI next to the progress bar).

Specified by:

getFormattedSummary in interface ProgressMessageFormatter

Parameters:

text - the source text from which we want to get the formatted representation

Returns:

the text representation of the summary for the given text.

getFormattedError

public LocalizableMessage getFormattedError(LocalizableMessage text,
                                   boolean applyMargin)

Returns the plain text representation of an error for a given text.

Specified by:

getFormattedError in interface ProgressMessageFormatter

Parameters:

text - the source text from which we want to get the plain text representation

applyMargin - specifies whether we apply a margin or not to the resulting formatted text.

Returns:

the plain text representation of an error for the given text.

getFormattedWarning

public LocalizableMessage getFormattedWarning(LocalizableMessage text,
                                     boolean applyMargin)

Returns the plain text representation of a warning for a given text.

Specified by:

getFormattedWarning in interface ProgressMessageFormatter

Parameters:

text - the source text from which we want to get the plain text representation

applyMargin - specifies whether we apply a margin or not to the resulting formatted text.

Returns:

the plain text representation of a warning for the given text.

getFormattedSuccess

public LocalizableMessage getFormattedSuccess(LocalizableMessage text)

Returns the plain text representation of a success message for a given text.

Specified by:

getFormattedSuccess in interface ProgressMessageFormatter

Parameters:

text - the source text from which we want to get the plain text representation

Returns:

the plain text representation of a success message for the given text.

getFormattedLogError

public LocalizableMessage getFormattedLogError(LocalizableMessage text)

Returns the plain text representation of a log error message for a given text.

Specified by:

getFormattedLogError in interface ProgressMessageFormatter

Parameters:

text - the source text from which we want to get the plain text representation

Returns:

the plain text representation of a log error message for the given text.

getFormattedLog

public LocalizableMessage getFormattedLog(LocalizableMessage text)

Returns the plain text representation of a log message for a given text.

Specified by:

getFormattedLog in interface ProgressMessageFormatter

Parameters:

text - the source text from which we want to get the plain text representation

Returns:

the plain text representation of a log message for the given text.

getFormattedDone

public LocalizableMessage getFormattedDone()

Returns the plain text representation of the 'Done' text string.

Specified by:

getFormattedDone in interface ProgressMessageFormatter

Returns:

the plain text representation of the 'Done' text string.

getFormattedError

public LocalizableMessage getFormattedError()

Returns the plain text representation of the 'Error' text string.

Specified by:

getFormattedError in interface ProgressMessageFormatter

Returns:

the plain text representation of the 'Error' text string.

getFormattedWithPoints

public LocalizableMessage getFormattedWithPoints(LocalizableMessage text)

Returns the plain text representation of the argument text to which we add points. For instance if we pass as argument 'Configuring Server' the return value will be 'Configuring Server .....'.

Specified by:

getFormattedWithPoints in interface ProgressMessageFormatter

Parameters:

text - the String to which add points.

Returns:

the plain text representation of the '.....' text string.

getFormattedPoint

public LocalizableMessage getFormattedPoint()

Returns the formatted representation of a point.

Specified by:

getFormattedPoint in interface ProgressMessageFormatter

Returns:

the formatted representation of the '.' text string.

getSpace

public LocalizableMessage getSpace()

Returns the formatted representation of a space.

Specified by:

getSpace in interface ProgressMessageFormatter

Returns:

the formatted representation of the ' ' text string.

getFormattedProgress

public LocalizableMessage getFormattedProgress(LocalizableMessage text)

Returns the formatted representation of a progress message for a given text.

Specified by:

getFormattedProgress in interface ProgressMessageFormatter

Parameters:

text - the source text from which we want to get the formatted representation

Returns:

the formatted representation of a progress message for the given text.

getFormattedError

public LocalizableMessage getFormattedError(Throwable t,
                                   boolean applyMargin)

Returns the plain text representation of an error message for a given throwable. This method applies a margin if the applyMargin parameter is true.

Specified by:

getFormattedError in interface ProgressMessageFormatter

Parameters:

t - the exception.

applyMargin - specifies whether we apply a margin or not to the resulting plain text.

Returns:

the plain text representation of an error message for the given exception.

getLineBreak

public LocalizableMessage getLineBreak()

Returns the line break in plain text.

Specified by:

getLineBreak in interface ProgressMessageFormatter

Returns:

the line break in plain text.

getTab

public LocalizableMessage getTab()

Returns the tab in plain text.

Specified by:

getTab in interface ProgressMessageFormatter

Returns:

the tab in plain text.

getTaskSeparator

public LocalizableMessage getTaskSeparator()

Returns the task separator in plain text.

Specified by:

getTaskSeparator in interface ProgressMessageFormatter

Returns:

the task separator in plain text.

getFormattedAfterUrlClick

public LocalizableMessage getFormattedAfterUrlClick(String url,
                                           LocalizableMessage lastText)

Returns the log formatted representation after the user has clicked on a url.

Specified by:

getFormattedAfterUrlClick in interface ProgressMessageFormatter

Parameters:

url - that has been clicked

lastText - the formatted representation of the progress log before clicking on the url.

Returns:

the formatted progress log representation after the user has clicked on a url.