Author: chatellier Date: 2009-09-02 08:15:23 +0000 (Wed, 02 Sep 2009) New Revision: 2565 Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/CodeSourceStorage.java isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/DataStorage.java isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/RegionStorage.java isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/VersionStorage.java isis-fish/trunk/src/main/java/fr/ifremer/isisfish/vcs/VCS.java Log: Fix doc & comments. Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/CodeSourceStorage.java =================================================================== --- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/CodeSourceStorage.java 2009-09-02 07:43:03 UTC (rev 2564) +++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/CodeSourceStorage.java 2009-09-02 08:15:23 UTC (rev 2565) @@ -47,26 +47,27 @@ public abstract class CodeSourceStorage extends VersionStorage { /** - * Le nom de la classe sans le package + * Le nom de la classe sans le package. */ protected String name = null; /** - * le contenu du fichier + * Le contenu du fichier. */ protected String content = null; /** - * date de derniere mise a jour de content, sert a detecter si content doit etre relu + * Date de derniere mise a jour de content, sert a detecter si content doit etre relu. */ protected long lastContentUpdate = 0; + /** - * la derniere taille connu du content, sert a detecter si content doit etre relu + * La derniere taille connu du content, sert a detecter si content doit etre relu. */ protected long lastContentLength = 0; /** - * Contruit un nouveau rule storage + * Contruit un nouveau rule storage. * * @param rootSrc repertoire racine des sources * @param directory le repertoire ou devrait se trouver la classe. Ce @@ -82,31 +83,34 @@ this.name = name.endsWith(suffix) ? name : name + suffix; } - /* (non-Javadoc) - * @see fr.ifremer.isisfish.datastore.VersionStorage#prepare() - */ + /* + * @see fr.ifremer.isisfish.datastore.VersionStorage#prepare() + */ @Override protected void prepare() { // Il n'y a rien a faire pour les code sources } /** - * Check if script exists - * @return + * Check if script exists. + * + * @return {@code true} if storage file exists */ public boolean exists() { return getFile().exists(); } /** - * @return Returns the name. + * Get storage name. + * + * @return the name. */ public String getName() { return this.name; } /** - * Retourne le contenu du fichier, si le fichier reel est plus recent + * Retourne le contenu du fichier. Si le fichier reel est plus recent * que la derniere lecture, alors il est relu automatiquement. Ce * mecanisme de relecture automatique peut ne pas fonctionner si entre * la derniere lecture de content et la modification directement du fichier @@ -135,7 +139,9 @@ } /** - * @param content The content to set. + * Set file content. + * + * @param content new content * @throws IOException */ public void setContent(String content) throws IOException { @@ -147,14 +153,20 @@ } /** - * permet de forcer la relecture du fichier sur le disque + * Permet de forcer la relecture du fichier sur le disque. */ public void reload() { content = null; } + /** + * Return diff between current file content and VCS file content. + * + * @return diff as string + * @throws VCSException + * @throws IOException + */ public String diff() throws VCSException, IOException { return getVCS().getDiff(getFile()); } - } Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/DataStorage.java =================================================================== --- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/DataStorage.java 2009-09-02 07:43:03 UTC (rev 2564) +++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/DataStorage.java 2009-09-02 08:15:23 UTC (rev 2565) @@ -53,17 +53,21 @@ */ public abstract class DataStorage extends VersionStorage { - static final public String DATA_BACKUP_FILENAME = "data-backup.sql.gz"; + /** Backup archive filename. */ + public static final String DATA_BACKUP_FILENAME = "data-backup.sql.gz"; /** Logger for this class */ private static final Log log = LogFactory.getLog(DataStorage.class); /** Le nom du storage (nom du dernier répertoire) */ protected String name = null; + /** Le TopiaContext contenant les données */ protected TopiaContext storage = null; + /** Le TopiaContext contenant les données en memoire */ protected TopiaContext memstorage = null; + /** le répertoire contenant les données sur le disque */ private File storageDirectory = null; @@ -327,8 +331,7 @@ /** * Cree un zip. Le zip contient les memes fichiers lorsqu'on utilise le CVS. * - * @param file - * le fichier dans lequel l'export doit se faire + * @param file le fichier dans lequel l'export doit se faire * @return l'argument file * @throws IOException si problème lors de la création du zip */ @@ -357,8 +360,6 @@ } /* - * (non-Javadoc) - * * @see java.lang.Object#finalize() */ @Override Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/RegionStorage.java =================================================================== --- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/RegionStorage.java 2009-09-02 07:43:03 UTC (rev 2564) +++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/RegionStorage.java 2009-09-02 08:15:23 UTC (rev 2565) @@ -44,7 +44,7 @@ import java.util.Map; /** - * Classe permettant de recuperer les TopiaContext des regions. + * Classe permettant de recuperer les {@link TopiaContext} des regions. * * Created: 17 août 2005 03:44:57 CEST * @@ -56,16 +56,16 @@ */ public class RegionStorage extends DataStorage { // RegionStorage - static final public String REGION_PATH = "regions"; - static final public String MAP_DIRECTORY = "maps"; + public static final String REGION_PATH = "regions"; + public static final String MAP_DIRECTORY = "maps"; /** to use log facility, just put in your code: log.info(\"...\"); */ - static private Log log = LogFactory.getLog(RegionStorage.class); + private static Log log = LogFactory.getLog(RegionStorage.class); @SuppressWarnings("unchecked") - static protected Map<String, RegionStorage> regions = (Map<String, RegionStorage>) new ReferenceMap(); + protected static Map<String, RegionStorage> regions = (Map<String, RegionStorage>) new ReferenceMap(); - /** File to use to store next commit region comment */ + /** File to use to store next commit region comment. */ protected File commentForNextCommitFile = null; /** @@ -75,27 +75,27 @@ * @param name region name * * FIXME constructor is public for hack in - * fr.ifremer.isisfish.simulator.SimulationParameter.fromProperties(File, Properties) + * {@link fr.ifremer.isisfish.simulator.SimulationParameter#fromProperties(File, java.util.Properties)} * set protected when fix hack */ public RegionStorage(File directory, String name) { super(directory, name); commentForNextCommitFile = new File(getDirectory(), "commentForNextCommit.txt"); } - - static public File getRegionDirectory() { + + public static File getRegionDirectory() { File result = IsisFish.config.getDatabaseDirectory(); result = new File(result, REGION_PATH); result.mkdirs(); return result; } - static public File getRegionDirectory(String name) { + public static File getRegionDirectory(String name) { File result = getRegionDirectory(); result = new File(result, name); return result; } - + /** * @return Returns the commentForNextCommit. * @throws IOException if IO problem while reading file @@ -126,9 +126,9 @@ commentForNextCommitFile.renameTo(dest); } - /* (non-Javadoc) - * @see fr.ifremer.isisfish.datastore.DataStorage#isVersionnableAbleFile(java.io.File) - */ + /* + * @see fr.ifremer.isisfish.datastore.DataStorage#isVersionnableAbleFile(java.io.File) + */ @Override protected boolean isVersionnableAbleFile(File file) { boolean result = super.isVersionnableAbleFile(file); @@ -151,9 +151,9 @@ setCommentForNextCommit(comment); } - /* (non-Javadoc) - * @see fr.ifremer.isisfish.datastore.DataStorage#rename(java.lang.String) - */ + /* + * @see fr.ifremer.isisfish.datastore.DataStorage#rename(java.lang.String) + */ @Override public void rename(String toName) throws StorageException { try { @@ -460,4 +460,3 @@ } } // RegionStorage - Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/VersionStorage.java =================================================================== --- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/VersionStorage.java 2009-09-02 07:43:03 UTC (rev 2564) +++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/datastore/VersionStorage.java 2009-09-02 08:15:23 UTC (rev 2565) @@ -39,7 +39,7 @@ import fr.ifremer.isisfish.vcs.VCSException; /** - * Classe permettant de géré l'interaction avec le cvs + * Classe permettant de géré l'interaction avec le VSC. * * @author poussin * @version $Revision$ @@ -100,7 +100,8 @@ * (ex pour Region) alors vrai meme si tous les fichiers du repertoire * ne sont pas sur le VCSNone * - * @return vrai si deja dans le VCSNone + * @return {@code true} si deja dans le VCS + * @throws VCSException */ public boolean isOnRemote() throws VCSException { return getVCS().isOnRemote(getFile()); @@ -108,11 +109,11 @@ /** * Permet de savoir si un fichier doit etre géré par le vcs ou non. - * L'implantation par defaut exclus les répertoires VCSNone, il faut + * L'implantation par defaut exclus les répertoires VCS, il faut * toujours appeler le super si on surcharge la methode. * * @param file le fichier a tester - * @return <code>true</code> si le fichier est versionné + * @return {@code true} si le fichier est versionné */ protected boolean isVersionnableAbleFile(File file) { @@ -127,14 +128,14 @@ // du storage boolean result = true; - if(getVCS().getLocalRepository().equals(this.file)) { + if (getVCS().getLocalRepository().equals(this.file)) { result = getVCS().isVersionnableAbleFile(file); } return result; } /** - * Donne la liste de tous les fichiers que le VCSNone doit gérer. + * Donne la liste de tous les fichiers que le VCS doit gérer. * Par defaut parcours tous les repertoires et ajouter tous les fichiers * et repertoire trouvé. Il est possible d'exclure des fichiers et/ou * repertoire en surchargeant {@link #isVersionnableAbleFile(File)} @@ -214,7 +215,7 @@ } } //TODO There is a bug to fix ? some files are not deleted! - if (getFile().isDirectory()){ + if (getFile().isDirectory()) { FileUtil.deleteRecursively(getFile()); } else { getFile().delete(); @@ -239,7 +240,6 @@ * a sur le VCS * * @throws VCSException si pb pendant l'op - * */ public void update() throws VCSException { prepare(); @@ -258,9 +258,8 @@ * @param destDir le repertoire parent * @param module le repertoire qui peut etre scripts ou exports * @throws VCSException si pb pendant l'opération - * */ - static public void checkout(File destDir, String module) throws VCSException { + public static void checkout(File destDir, String module) throws VCSException { // Si on utilise pas le bon tag on change de tag VersionNumber tag = IsisConfig.getApiVersion(); if (!getVCS().isTag(tag)) { @@ -278,7 +277,7 @@ * @param directory le répertoire dans lequel vie l'ensemble des storage * @return la liste des noms de toutes les storages disponible en local */ - static public List<String> getStorageNames(File directory) { + public static List<String> getStorageNames(File directory) { List<String> result = new ArrayList<String>(); if (directory.exists()) { @@ -303,7 +302,7 @@ * serveur VCSNone. Si le serveur n'est pas disponible la liste retournée * est vide. */ - static public List<String> getRemoteStorageNames(File directory) { + public static List<String> getRemoteStorageNames(File directory) { List<String> result = null; try { result = getVCS().getFileList(directory); @@ -318,6 +317,8 @@ /** * Fire a change event to all registred listeners. * + * For example, to notify, that a {@link JavaStorage} file has been added... + * * @param event event to fire */ protected void fireDataChanged(Event event) { @@ -330,5 +331,3 @@ } } } - - Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/vcs/VCS.java =================================================================== --- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/vcs/VCS.java 2009-09-02 07:43:03 UTC (rev 2564) +++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/vcs/VCS.java 2009-09-02 08:15:23 UTC (rev 2565) @@ -1,5 +1,5 @@ /* *##% Isis-Fish - * Copyright (C) 2007 - 2009 CodeLutin + * Copyright (C) 2007 - 2009 Ifremer, CodeLutin * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -247,7 +247,7 @@ boolean isUpToDate(File file) throws VCSException; /** - * Check if file can be put in vcs repository, for example when you used + * Check if file can be put in vcs repository. For example when you used * CVS, you must not put CVS file. * <p> * default refused .svn, CVS and ~ filename @@ -255,7 +255,7 @@ * Must be override, this default implementation return true. * * @param file - * @return <tt>true</tt> if file is versionnable + * @return {@code true} if file is versionnable */ boolean isVersionnableAbleFile(File file);