|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Instances of ChangeLogGenerator
are intended to provide an
InputStream
for a ChangeLogParser
to parse into
individual ChangeLogEntry
objects.
Method Summary | |
void |
cleanup()
Provides the opportunity for the generator to do any required cleanup. |
Collection |
getEntries(ChangeLogParser parser)
Return a Collection of ChangeLogEntry objects. |
String |
getLogEnd()
Return a string indicating the end of the entries. |
String |
getLogStart()
Return a string indicating the start of the entries. |
void |
init(ChangeLog changeLog)
Initialize the ChangeLogGenerator instance with in the controlling ChangeLog instance. |
Method Detail |
public void init(ChangeLog changeLog)
ChangeLog
instance. Any configuration required for the generator
should be obtained from the changeLog
. This method is
guaranteed to be called before getEntries(org.apache.maven.changelog.ChangeLogParser)
.
changeLog
- the controlling ChangeLog instancepublic Collection getEntries(ChangeLogParser parser) throws IOException
InputStream
that contains the change log
insformation which is then passed to the parser
to create
the individual ChangeLogEntry
objects.
This method is guaranteed to be called after init(org.apache.maven.changelog.ChangeLog)
and before
cleanup()
. This method must invoke only the ChangeLogParser.parse(java.io.InputStream)
method.
parser
- the parser that will create the individual ChangeLogEntry
objects.
IOException
- if there is an error while creating the
ChangeLogEntry objectspublic String getLogStart()
public String getLogEnd()
public void cleanup()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |