|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.maven.changelog.ChangeLog
Change log task. It uses a ChangeLogGenerator and ChangeLogParser to create a Collection of ChangeLogEntry objects, which are used to produce an XML output that represents the list of changes.
Constructor Summary | |
ChangeLog()
|
Method Summary | |
void |
doExecute()
Execute task. |
File |
getBasedir()
Get the base directory for the change log generator. |
Collection |
getChangeSets()
Gets the collection of change sets. |
String |
getCommentFormat()
Returns the commentFormat used to interrogate the RCS. |
String |
getDate()
Get the date to start the log from. |
String |
getDateFormat()
Get the date format of log entries to process; the interpretation of this parameter depends on the generator. |
List |
getDevelopers()
Returns the developers. |
String |
getMarkerEnd()
Returns the marker (date or tag) for the end of the current change set. |
String |
getMarkerStart()
Returns the marker (date or tag) for the start of the current change set. |
String |
getOutputEncoding()
Returns the outputEncoding. |
boolean |
getQuoteDate()
Get the quoteDate property. |
String |
getRange()
Get the range of log entries to process; the interpretation of the range depends on the generator implementation. |
String |
getRepositoryConnection()
Return connection string declared in project.xml |
String |
getTag()
Get the tag to start the log from. |
String |
getType()
Get the type of log to generate (range, date, or tag). |
void |
setBasedir(File base)
Set the base directory for the change log generator. |
void |
setChangeSets(Collection sets)
Sets the collection of change sets. |
void |
setCommentFormat(String commentFormat)
Sets the commentFormat. |
void |
setDate(String date)
Set the date to start the log from. |
void |
setDateFormat(String dateFormat)
Set the date format of log entries to process; the interpretation of this parameter depends on the generator. |
void |
setDevelopers(List developers)
Sets the developers. |
void |
setFactory(String factoryClassName)
Set the ChangeLogFactory class name. |
void |
setMarkerEnd(String marker)
Sets the marker (date or tag) for the end of the current change set. |
void |
setMarkerStart(String marker)
Sets the marker (date or tag) for the start of the current change set. |
void |
setOutput(File output)
Set the output file for the log. |
void |
setOutputEncoding(String outputEncoding)
Sets the outputEncoding. |
void |
setQuoteDate(boolean newQuoteDate)
Set the quoteDate property. |
void |
setRange(String range)
Set the range of log entries to process; the interpretation of this parameter depends on the generator. |
void |
setRepositoryConnection(String aString)
Change SCM connection string |
void |
setTag(String tag)
Set the tag to start the log from. |
void |
setType(String type)
Set the type of log to generate (range, date, or tag). |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ChangeLog()
Method Detail |
public void setFactory(String factoryClassName)
factoryClassName
- the fully qualified factory class namepublic void setType(String type)
type
- one of "range", "date", or "tag".public String getType()
public void setRange(String range)
range
- the range of log entries.public String getRange()
public void setDate(String date)
date
- the date to use.public String getDate()
public void setTag(String tag)
tag
- the tag to use.public String getTag()
public void setMarkerStart(String marker)
marker
- start marker to use.public String getMarkerStart()
getType()
.
public void setMarkerEnd(String marker)
marker
- end marker to use, or null
to specify all changes since the start.public String getMarkerEnd()
getType()
.
null
if there is no
end (meaning the change set should show all changes from the start to the present time).public void setDateFormat(String dateFormat)
dateFormat
- the dateFormat of log entries.public String getDateFormat()
public void setQuoteDate(boolean newQuoteDate)
newQuoteDate
- the quoteDate property to set.public boolean getQuoteDate()
public void setBasedir(File base)
base
- the base directorypublic File getBasedir()
public void setOutput(File output)
output
- the output filepublic String getRepositoryConnection()
public void setRepositoryConnection(String aString)
aString
- a string containing the project's repository
connectionpublic void doExecute() throws FileNotFoundException, IOException, UnsupportedEncodingException
FileNotFoundException
- if the base diretory
getBasedir()
doesn't exist
IOException
- if there are problems running CVS
UnsupportedEncodingException
- if the underlying platform doesn't
support ISO-8859-1 encodingpublic Collection getChangeSets()
ChangeLogSet
objects.public void setChangeSets(Collection sets)
sets
- New value of property sets.public List getDevelopers()
public void setDevelopers(List developers)
developers
- The developers to setpublic String getOutputEncoding()
public void setOutputEncoding(String outputEncoding)
outputEncoding
- The outputEncoding to setpublic String getCommentFormat()
public void setCommentFormat(String commentFormat)
commentFormat
- The commentFormat to set
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |