Changeset 2126

Show
Ignore:
Timestamp:
06/27/08 15:04:36 (4 months ago)
Author:
jon
Message:

[repository] add some comments to FortressRepository?

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/ProjectFortress/src/com/sun/fortress/repository/FortressRepository.java

    r2125 r2126  
    3939    public Map<APIName, ApiIndex> apis(); 
    4040 
     41    /** 
     42     * Add a compiled/processed api to the repository. 
     43     */ 
    4144    public void addApi(APIName name, ApiIndex definition); 
    4245 
     46    /** 
     47     * Add a compiled/processed component to the repository. 
     48     */ 
    4349    public void addComponent(APIName name, ComponentIndex definition); 
    4450 
     51    /** 
     52     * Retrieve an api from the repository given a name. 
     53     */ 
    4554    public ApiIndex getApi(APIName name) throws FileNotFoundException, IOException; 
    4655 
     56    /** 
     57     * Retrieve a component from the repository given a name. 
     58     */ 
    4759    public ComponentIndex getComponent(APIName name) throws FileNotFoundException, IOException, StaticError; 
     60 
     61    /** 
     62     * Retrieve a component from the repository that is linked properly to other components. 
     63     */ 
    4864    public ComponentIndex getLinkedComponent(APIName name) throws FileNotFoundException, IOException, StaticError; 
    4965 
     66    /** 
     67     * Return the last modification date of an api. 
     68     */ 
    5069    public long getModifiedDateForApi(APIName name) throws FileNotFoundException ; 
    5170 
     71    /** 
     72     * Return the last modification date of a component. 
     73     */ 
    5274    public long getModifiedDateForComponent(APIName name) throws FileNotFoundException ; 
    5375 
     76    /** 
     77     * Debugging methods. 
     78     */ 
    5479    public boolean setVerbose(boolean new_value); 
    5580    public boolean verbose();