org.codehaus.mojo.scmchangelog.changelog.log.grammar
Class GrammarEnum

java.lang.Object
  org.codehaus.mojo.scmchangelog.changelog.log.grammar.GrammarEnum

public class GrammarEnum
extends Object

The currently supported grammars.

Version:

$Id: GrammarEnum.java 10667 2009-09-11 08:26:43Z ehsavoie $

Author:

ehsavoie

Field Summary

static GrammarEnum	ALL The ALL grammar.
static GrammarEnum	BUGZILLA The BUGZILLA grammar.
static GrammarEnum	MANU The MANU grammar @operatio:issue#;comment
static GrammarEnum	REMY The REMY grammar.

Method Summary

Message	extractMessage(String content) Extract a Message from the specified String content.
String	getIssueSeparator() Returns the String to be inserted between each issue comment.
boolean	hasMessage(String content) Indicates if the content String matches the grammar.
static GrammarEnum	valueOf(String name) Return the enum element matching the specified name.

Methods inherited from class java.lang.Object

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

Field Detail

MANU

public static final GrammarEnum MANU

The MANU grammar @operatio:issue#;comment

REMY

public static final GrammarEnum REMY

The REMY grammar.

BUGZILLA

public static final GrammarEnum BUGZILLA

The BUGZILLA grammar.

ALL

public static final GrammarEnum ALL

The ALL grammar.

Method Detail

extractMessage

public Message extractMessage(String content)

Extract a Message from the specified String content.

Parameters:

content - the String to be parsed.

Returns:

the corresponding Message.

See Also:

Message

hasMessage

public boolean hasMessage(String content)

Indicates if the content String matches the grammar.

Parameters:

content - the String to be tested against the grammar.

Returns:

true if the content matches the grammar - false otherwise.

getIssueSeparator

public 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.

valueOf

public static GrammarEnum valueOf(String name)

Return the enum element matching the specified name. MANU if no match is found.

Parameters:

name - the name of the required enum element.

Returns:

the enum element matching the specified name. MANU if no match is found.