Author: fdesbois Date: 2011-04-16 12:56:44 +0200 (Sat, 16 Apr 2011) New Revision: 2111 Url: http://nuiton.org/repositories/revision/nuiton-utils/2111 Log: Remove old nuitonUtil.apt : move docs from apt to javadoc + clean headers Removed: trunk/nuiton-utils/src/site/apt/nuitonUtil.apt Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/BoundedList.java trunk/nuiton-utils/src/main/java/org/nuiton/util/FileUtil.java trunk/nuiton-utils/src/main/java/org/nuiton/util/ObjectUtil.java trunk/nuiton-utils/src/main/java/org/nuiton/util/ReflectUtil.java trunk/nuiton-utils/src/main/java/org/nuiton/util/Resource.java trunk/nuiton-utils/src/main/java/org/nuiton/util/SortedProperties.java trunk/nuiton-utils/src/main/java/org/nuiton/util/StringUtil.java trunk/nuiton-utils/src/main/java/org/nuiton/util/ZipUtil.java trunk/nuiton-utils/src/site/apt/index.apt trunk/nuiton-utils/src/site/site_fr.xml trunk/src/site/apt/index.apt Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/BoundedList.java =================================================================== --- trunk/nuiton-utils/src/main/java/org/nuiton/util/BoundedList.java 2011-04-16 10:33:38 UTC (rev 2110) +++ trunk/nuiton-utils/src/main/java/org/nuiton/util/BoundedList.java 2011-04-16 10:56:44 UTC (rev 2111) @@ -39,7 +39,15 @@ import java.util.ArrayList; import java.util.Collection; -/** ArrayList with minimum and maximum sizes. For each operation, the size is checked and the BoundedList to ensure that it is kept in the range. */ +/** + * ArrayList with minimum and maximum sizes. For each operation, the size is + * checked and the BoundedList to ensure that it is kept in the range. + * <p/> + * Created: 10 juin 2005 + * + * @author athimel <thimel@codelutin.com> + * $Id$ + */ public class BoundedList<E> extends ArrayList<E> { /** */ private static final long serialVersionUID = -3211387041114409849L; Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/FileUtil.java =================================================================== --- trunk/nuiton-utils/src/main/java/org/nuiton/util/FileUtil.java 2011-04-16 10:33:38 UTC (rev 2110) +++ trunk/nuiton-utils/src/main/java/org/nuiton/util/FileUtil.java 2011-04-16 10:56:44 UTC (rev 2111) @@ -71,12 +71,26 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +/** + * Opérations sur des fichiers. Copie, suppression, renommage, + * recherche, fichiers d'un répertoire, sous-répertoires d'un répertoire, + * récupération du basename ou de l'extension, création d'un fichier + * temporaire, comparaison de dates de création, récupération d'une chaîne, + * d'un Reader ou d'un Writer à partir d'un fichier, récupération du fichier + * saisi dans une boîte de dialogue, conversions en byte[], en Stream... + * <p/> + * Created: 22 novembre 2004 + * + * @author bpoussin <poussin@codelutin.com> + * $Id$ + */ public class FileUtil { // FileUtil /** to use log facility, just put in your code: log.info(\"...\"); */ static private Log log = LogFactory.getLog(FileUtil.class); - /** Encoding par defaut utilisé si non spécifié */ + /** Encoding utilisé (peut être redéfini) */ + // TODO fdesbois 2011-04-16 : Perhaps change ISO encoding by UTF-8 static public String ENCODING = "ISO-8859-1"; static protected File currentDirectory = new File("."); Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/ObjectUtil.java =================================================================== --- trunk/nuiton-utils/src/main/java/org/nuiton/util/ObjectUtil.java 2011-04-16 10:33:38 UTC (rev 2110) +++ trunk/nuiton-utils/src/main/java/org/nuiton/util/ObjectUtil.java 2011-04-16 10:56:44 UTC (rev 2111) @@ -59,13 +59,23 @@ import org.apache.commons.beanutils.BeanUtils; import org.apache.commons.beanutils.ConvertUtils; +/** + * Outils pour manipuler des objets. Création d'un objet à partir d'une chaîne + * le décrivant, conversion d'un objet en Object, récupération de méthodes + * à partir de leur nom, de constructeurs à partir de leurs paramètres... + * <p/> + * Created: 4 novembre 2004 + * + * @author bpoussin <poussin@codelutin.com> + * $Id$ + */ public class ObjectUtil { // ObjectUtil /** to use log facility, just put in your code: log.info(\"...\"); */ static private Log log = LogFactory.getLog(ObjectUtil.class); - protected static final Integer ZERO = 0; - protected static final Character ZEROC = (char)0; + protected static final Integer ZERO = 0; + protected static final Character ZEROC = (char)0; protected static final Float ZEROF = 0f; protected static final Long ZEROL = 0l; protected static final Double ZEROD = 0.; Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/ReflectUtil.java =================================================================== --- trunk/nuiton-utils/src/main/java/org/nuiton/util/ReflectUtil.java 2011-04-16 10:33:38 UTC (rev 2110) +++ trunk/nuiton-utils/src/main/java/org/nuiton/util/ReflectUtil.java 2011-04-16 10:56:44 UTC (rev 2111) @@ -43,9 +43,14 @@ import static org.nuiton.i18n.I18n._; /** - * Des méthodes utiles d'introspection + * Introspection sur une classe. Détermine si un attribut est constant, + * recherche de constantes d'un type donné, conversion d'une classe en + * Enum... + * <p/> + * Created: 30 décembre 2007 * * @author tchemit <chemit@codelutin.com> + * $Id$ */ public class ReflectUtil { Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/Resource.java =================================================================== --- trunk/nuiton-utils/src/main/java/org/nuiton/util/Resource.java 2011-04-16 10:33:38 UTC (rev 2110) +++ trunk/nuiton-utils/src/main/java/org/nuiton/util/Resource.java 2011-04-16 10:56:44 UTC (rev 2111) @@ -66,7 +66,15 @@ * Cette class permet de rechercher un fichier en indiquant son nom avec son * chemin. Cette librairie ira ensuite chercher ce fichier sur le système de * fichier, et s'il n'est pas trouvé dans le classpath. Le fichier peut donc - * être dans un fichier .jar ou .zip. + * être dans un fichier .jar ou .zip. Exemple : + * <pre> + * URL image = Resource.getURL("/images/bidulle.png"); + * </pre> + * <p/> + * Created: 5 août 2003 + * + * @author bpoussin <poussin@codelutin.com> + * $Id$ */ public class Resource { // Resource Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/SortedProperties.java =================================================================== --- trunk/nuiton-utils/src/main/java/org/nuiton/util/SortedProperties.java 2011-04-16 10:33:38 UTC (rev 2110) +++ trunk/nuiton-utils/src/main/java/org/nuiton/util/SortedProperties.java 2011-04-16 10:56:44 UTC (rev 2111) @@ -32,9 +32,10 @@ import java.util.Vector; /** - * Permet d'avoir les fichiers de propriétés triés. + * Permet d'avoir les propriétés triées. * - * @author julien + * @author jruchaud <ruchaud@codelutin.com> + * $Id$ */ public class SortedProperties extends Properties { Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/StringUtil.java =================================================================== --- trunk/nuiton-utils/src/main/java/org/nuiton/util/StringUtil.java 2011-04-16 10:33:38 UTC (rev 2110) +++ trunk/nuiton-utils/src/main/java/org/nuiton/util/StringUtil.java 2011-04-16 10:56:44 UTC (rev 2111) @@ -54,9 +54,11 @@ * Classe contenant un ensemle de methode static utiles pour la manipulation des * chaine de caractere mais qui ne sont pas defini dans la classe String de * Java. + * <p/> + * Created: 21 octobre 2003 * - * @author poussin - * created 21 octobre 2003 + * @author bpoussin <poussin@codelutin.com> + * $Id$ */ public class StringUtil { public static final String[] EMPTY_STRING_ARRAY = new String[0]; // StringUtil Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/ZipUtil.java =================================================================== --- trunk/nuiton-utils/src/main/java/org/nuiton/util/ZipUtil.java 2011-04-16 10:33:38 UTC (rev 2110) +++ trunk/nuiton-utils/src/main/java/org/nuiton/util/ZipUtil.java 2011-04-16 10:56:44 UTC (rev 2111) @@ -47,15 +47,14 @@ import java.util.zip.ZipOutputStream; /** - * ZipUtil.java - * + * Opérations sur des fichiers Zip. Compression et décompression avec ou + * sans filtres, scan des fichiers créés ou écrasés lors de la décompression... + * <p/> * Created: 24 août 2006 10:13:35 * - * @author poussin - * @version $Revision$ - * - * Last update: $Date$ - * by : */ + * @author bpoussin <poussin@codelutin.com> + * $Id$ + */ public class ZipUtil { /** Class logger. */ Modified: trunk/nuiton-utils/src/site/apt/index.apt =================================================================== (Binary files differ) Deleted: trunk/nuiton-utils/src/site/apt/nuitonUtil.apt =================================================================== --- trunk/nuiton-utils/src/site/apt/nuitonUtil.apt 2011-04-16 10:33:38 UTC (rev 2110) +++ trunk/nuiton-utils/src/site/apt/nuitonUtil.apt 2011-04-16 10:56:44 UTC (rev 2111) @@ -1,302 +0,0 @@ - ---- - Documentation - ---- - ---- - 2009-08-23 - ---- - -~~~ -~~ #%L -~~ Nuiton Utils -~~ -~~ $Id$ -~~ $HeadURL$ -~~ %% -~~ Copyright (C) 2004 - 2010 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 -~~ published by the Free Software Foundation, either version 3 of the -~~ License, or (at your option) any later version. -~~ -~~ This program is distributed in the hope that it will be useful, -~~ but WITHOUT ANY WARRANTY; without even the implied warranty of -~~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -~~ GNU General Lesser Public License for more details. -~~ -~~ You should have received a copy of the GNU General Lesser Public -~~ License along with this program. If not, see -~~ <http://www.gnu.org/licenses/lgpl-3.0.html>. -~~ #L% -~~~ - -Documentation - - NuitonUtils contient un ensemble de librairies trop petites pour avoir - leur propre projet. Elles sont aussi utile à la plupart des projets de - Code Lutin. - - -Resource - - Cette librairie permet de rechercher une ressource dans le maximum - d'endroit possible et si elle est trouvée l'url de la ressource est - retournée. - ------------------------------------------------------------------------------- - import org.nuiton.util.Resource; - import java.net.URL; - ... - URL image = Resource.getURL("/images/bidulle.png"); - ... ------------------------------------------------------------------------------- - - Dans cet exemple l'image est recherchée sur le système de fichier - local, si elle n'est pas trouvée, elle est recherché dans le - classpath, et si elle n'est toujours pas trouvée une exception est - alors levée. - -Log - - Cette objet permet de suivre ce que fait une application simplement. Le - développeur indique grâce à cette classe l'état dans lequel l'application est. - - Ensuite, il peut mettre des listeners sur cette classe qui afficheront - les messages qui ont été envoyés. Ou afficheront l'état d'une tâche en train - de s'exécuter. - - -Liste des librairies - - Cette liste répertorie l'ensemble des librairies de NuitonUtils. - - -* Configuration - - Gestion de la configuration d'une l'application, de l'internationalisation, - des numéros de versions, des ressources... - -** ApplicationConfig - - Gestion des fichiers de configuration, des variables d'environnement - et des arguments de la ligne de commande. - -** Resource - - Recherche d'un fichier dans le système de fichiers et dans le classpath - (.jar, .zip). - -** ClassLoaderUtil - - Récupération des urls d'un URLClassLoader. - -** LocaleConverter - - Conversion d'une chaîne en Locale. - -** SortedProperties - - Fichier de propriétés trié par ordre alphabétique. - -** RecursiveProperties - - Fichier de propriétés contenant des références à des propriétés de ce - même fichier. - -** Version - - Représentation d'un numéro de version pour une application. - -** VersionConverter - - Conversion d'une chaine en VersionNumber. - -** VersionUtil - - Manipulation de numéros de version sous forme de chaînes - (comparaison, incrémentation...). - - -* Fichiers - - Gestion de fichiers. - -** FileUtil - - Opérations sur des fichiers. Copie, suppression, renommage, - recherche, fichiers d'un répertoire, sous-répertoires d'un répertoire, - récupération du basename ou de l'extension, création d'un fichier - temporaire, comparaison de dates de création, récupération d'une chaîne, - d'un Reader ou d'un Writer à partir d'un fichier, récupération du fichier - saisi dans une boîte de dialogue, conversions en byte[], en Stream... - -** IOUtils - - Copie d'un fichier, chemin temporaire... - -** ZipUtil - - Opérations sur des fichiers Zip. Compression et décompression avec ou - sans filtres, scan des fichiers créés ou écrasés lors de la décompression... - -** ZipStreamEncoder - - Encodage de fichiers Zip dans des threads. - -* Collections - - Gestion de collections et de tableaux. - -** CollectionUtil - - Manipulation des collections. Ajout de plusieurs éléments à une - collection, conversion d'une collection non typée en collection typée. - -** ArrayUtil - - Opérations sur des tableaux. Concaténation, somme, recherche, - conversion d'une liste en tableau, d'un String[] en int[]. - -** BoundedList - - ArrayList avec un nombre d'élément minimum et maximum. - -** HashList - Liste d'objets uniques. - -** TransformedList - Liste d'objets transformables (interface Transformer). - - -* Chaînes de caractères - - Gestion des chaînes de caractères. - -** StringUtil - - Manipulation de chaînes de caractères. Découpage, suppression - d'accents, vérification de parenthésage, conversions vers un nombre, - un tableau, une couleur, une date... - -** URIConverter - - Conversion d'une chaîne en URI. - -** URLConverter - - Conversion d'une chaîne en URL. - -** GZUtil - - Compression et décompression de chaînes de caractères. - - -* Analyse - - Analyse du code et monitoring. - -** CallAnalyse - - Analyse sur des appels de méthodes. Temps d'éxecution, mémoire - utilisée et nombre d'appels. - -* Log - Mise en place de logs dans une application. - -** LoggingPatternFormatter - Formattage des logs. - - -* Énumérations - - Gestion des énumérations et énumérations utiles. - -** EnumConverter - - Conversion d'une chaîne en Enum. - -** EnumEditor - - Editeur d'Enum en Swing. - -** H2TypeEnum - - Énumération pour représenter les différents types d'implantation dans H2. - -** MonthEnum - - Énumération pour représenter les mois d'une année. - -** SimplePaginationEnum - - Énumération pour définir les tailles de liste. - -* Introspection - - Introspection et manipulations sur des objets et des classes. - -** ObjectUtil - - Outils pour manipuler des objets. Création d'un objet à partir d'une chaîne - le décrivant, conversion d'un objet en Object, récupération de méthodes - à partir de leur nom, de constructeurs à partir de leurs paramètres... - -** ReflectUtil - - Introspection sur une classe. Détermine si un attribut est constant, - recherche de constantes d'un type donné, conversion d'une classe en - Enum... - -** FormatConverter - - Conversion d'une représentation d'un objet à une autre représentation. - (Java, SQL, XML...). - - -* Divers - - Autres librairies utiles n'appartenant à aucune des catégories précédentes. - -** CardinalityHelper - - Méthodes pour tester des cardinalités. - -** ListenerSet - - Mise en place de listeners. - -** CategorisedListenerSet - - Gestion des catégories de listeners. - -** ConverterUtil - - Méthodes sur des converters. - -** DigestGenerator - - Fonctionnalités de Digest XML. - -** MD5 - - Implémentation des MD5 hash. - -** MD5InputStream - - MD5 dans un flux. - -** DateUtil //(since 1.1.2)// - - Boîte à outils sur les dates (plus spécialisé que org.apache.commons.lang.DateUils) - -** PeriodDates //(since 1.1.2)// - - Objet correspondant à une période entre deux dates avec contraintes et méthodes utilitaires. - -** FileUtil#grep() //(since 1.1.2)// - - Unix like grep command - -** FileUtil#sed() //(since 1.1.2)// - - Unix like sed command Modified: trunk/nuiton-utils/src/site/site_fr.xml =================================================================== --- trunk/nuiton-utils/src/site/site_fr.xml 2011-04-16 10:33:38 UTC (rev 2110) +++ trunk/nuiton-utils/src/site/site_fr.xml 2011-04-16 10:56:44 UTC (rev 2111) @@ -41,8 +41,7 @@ <menu name="Utilisateur"> <item name="Accueil" href="index.html"/> - <item name="Documentation" href="/nuitonUtil.html"/> - <item name="Application config" href="/ApplicationConfig.html"/> + <item name="ApplicationConfig" href="/ApplicationConfig.html"/> </menu> <menu name="Téléchargement"> Modified: trunk/src/site/apt/index.apt =================================================================== --- trunk/src/site/apt/index.apt 2011-04-16 10:33:38 UTC (rev 2110) +++ trunk/src/site/apt/index.apt 2011-04-16 10:56:44 UTC (rev 2111) @@ -40,7 +40,7 @@ les collections, les maps, les chaînes de caractères, ... De plus elle intègre un parser des arguments et des options pour les lignes de commande (ApplicationConfig). - Pour plus d'informations, voir la {{{./nuiton-utils}documentation}} + {{{./nuiton-utils}Plus d'infos}} Librairie Nuiton-profiling @@ -52,11 +52,11 @@ * temps total d'exécution d'une méthode (avec les sous-méthodes) * temps d'appel des sous-méthodes - Pour son utilisation, voir la {{{./nuiton-profiling}documentation}} + {{{./nuiton-profiling}Plus d'infos}} Librairie Nuiton-validator Cette librairie propose une Api de validation plus complète que la JSR-303, permettant nottament de préciser des scopes (info, erreur, warning, ...) - Pour son utilisation, voir la {{{./nuiton-validator}documentation}} + {{{./nuiton-validator}Plus d'infos}}