net.sf.mmm.util.cli.api
Class CliOutputSettings

java.lang.Object
  net.sf.mmm.util.cli.api.CliOutputSettings

public class CliOutputSettings
extends Object

This class represents the settings for the help output.

Since:

2.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

private String	lineSeparator
private Locale	locale
private static int	MIN_WIDTH The minimum value for width.
private NlsTemplateResolver	templateResolver
private int	width

Constructor Summary

CliOutputSettings()
The constructor.

CliOutputSettings(int width)
The constructor.

Method Summary

String	getLineSeparator()
Locale	getLocale() This method gets the Locale used to nationalize the output.
NlsTemplateResolver	getTemplateResolver()
int	getWidth() This method gets the width of the help-output in characters per line.
void	setLineSeparator(String lineSeparator)
void	setLocale(Locale locale) This method sets the locale to use.
void	setTemplateResolver(NlsTemplateResolver templateResolver)
void	setWidth(int width)

Methods inherited from class java.lang.Object

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

Field Detail

MIN_WIDTH

private static final int MIN_WIDTH

The minimum value for width.

See Also:

Constant Field Values

width

private int width

See Also:

getWidth()

lineSeparator

private String lineSeparator

See Also:

getLineSeparator()

locale

private Locale locale

See Also:

getLocale()

templateResolver

private NlsTemplateResolver templateResolver

See Also:

getTemplateResolver()

Constructor Detail

CliOutputSettings

public CliOutputSettings()

The constructor.

CliOutputSettings

public CliOutputSettings(int width)

The constructor.

Parameters:

width - is the width.

Method Detail

getWidth

public int getWidth()

This method gets the width of the help-output in characters per line.

Returns:

the width.

setWidth

public void setWidth(int width)

Parameters:

width - is the width to set.

getLineSeparator

public String getLineSeparator()

Returns:

the lineSeparator

setLineSeparator

public void setLineSeparator(String lineSeparator)

Parameters:

lineSeparator - is the lineSeparator to set

getLocale

public Locale getLocale()

This method gets the Locale used to nationalize the output. By default Locale.getDefault() ist used.

Returns:

the Locale.

setLocale

public void setLocale(Locale locale)

This method sets the locale to use.

Parameters:

locale - is the locale to set

getTemplateResolver

public NlsTemplateResolver getTemplateResolver()

Returns:

the templateResolver

setTemplateResolver

public void setTemplateResolver(NlsTemplateResolver templateResolver)

Parameters:

templateResolver - is the templateResolver to set