DocumentTemplate (Doxia 1.6 API)

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:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentTemplate()

Constructors
Constructor and Description
`DocumentTemplate()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)` Method equals.
`Date`	`getDate()` Get the date and time when the template was last modified, prior to being used to create the current document.
`String`	`getHref()` Get the location of the document template.
`String`	`getModifydate()` Get the date and time when the template was last modified.
`String`	`getTitle()` Get the name of the document template.
`int`	`hashCode()` 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`	`setHref(String href)` 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`	`setTitle(String title)` Set the name of the document template.
`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(Object other)
```
    Method equals.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    other -
    
    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 -
  - setHref
```
public void setHref(String href)
```
    Set the location of the document template.
    
    Parameters:
    href -
  - 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 -
    Since:
    
    1.1.1.
  - setTitle
```
public void setTitle(String title)
```
    Set the name of the document template.
    
    Parameters:
    title -
  - 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:
    getDate()

Class DocumentTemplate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentTemplate

Method Detail

equals

getDate

getHref

getTitle

hashCode

setDate

setHref

setModifydate

setTitle

toString

getModifydate