org.codehaus.mojo.scmchangelog.changelog.log
Interface ScmGrammar

All Known Implementing Classes:

AbstractRegexpScmGrammar, AbstractScmGrammar, AcceptAllScmGrammar, BugzillaScmGrammar, ManuScmGrammar, RemyScmGrammar

public interface ScmGrammar

This interface represents the grammar used to manipulate the SCM comments extracting informations

Version:

$Id: ScmGrammar.java 10686 2009-09-12 20:42:13Z ehsavoie $

Author:

ehsavoie

Field Summary

static String

NEW_LINE Default separator for issues.

Method Summary

Message	extractMessage(String content) Extract a Message from a comment.
String	getIssueSeparator() Returns the String to be inserted between each issue comment.
boolean	hasMessage(String content) Indicates if the content has a Message to be extracted.
String	removeComments(String content) Removes the comments from the SCM comments.

Field Detail

NEW_LINE

static final String NEW_LINE

Default separator for issues.

See Also:

Constant Field Values

Method Detail

extractMessage

Message extractMessage(String content)

Extract a Message from a comment.

Parameters:

content -

the comment to be parsed and from which a Message will be extracted

Returns:

the Message extracted from the content

hasMessage

boolean hasMessage(String content)

Indicates if the content has a Message to be extracted.

Parameters:

content -

the content to be tested

Returns:

true if a Message can be extracted - false otherwise

getIssueSeparator

String getIssueSeparator()

Returns the String to be inserted between each issue comment. It may be replaced when generating the report.

Returns:

the String to be inserted between each issue comment.

removeComments

String removeComments(String content)

Removes the comments from the SCM comments. Comments are marked by being surrounded by &qutote;---"e;.

Parameters:

content - - the content from which comments will be removed.

Returns:

the content without the elemets commented.