Package com.atlassian.bamboo.repository

Interface CacheDescription

All Known Implementing Classes:
CacheDescription.FileBased
public interface CacheDescription
Cache description bean used to display info about the single cache entry

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    CacheDescription.FileBased
    Default file based implementation.

  • Method Summary

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

  • Method Details

    • getKey

      String getKey()
      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.

      Returns:
      unique key identifying the cache directory
      See Also:

    • getLocation

      String getLocation()
      Cache directory location
      Returns:
      cache location as user readable string

    • getDescription

      String getDescription()
      Cache entry description, including all information that is necessary to distinguish one dir from another
      Returns:
      cache entry description

    • isExists

      boolean isExists()
      Information whether the cache directory currently exists on the server.
      Returns:
      true when directory exists

    • getUsingPlans

      Collection<ImmutablePlan> getUsingPlans()
      Collection of Plans that are currently configured to use this cache.
      Returns:
      collection of Plans that are currently configured to use this cache