com.atlassian.jira.project.version

Class CachingVersionStore

java.lang.Object

com.atlassian.jira.project.version.CachingVersionStore

All Implemented Interfaces:

VersionStore

public class CachingVersionStore
extends Object
implements VersionStore

A caching implementation of the VersionStore that relies on a delegate to do the DB operations.

Constructor Summary

Constructors

Constructor and Description
CachingVersionStore(VersionStore delegate, com.atlassian.cache.CacheManager cacheManager)

Method Summary

Modifier and Type	Method and Description
Version	createVersion(Version version)
void	deleteAllVersions(Long projectId) Deletes all versions in a given project by removing them from database.
void	deleteVersion(Version version) Deletes given Version object by removing it from database.
Iterable<Version>	getAllVersions() Returns a list of GenericValues representing all Versions in JIRA, ordered by sequence.
Version	getVersion(Long id)
Iterable<Version>	getVersionsByName(String name) Returns a list of GenericValues representing all Versions in JIRA with a given name, case insensitively.
Iterable<Version>	getVersionsByProject(Long projectId) Returns a list of GenericValues representing all Versions in a project.
void	onClearCache(ClearCacheEvent event)
void	storeVersion(Version version) Stores an individual Version in the DB.
void	storeVersions(Collection<Version> versions) Stores a collection of Version objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingVersionStore

public CachingVersionStore(VersionStore delegate,
                           com.atlassian.cache.CacheManager cacheManager)

Method Detail

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)

getAllVersions

@Nonnull
public Iterable<Version> getAllVersions()

Description copied from interface: VersionStore

Returns a list of GenericValues representing all Versions in JIRA, ordered by sequence.

Specified by:

getAllVersions in interface VersionStore

Returns:

a list of GenericValues representing all Versions in JIRA, ordered by sequence.

getVersion

public Version getVersion(Long id)

Specified by:

getVersion in interface VersionStore

createVersion

@Nonnull
public Version createVersion(@Nonnull
                                      Version version)

Specified by:

createVersion in interface VersionStore

storeVersion

public void storeVersion(@Nonnull
                         Version version)

Description copied from interface: VersionStore

Stores an individual Version in the DB. If you want to store a collection of Versions, consider using VersionStore.storeVersions(java.util.Collection<com.atlassian.jira.project.version.Version>), it can be more efficient.

Specified by:

storeVersion in interface VersionStore

Parameters:

version - The Version to store.

See Also:

VersionStore.storeVersions(java.util.Collection<com.atlassian.jira.project.version.Version>)

storeVersions

public void storeVersions(@Nonnull
                          Collection<Version> versions)

Description copied from interface: VersionStore

Stores a collection of Version objects. This method can have performance benefits over calling storeVersion() multiple times. eg the CachingVersionStore will reload the cache from DB with every call to storeVersion().

Specified by:

storeVersions in interface VersionStore

Parameters:

versions - Collection of Version objects.

See Also:

VersionStore.storeVersion(Version)

deleteVersion

public void deleteVersion(@Nonnull
                          Version version)

Description copied from interface: VersionStore

Deletes given Version object by removing it from database.

Specified by:

deleteVersion in interface VersionStore

Parameters:

version - to be deleted

deleteAllVersions

public void deleteAllVersions(@Nonnull
                              Long projectId)

Description copied from interface: VersionStore

Deletes all versions in a given project by removing them from database.

Specified by:

deleteAllVersions in interface VersionStore

Parameters:

projectId - of the project in which the versions will be deleted.

getVersionsByName

@Nonnull
public Iterable<Version> getVersionsByName(String name)

Description copied from interface: VersionStore

Returns a list of GenericValues representing all Versions in JIRA with a given name, case insensitively.

Specified by:

getVersionsByName in interface VersionStore

Parameters:

name - Version name

Returns:

a list of GenericValues representing all Versions in JIRA with a given name, case insensitively.

getVersionsByProject

@Nonnull
public Iterable<Version> getVersionsByProject(Long projectId)

Description copied from interface: VersionStore

Returns a list of GenericValues representing all Versions in a project.

Specified by:

getVersionsByProject in interface VersionStore

Parameters:

projectId - Project Id

Returns:

a list of GenericValues representing all Versions in a project