Package org.apache.maven.doxia.site

Class PublishDate

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

    • Constructor Summary

      Constructors 
      Constructor Description
      PublishDate()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      PublishDate clone()
      Method clone.
      boolean equals​(java.lang.Object other)
      Method equals.
      java.lang.String getFallbackPrefix()
      Get the prefix to emit in front of the fallback date.
      java.lang.String getFallbackValue()
      Get the Velocity context key to use as source for the date.
      java.lang.String getFormat()
      Get date format to use.
      java.lang.String getPosition()
      Get where to place the date published ("left", "right", "navigation-top", "navigation-bottom", "bottom" or "none" to hide it).
      java.lang.String getPrefix()
      Get the prefix to emit in front of the date.
      java.lang.String getTimezone()
      Get the timezone to use.
      java.lang.String getValue()
      Get the Velocity context key to use as source for the date.
      int hashCode()
      Method hashCode.
      void setFallbackPrefix​(java.lang.String fallbackPrefix)
      Set the prefix to emit in front of the fallback date.
      void setFallbackValue​(java.lang.String fallbackValue)
      Set the Velocity context key to use as source for the date.
      void setFormat​(java.lang.String format)
      Set date format to use.
      void setPosition​(java.lang.String position)
      Set where to place the date published ("left", "right", "navigation-top", "navigation-bottom", "bottom" or "none" to hide it).
      void setPrefix​(java.lang.String prefix)
      Set the prefix to emit in front of the date.
      void setTimezone​(java.lang.String timezone)
      Set the timezone to use.
      void setValue​(java.lang.String value)
      Set the Velocity context key to use as source for the date.
      java.lang.String toString()
      Method toString.

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • PublishDate

        public PublishDate()

    • Method Detail

      • clone

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

      • equals

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

      • getFallbackPrefix

        public java.lang.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 java.lang.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 java.lang.String getFormat()
        Get date format to use.
        Returns:
        String

      • getPosition

        public java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.Object
        Returns:
        int

      • setFallbackPrefix

        public void setFallbackPrefix​(java.lang.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​(java.lang.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​(java.lang.String format)
        Set date format to use.
        Parameters:
        format - a format object.

      • setPosition

        public void setPosition​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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 java.lang.String toString()
        Method toString.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String