org.apache.maven.mkslib
Class MksChangeLogParser

java.lang.Object
  extended byorg.apache.maven.mkslib.MksChangeLogParser
All Implemented Interfaces:
ChangeLogParser

public class MksChangeLogParser
extends Object
implements ChangeLogParser

This class parse mks log output.

Version:
$Id: MksChangeLogParser.java 532339 2007-04-25 12:28:56Z ltheussl $
Author:
Christoph Jerolimov

Constructor Summary
MksChangeLogParser()
           
 
Method Summary
protected  void addEntry()
           
 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.
protected  void processGetEntryComment(String line)
           
protected  void processGetEntryInfo(String line)
           
protected  void processGetFileName(String line)
           
protected  void processGetFileRevision(String line)
           
protected  void processWaitForEntryRevision(String line)
           
 void setDateFormatInFile(String dateFormat)
          Set the date formatter for parse starteam stream
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MksChangeLogParser

public MksChangeLogParser()
Method Detail

init

public void init(ChangeLog changeLog)
Description copied from interface: ChangeLogParser
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 ChangeLogParser.parse(java.io.InputStream).

Specified by:
init in interface ChangeLogParser
Parameters:
changeLog - the controlling ChangeLog instance

cleanup

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

Specified by:
cleanup in interface ChangeLogParser

setDateFormatInFile

public void setDateFormatInFile(String dateFormat)
Description copied from interface: ChangeLogParser
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 in)
                 throws IOException
Description copied from interface: ChangeLogParser
Returns a Collection of ChangeLogEntry objects, parsed from the InputStream. This method is guaranteed to be called after ChangeLogParser.init(org.apache.maven.changelog.ChangeLog) and before ChangeLogParser.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.

Specified by:
parse in interface ChangeLogParser
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

processGetFileName

protected void processGetFileName(String line)

processGetFileRevision

protected void processGetFileRevision(String line)

processWaitForEntryRevision

protected void processWaitForEntryRevision(String line)

processGetEntryInfo

protected void processGetEntryInfo(String line)

processGetEntryComment

protected void processGetEntryComment(String line)

addEntry

protected void addEntry()


Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.