org.opencms.workplace.list
Class CmsListDateMacroFormatter

java.lang.Object
  extended byorg.opencms.workplace.list.CmsListMacroFormatter
      extended byorg.opencms.workplace.list.CmsListDateMacroFormatter
All Implemented Interfaces:
I_CmsListFormatter

public class CmsListDateMacroFormatter
extends CmsListMacroFormatter

Formatter for dates.

The 'never' message will be displayed if the date is null or Date.getTime()==0.

Since:
6.0.0
Version:
$Revision: 1.7 $
Author:
Michael Moossen

Constructor Summary
CmsListDateMacroFormatter(CmsMessageContainer mask, CmsMessageContainer never)
          Default constructor that sets the mask to use.
CmsListDateMacroFormatter(CmsMessageContainer mask, CmsMessageContainer never, long neverTime)
          Default constructor that sets the mask to use.
 
Method Summary
 java.lang.String format(java.lang.Object data, java.util.Locale locale)
          Returns a formatted string for the specified data.
static I_CmsListFormatter getDefaultDateFormatter()
          Returns a default date formatter object.
static I_CmsListFormatter getDefaultDateFormatter(long never)
          Returns a default date formatter object.
 
Methods inherited from class org.opencms.workplace.list.CmsListMacroFormatter
getMask
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmsListDateMacroFormatter

public CmsListDateMacroFormatter(CmsMessageContainer mask,
                                 CmsMessageContainer never)
Default constructor that sets the mask to use.

Parameters:
mask - pattern for MessageFormat
never - message (without args) for the 'never' message

CmsListDateMacroFormatter

public CmsListDateMacroFormatter(CmsMessageContainer mask,
                                 CmsMessageContainer never,
                                 long neverTime)
Default constructor that sets the mask to use.

Parameters:
mask - pattern for MessageFormat
never - message (without args) for the 'never' message
neverTime - the time considered as 'never', default is 0
Method Detail

getDefaultDateFormatter

public static I_CmsListFormatter getDefaultDateFormatter()
Returns a default date formatter object.

Returns:
a default date formatter object

getDefaultDateFormatter

public static I_CmsListFormatter getDefaultDateFormatter(long never)
Returns a default date formatter object.

Parameters:
never - time considered as never
Returns:
a default date formatter object

format

public java.lang.String format(java.lang.Object data,
                               java.util.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
Overrides:
format in class CmsListMacroFormatter
See Also:
CmsListMacroFormatter.format(java.lang.Object, java.util.Locale)