com.atlassian.bamboo.repository
Class CacheDescription.FileBased

java.lang.Object
  com.atlassian.bamboo.repository.CacheDescription.FileBased

All Implemented Interfaces:

CacheDescription

Enclosing interface:

CacheDescription

public static class CacheDescription.FileBased
extends java.lang.Object
implements CacheDescription

Default file based implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.repository.CacheDescription

CacheDescription.FileBased

Constructor Summary

CacheDescription.FileBased(java.io.File cacheDir, java.lang.String description, java.util.Collection<Plan> plans)

Method Summary

java.lang.String	getDescription() Cache entry description, including all information that is necessary to distinguish one dir from another
java.lang.String	getKey() Unique for given CacheHandler key that would be used to identify which cache the user wants to delete.
java.lang.String	getLocation() Cache directory location
java.util.Collection<Plan>	getUsingPlans() Collection of Plans that are currently configured to use this cache.
boolean	isExists() Information whether the cache directory currently exists on the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheDescription.FileBased

public CacheDescription.FileBased(java.io.File cacheDir,
                                  java.lang.String description,
                                  java.util.Collection<Plan> plans)

Method Detail

getKey

public java.lang.String getKey()

Description copied from interface: CacheDescription

Unique for given CacheHandler key that would be used to identify which cache the user wants to delete.

This should be human readable as it will be displayed in the UI to indicate which caches were deleted.

Specified by:

getKey in interface CacheDescription

Returns:

unique key identifying the cache directory

See Also:

CacheHandler.deleteCaches(java.util.Collection, com.opensymphony.xwork.ValidationAware)

getLocation

public java.lang.String getLocation()

Description copied from interface: CacheDescription

Cache directory location

Specified by:

getLocation in interface CacheDescription

Returns:

cache location as user readable string

getDescription

public java.lang.String getDescription()

Description copied from interface: CacheDescription

Cache entry description, including all information that is necessary to distinguish one dir from another

Specified by:

getDescription in interface CacheDescription

Returns:

cache entry description

isExists

public boolean isExists()

Description copied from interface: CacheDescription

Information whether the cache directory currently exists on the server.

Specified by:

isExists in interface CacheDescription

Returns:

true when directory exists

getUsingPlans

public java.util.Collection<Plan> getUsingPlans()

Description copied from interface: CacheDescription

Collection of Plans that are currently configured to use this cache.

Specified by:

getUsingPlans in interface CacheDescription

Returns:

collection of Plans that are currently configured to use this cache