org.apache.maven.mkslib
Class MksChangeLogGenerator

java.lang.Object
  org.apache.maven.changelog.AbstractChangeLogGenerator
      org.apache.maven.mkslib.MksChangeLogGenerator

All Implemented Interfaces:

ChangeLogGenerator, org.apache.tools.ant.taskdefs.ExecuteStreamHandler

public class MksChangeLogGenerator

extends AbstractChangeLogGenerator

A log-generator for the mks commandline tool. It supports an input file with

Version:

$Id: MksChangeLogGenerator.java 532339 2007-04-25 12:28:56Z ltheussl $

Author:

Christoph Jerolimov

Field Summary

Fields inherited from class org.apache.maven.changelog.AbstractChangeLogGenerator

base, changeLogExecutor, clParser, commentFormat, dateRange, entries, errorReader, in, logEnd, logStart, tag, type

Constructor Summary

MksChangeLogGenerator()

Method Summary

protected String	getScmDateArgument(Date before, Date to) Construct the MKS command-line argument that is used to specify the appropriate date range.
protected org.apache.tools.ant.types.Commandline	getScmLogCommand() Constructs the appropriate command line to execute the scm's log command.
protected String	getScmTagArgument(String tagStart, String tagEnd) Currently always returns null.

Methods inherited from class org.apache.maven.changelog.AbstractChangeLogGenerator

cleanup, getCommentFormat, getConnection, getEntries, getLogEnd, getLogStart, handleParserException, init, logExecute, setCommentFormat, setConnection, setDateRange, setDateRangeFromAbsoluteDate, setLogEnd, setLogStart, setProcessErrorStream, setProcessInputStream, setProcessOutputStream, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MksChangeLogGenerator

public MksChangeLogGenerator()

Method Detail

getScmLogCommand

protected org.apache.tools.ant.types.Commandline getScmLogCommand()

Description copied from class: AbstractChangeLogGenerator

Constructs the appropriate command line to execute the scm's log command. This method must be implemented by subclasses.

Specified by:

getScmLogCommand in class AbstractChangeLogGenerator

Returns:

the mks command line to be executed.

getScmDateArgument

protected String getScmDateArgument(Date before,
                                    Date to)

Construct the MKS command-line argument that is used to specify the appropriate date range. Currently always returns null.

Specified by:

getScmDateArgument in class AbstractChangeLogGenerator

Parameters:

before - The starting point.

to - The ending point.

Returns:

A string that can be used to specify a date to a scm system.

getScmTagArgument

protected String getScmTagArgument(String tagStart,
                                   String tagEnd)

Currently always returns null.

Specified by:

getScmTagArgument in class AbstractChangeLogGenerator

Parameters:

tagStart - The tag name for the start of the log (log shouldn't actually contain the tag).

tagEnd - The tag name for the end of the log (the log can contain this tag), or null to log all changes since tagStart.

Returns:

A string that can be used to specify the tag range to a scm system.

See Also:

AbstractChangeLogGenerator.getScmTagArgument(String, String)