Author: tchemit Date: 2008-04-06 09:49:11 +0000 (Sun, 06 Apr 2008) New Revision: 389 Modified: trunk/lutinvcs/lutinvcs-api/src/main/java/org/codelutin/vcs/VCSEntries.java trunk/lutinvcs/lutinvcs-api/src/main/java/org/codelutin/vcs/VCSEntry.java Log: javadoc Modified: trunk/lutinvcs/lutinvcs-api/src/main/java/org/codelutin/vcs/VCSEntries.java =================================================================== --- trunk/lutinvcs/lutinvcs-api/src/main/java/org/codelutin/vcs/VCSEntries.java 2008-04-06 09:48:53 UTC (rev 388) +++ trunk/lutinvcs/lutinvcs-api/src/main/java/org/codelutin/vcs/VCSEntries.java 2008-04-06 09:49:11 UTC (rev 389) @@ -21,7 +21,11 @@ import javax.swing.ListSelectionModel; import java.util.List; -/** @author chemit */ +/** + * Contract of list of VCSEntry + * + * @author chemit + */ public interface VCSEntries { /** @@ -64,6 +68,25 @@ void refresh(List<VCSEntry> entries, long timestamp) throws IllegalStateException; /** + * obtain the array of all {@link VCSAction} found in the given entries + * + * @param entries entries to scan + * @return array of {@link VCSAction} found in entires + */ + VCSAction[] getActions(List<VCSEntry> entries); + + /** + * obtain the array of all {@link VCSState} found in the given entries + * + * @param entries entries to scan + * @return array of {@link VCSState found in entires + */ + VCSState[] getStates(List<VCSEntry> entries); + + /** clear the internal list of entries. */ + void clear(); + + /** * obtain the list of all entries. * * @return list of all entries @@ -115,11 +138,4 @@ * @return list of all entries for a given connexion */ List<VCSEntry> filter(VCSAction action, List<VCSEntry> entries); - - VCSAction[] getActions(List<VCSEntry> entries); - - VCSState[] getStates(List<VCSEntry> entries); - - /** clear the list of entries. */ - void clear(); } Modified: trunk/lutinvcs/lutinvcs-api/src/main/java/org/codelutin/vcs/VCSEntry.java =================================================================== --- trunk/lutinvcs/lutinvcs-api/src/main/java/org/codelutin/vcs/VCSEntry.java 2008-04-06 09:48:53 UTC (rev 388) +++ trunk/lutinvcs/lutinvcs-api/src/main/java/org/codelutin/vcs/VCSEntry.java 2008-04-06 09:49:11 UTC (rev 389) @@ -21,7 +21,11 @@ import java.io.File; import java.io.Serializable; -/** @author chemit */ +/** + * Contract of an entry in VCS (a file or a dir) + * + * @author chemit + */ public interface VCSEntry extends Serializable { /**