org.apache.maven.changelog
Interface ChangeLogParser

All Known Implementing Classes:

ClearcaseChangeLogParser, CvsChangeLogParser, MksChangeLogParser, PerforceChangeLogParser, StarteamChangeLogParser, SvnChangeLogParser, VssChangeLogParser

public interface ChangeLogParser

Instance of ChangeLogParser are intended to parse an InputStream created by a ChangeLogGenerator into individual ChangeLogEntry objects.

Version:

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

Author:

Glenn McAllister

Method Summary

void	cleanup() Provides the opportunity for the parser to do any required cleanup.
void	init(ChangeLog changeLog) Initialize the ChangeLogParser instance with the controlling ChangeLog instance.
Collection	parse(InputStream in) Returns a Collection of ChangeLogEntry objects, parsed from the InputStream.
void	setDateFormatInFile(String dateFormat) Set the date formatter for parse starteam stream

Method Detail

init

public void init(ChangeLog changeLog)

Initialize the ChangeLogParser instance with the controlling ChangeLog instance. Any configuration required for the parser should be obtained from the changeLog. This method is guaranteed to be called before parse(java.io.InputStream).

Parameters:

changeLog - the controlling ChangeLog instance

parse

public Collection parse(InputStream in)
                 throws IOException

Returns a Collection of ChangeLogEntry objects, parsed from the InputStream. This method is guaranteed to be called after init(org.apache.maven.changelog.ChangeLog) and before cleanup(). However, it is up to a ChangeLogGenerator instance to call this method, so no guarantee can be made this this method will be called.

Parameters:

in - the input stream to parse

Returns:

a Collection of ChangeLogEntry objects

Throws:

IOException - if there is an error while parsing the input stream

cleanup

public void cleanup()

Provides the opportunity for the parser to do any required cleanup. This method is guaranteed to be called after the init(org.apache.maven.changelog.ChangeLog) (and presumably the parse(java.io.InputStream)) method.

setDateFormatInFile

public void setDateFormatInFile(String dateFormat)

Set the date formatter for parse starteam stream

Parameters:

dateFormat - a dateFormat for replace the local format