org.apache.maven.starteamlib
Class StarteamChangeLogParser

java.lang.Object
  org.apache.maven.starteamlib.StarteamChangeLogParser

All Implemented Interfaces:

ChangeLogParser

public class StarteamChangeLogParser

extends Object

implements ChangeLogParser

A class to parse starteam log output

Version:

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

Author:

Emmanuel Venisse

Constructor Summary

StarteamChangeLogParser()
Create a new ChangeLogParser.

Method Summary

void	cleanup() Clean up any parser resources
void	init(ChangeLog changeLog) initialize the parser from the change log
Collection	parse(InputStream anInputStream) Parse the input stream into a collection.
void	setDateFormatInFile(String dateFormat) Set the date formatter for parse starteam stream
void	setTestMode(boolean testMode) Use only with StarteamChangeLogParserTest class

Methods inherited from class java.lang.Object

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

Constructor Detail

StarteamChangeLogParser

public StarteamChangeLogParser()

Create a new ChangeLogParser.

Method Detail

init

public void init(ChangeLog changeLog)

initialize the parser from the change log

Specified by:

init in interface ChangeLogParser

Parameters:

changeLog - the controlling task

See Also:

ChangeLogParser.init(ChangeLog)

cleanup

public void cleanup()

Clean up any parser resources

Specified by:

cleanup in interface ChangeLogParser

See Also:

ChangeLogParser.cleanup()

setTestMode

public void setTestMode(boolean testMode)

Use only with StarteamChangeLogParserTest class

setDateFormatInFile

public void setDateFormatInFile(String dateFormat)

Set the date formatter for parse starteam stream

Specified by:

setDateFormatInFile in interface ChangeLogParser

Parameters:

dateFormat - a dateFormat for replace the local format

parse

public Collection parse(InputStream anInputStream)
                 throws IOException

Parse the input stream into a collection.

Specified by:

parse in interface ChangeLogParser

Parameters:

anInputStream - an input stream containing Starteam log output

Returns:

a collection of ChangeLogEntry's

Throws:

IOException - when there are errors reading the provided stream