Class DocumentTemplate

java.lang.Object
org.apache.maven.doxia.document.DocumentTemplate
All Implemented Interfaces:
Serializable

public class DocumentTemplate extends Object implements Serializable
A template that was used to create the document.
Version:
$Revision$ $Date$
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private Date
    The date and time when the template was last modified, prior to being used to create the current document.
    private String
    The location of the document template.
    private static final DateFormat
    ISO 8601 date format, i.e.
    private String
    The date as String (recommended format is ISO 8601) when the template was last modified.
    private String
    The name of the document template.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object other)
    Method equals.
    Get the date and time when the template was last modified, prior to being used to create the current document.
    Get the location of the document template.
    Get the date and time when the template was last modified.
    Get the name of the document template.
    int
    Method hashCode.
    void
    setDate(Date date)
    Set the date and time when the template was last modified, prior to being used to create the current document.
    void
    Set the location of the document template.
    void
    setModifydate(String modifydate)
    Set the date as String (recommended format is ISO 8601) when the template was last modified.
    void
    Set the name of the document template.
    Method toString.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • href

      private String href
      The location of the document template.
    • title

      private String title
      The name of the document template.
    • date

      private Date date
      The date and time when the template was last modified, prior to being used to create the current document. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
    • modifydate

      private String modifydate
      The date as String (recommended format is ISO 8601) when the template was last modified. Only used if date is not set.
      Since:
      1.1.1 .
    • ISO_8601_FORMAT

      private static final DateFormat ISO_8601_FORMAT
      ISO 8601 date format, i.e. yyyy-MM-dd
  • Constructor Details

    • DocumentTemplate

      public DocumentTemplate()
  • Method Details

    • equals

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

      public Date getDate()
      Get the date and time when the template was last modified, prior to being used to create the current document. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
      Returns:
      Date
    • getHref

      public String getHref()
      Get the location of the document template.
      Returns:
      String
    • getTitle

      public String getTitle()
      Get the name of the document template.
      Returns:
      String
    • hashCode

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

      public void setDate(Date date)
      Set the date and time when the template was last modified, prior to being used to create the current document. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
      Parameters:
      date - a date object.
    • setHref

      public void setHref(String href)
      Set the location of the document template.
      Parameters:
      href - a href object.
    • setModifydate

      public void setModifydate(String modifydate)
      Set the date as String (recommended format is ISO 8601) when the template was last modified. Only used if date is not set.
      Parameters:
      modifydate - a modifydate object.
      Since:
      1.1.1.
    • setTitle

      public void setTitle(String title)
      Set the name of the document template.
      Parameters:
      title - a title object.
    • toString

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

      public String getModifydate()
      Get the date and time when the template was last modified.
      Returns:
      the getDate() if setted, formatted using ISO-8601 English format, otherwise return the modifydate.
      Since:
      1.1.1
      See Also: