Package org.apache.maven.doxia.document

Class DocumentTemplate

  • All Implemented Interfaces:
    java.io.Serializable
    public class DocumentTemplate
extends java.lang.Object
implements java.io.Serializable
    A template that was used to create the document.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object other)
      Method equals.
      java.util.Date getDate()
      Get the date and time when the template was last modified, prior to being used to create the current document.
      java.lang.String getHref()
      Get the location of the document template.
      java.lang.String getModifydate()
      Get the date and time when the template was last modified.
      java.lang.String getTitle()
      Get the name of the document template.
      int hashCode()
      Method hashCode.
      void setDate​(java.util.Date date)
      Set the date and time when the template was last modified, prior to being used to create the current document.
      void setHref​(java.lang.String href)
      Set the location of the document template.
      void setModifydate​(java.lang.String modifydate)
      Set the date as String (recommended format is ISO 8601) when the template was last modified.
      void setTitle​(java.lang.String title)
      Set the name of the document template.
      java.lang.String toString()
      Method toString.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DocumentTemplate

        public DocumentTemplate()

    • Method Detail

      • equals

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

      • getDate

        public java.util.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 java.lang.String getHref()
        Get the location of the document template.
        Returns:
        String

      • getTitle

        public java.lang.String getTitle()
        Get the name of the document template.
        Returns:
        String

      • hashCode

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

      • setDate

        public void setDate​(java.util.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​(java.lang.String href)
        Set the location of the document template.
        Parameters:
        href - a href object.

      • setModifydate

        public void setModifydate​(java.lang.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​(java.lang.String title)
        Set the name of the document template.
        Parameters:
        title - a title object.

      • toString

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

      • getModifydate

        public java.lang.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:
        getDate()