Class PublishDate

java.lang.Object
org.apache.maven.doxia.site.PublishDate
All Implemented Interfaces:
Serializable, Cloneable
public class PublishDate extends Object implements Serializable, Cloneable
Modify display properties for the date in the header/footer. By default is the publish date.
Version:
$Revision$ $Date$
See Also:

  • Field Details

    • position

      private String position
      Where to place the date published ("left", "right", "navigation-top", "navigation-bottom", "bottom" or "none" to hide it).

    • format

      private String format
      Date format to use.

    • timezone

      private String timezone
      The timezone to use. Use system for the default locale for this instance of the Java Virtual Machine. Refer to java.util.TimeZone for details.

    • value

      private String value
      The Velocity context key to use as source for the date. Usually one of "publishDate" or "scmLastModified". Must have a value of type java.util.Date.

    • prefix

      private String prefix
      The prefix to emit in front of the date. When starting with template. it is assumed to reference a key from the site-renderer.properties, otherwise it is a literal value.

    • fallbackValue

      private String fallbackValue
      The Velocity context key to use as source for the date. Used as fallback when the context given in "value" is not available. Must have a value of type java.util.Date. This is useful when the context given in "value" is only available for Doxia source documents (but not for reports).

    • fallbackPrefix

      private String fallbackPrefix
      The prefix to emit in front of the fallback date. When starting with template. it is assumed to reference a key from the site-renderer.properties, otherwise it is a literal value.

  • Constructor Details

    • PublishDate

      public PublishDate()

  • Method Details

    • clone

      public PublishDate clone()
      Method clone.
      Overrides:
      clone in class Object
      Returns:
      PublishDate

    • equals

      public boolean equals(Object other)
      Method equals.
      Overrides:
      equals in class Object
      Parameters:
      other - a other object.
      Returns:
      boolean

    • getFallbackPrefix

      public String getFallbackPrefix()
      Get the prefix to emit in front of the fallback date. When starting with template. it is assumed to reference a key from the site-renderer.properties, otherwise it is a literal value.
      Returns:
      String

    • getFallbackValue

      public String getFallbackValue()
      Get the Velocity context key to use as source for the date. Used as fallback when the context given in "value" is not available. Must have a value of type java.util.Date. This is useful when the context given in "value" is only available for Doxia source documents (but not for reports).
      Returns:
      String

    • getFormat

      public String getFormat()
      Get date format to use.
      Returns:
      String

    • getPosition

      public String getPosition()
      Get where to place the date published ("left", "right", "navigation-top", "navigation-bottom", "bottom" or "none" to hide it).
      Returns:
      String

    • getPrefix

      public String getPrefix()
      Get the prefix to emit in front of the date. When starting with template. it is assumed to reference a key from the site-renderer.properties, otherwise it is a literal value.
      Returns:
      String

    • getTimezone

      public String getTimezone()
      Get the timezone to use. Use system for the default locale for this instance of the Java Virtual Machine. Refer to java.util.TimeZone for details.
      Returns:
      String

    • getValue

      public String getValue()
      Get the Velocity context key to use as source for the date. Usually one of "publishDate" or "scmLastModified". Must have a value of type java.util.Date.
      Returns:
      String

    • hashCode

      public int hashCode()
      Method hashCode.
      Overrides:
      hashCode in class Object
      Returns:
      int

    • setFallbackPrefix

      public void setFallbackPrefix(String fallbackPrefix)
      Set the prefix to emit in front of the fallback date. When starting with template. it is assumed to reference a key from the site-renderer.properties, otherwise it is a literal value.
      Parameters:
      fallbackPrefix - a fallbackPrefix object.

    • setFallbackValue

      public void setFallbackValue(String fallbackValue)
      Set the Velocity context key to use as source for the date. Used as fallback when the context given in "value" is not available. Must have a value of type java.util.Date. This is useful when the context given in "value" is only available for Doxia source documents (but not for reports).
      Parameters:
      fallbackValue - a fallbackValue object.

    • setFormat

      public void setFormat(String format)
      Set date format to use.
      Parameters:
      format - a format object.

    • setPosition

      public void setPosition(String position)
      Set where to place the date published ("left", "right", "navigation-top", "navigation-bottom", "bottom" or "none" to hide it).
      Parameters:
      position - a position object.

    • setPrefix

      public void setPrefix(String prefix)
      Set the prefix to emit in front of the date. When starting with template. it is assumed to reference a key from the site-renderer.properties, otherwise it is a literal value.
      Parameters:
      prefix - a prefix object.

    • setTimezone

      public void setTimezone(String timezone)
      Set the timezone to use. Use system for the default locale for this instance of the Java Virtual Machine. Refer to java.util.TimeZone for details.
      Parameters:
      timezone - a timezone object.

    • setValue

      public void setValue(String value)
      Set the Velocity context key to use as source for the date. Usually one of "publishDate" or "scmLastModified". Must have a value of type java.util.Date.
      Parameters:
      value - a value object.

    • toString

      public String toString()
      Method toString.
      Overrides:
      toString in class Object
      Returns:
      String