org.apache.maven.doxia.document
Class DocumentTemplate

java.lang.Object
  extended by org.apache.maven.doxia.document.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

Constructor Summary
DocumentTemplate()
           
 
Method Summary
 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 getModelEncoding()
           
 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 setModelEncoding(java.lang.String modelEncoding)
           
 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 -

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.


getHref

public java.lang.String getHref()
Get The location of the document template.


getTitle

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


hashCode

public int hashCode()
Method hashCode

Overrides:
hashCode in class java.lang.Object

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 -

setHref

public void setHref(java.lang.String href)
Set The location of the document template.

Parameters:
href -

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 -
Since:
1.1.1

setTitle

public void setTitle(java.lang.String title)
Set The name of the document template.

Parameters:
title -

toString

public java.lang.String toString()
Method toString

Overrides:
toString in class java.lang.Object

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()

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

getModelEncoding

public java.lang.String getModelEncoding()


Copyright © 2005-2010 Apache Software Foundation. All Rights Reserved.