Package org.opencms.workplace.list

Class CmsListMacroFormatter

java.lang.Object

org.opencms.workplace.list.CmsListMacroFormatter

All Implemented Interfaces:

I_CmsListFormatter

Direct Known Subclasses:

CmsListDateMacroFormatter

public class CmsListMacroFormatter
extends Object
implements I_CmsListFormatter

This list formatter uses the MessageFormat class for macro like formatting.

Since:

6.0.0

Constructor Summary

Constructors

Constructor	Description
CmsListMacroFormatter(org.opencms.i18n.CmsMessageContainer mask)	Default constructor that sets the mask to use.

Method Summary

Modifier and Type	Method	Description
String	format(Object data, Locale locale)	Returns a formatted string for the specified data.
org.opencms.i18n.CmsMessageContainer	getMask()	Returns the mask.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsListMacroFormatter

public CmsListMacroFormatter(org.opencms.i18n.CmsMessageContainer mask)

Default constructor that sets the mask to use.

Parameters:

mask - pattern for MessageFormat

Method Details

format

public String format(Object data,
 Locale locale)

Description copied from interface: I_CmsListFormatter

Returns a formatted string for the specified data.

Take care of null data.

Specified by:

format in interface I_CmsListFormatter

Parameters:

data - the data to format

locale - the locale for formatting

Returns:

formatted data

See Also:

• I_CmsListFormatter.format(java.lang.Object, java.util.Locale)

getMask

public org.opencms.i18n.CmsMessageContainer getMask()

Returns the mask.

Returns:

the mask