Package org.apache.maven.doxia.document
Class DocumentTemplate
java.lang.Object
org.apache.maven.doxia.document.DocumentTemplate
- All Implemented Interfaces:
Serializable
A template that was used to create the document.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate 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 -
Method Summary
Modifier and TypeMethodDescriptionboolean
Method equals.getDate()
Get the date and time when the template was last modified, prior to being used to create the current document.getHref()
Get the location of the document template.Get the date and time when the template was last modified.getTitle()
Get the name of the document template.int
hashCode()
Method hashCode.void
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.toString()
Method toString.
-
Field Details
-
href
The location of the document template. -
title
The name of the document template. -
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
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
ISO 8601 date format, i.e.yyyy-MM-dd
-
-
Constructor Details
-
DocumentTemplate
public DocumentTemplate()
-
-
Method Details
-
equals
Method equals. -
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
Get the location of the document template.- Returns:
- String
-
getTitle
Get the name of the document template.- Returns:
- String
-
hashCode
public int hashCode()Method hashCode. -
setDate
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
Set the location of the document template.- Parameters:
href
- a href object.
-
setModifydate
Set the date as String (recommended format is ISO 8601) when the template was last modified. Only used ifdate
is not set.- Parameters:
modifydate
- a modifydate object.- Since:
- 1.1.1.
-
setTitle
Set the name of the document template.- Parameters:
title
- a title object.
-
toString
Method toString. -
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:
-