View Javadoc

1   package com.atlassian.user.repository;
2   
3   import java.io.Serializable;
4   
5   /**
6    * The identifier of a repository, which consists of a key and a name.
7    *
8    * The key is used as the unique identifier for the respository. The name is used in the user interface
9    * for identifying the repository for a user.
10   */
11  public interface RepositoryIdentifier extends Serializable
12  {
13      /**
14       * String uniquely identifying this repository. By default, it is configured in the key
15       * attribute on the repository tag in the atlassian-user.xml file.
16       * <p/>
17       * Implementation should not allow the key to be <code>null</code>.
18       */
19      String getKey();
20  
21      /**
22       * String with a more user-friendly name for the repository.
23       * <p/>
24       * Implementations should not allow the name to be <code>null</code>.
25       */
26      String getName();
27  }