Package com.atlassian.jira.project.util

Class ReleaseNoteManager

java.lang.Object

com.atlassian.jira.project.util.ReleaseNoteManager

public class ReleaseNoteManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ReleaseNoteManager.IssuesByType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RELEASE_NOTE_DEFAULT
static final String	RELEASE_NOTE_NAME
static final String	RELEASE_NOTE_TEMPLATE
static final String	TEMPLATES_DIR

Constructor Summary

Constructors

Constructor	Description
ReleaseNoteManager(ApplicationProperties applicationProperties, VelocityTemplatingEngine templatingEngine, ConstantsManager constantsManager, SearchService searchService, CustomFieldManager customFieldManager)

Method Summary

Modifier and Type	Method	Description
String	getReleaseNote(webwork.action.Action action, String releaseNoteStyleName, Version version, ApplicationUser user, Project project)	Returns a release note for this version, using the specified releaseNoteStyleName.
Map<String,String>	getStyles()

Methods inherited from class java.lang.Object

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

Field Details

RELEASE_NOTE_NAME

public static final String RELEASE_NOTE_NAME

See Also:

• Constant Field Values

RELEASE_NOTE_DEFAULT

public static final String RELEASE_NOTE_DEFAULT

See Also:

• Constant Field Values

RELEASE_NOTE_TEMPLATE

public static final String RELEASE_NOTE_TEMPLATE

See Also:

• Constant Field Values

TEMPLATES_DIR

public static final String TEMPLATES_DIR

See Also:

• Constant Field Values

Constructor Details

ReleaseNoteManager

public ReleaseNoteManager(ApplicationProperties applicationProperties,
 VelocityTemplatingEngine templatingEngine,
 ConstantsManager constantsManager,
 SearchService searchService,
 CustomFieldManager customFieldManager)

Method Details

getStyles

public Map<String,String> getStyles()

getReleaseNote

public String getReleaseNote(webwork.action.Action action,
 String releaseNoteStyleName,
 Version version,
 ApplicationUser user,
 Project project)

Returns a release note for this version, using the specified releaseNoteStyleName. The issues returned will be the issues that the user has permission to see.

Throws:

IllegalArgumentException - if there is no matching template for this releaseNoteStyleName