Package org.apache.maven.doxia.document
Class DocumentTemplate
- java.lang.Object
-
- 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
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.Date
date
The date and time when the template was last modified, prior to being used to create the current document.private java.lang.String
href
The location of the document template.private static java.text.DateFormat
ISO_8601_FORMAT
ISO 8601 date format, i.e.private java.lang.String
modifydate
The date as String (recommended format is ISO 8601) when the template was last modified.private java.lang.String
title
The name of the document template.
-
Constructor Summary
Constructors Constructor Description DocumentTemplate()
-
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.
-
-
-
Field Detail
-
href
private java.lang.String href
The location of the document template.
-
title
private java.lang.String title
The name of the document template.
-
date
private java.util.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 java.lang.String modifydate
The date as String (recommended format is ISO 8601) when the template was last modified. Only used ifdate
is not set.- Since:
- 1.1.1 .
-
ISO_8601_FORMAT
private static final java.text.DateFormat ISO_8601_FORMAT
ISO 8601 date format, i.e.yyyy-MM-dd
-
-
Method Detail
-
equals
public boolean equals(java.lang.Object other)
Method equals.- Overrides:
equals
in classjava.lang.Object
- Parameters:
other
-- 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 classjava.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
-
-
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 ifdate
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 classjava.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 themodifydate
. - Since:
- 1.1.1
- See Also:
getDate()
-
-