April 2011 - Nuiton-utils-commits - mailman.cloud.codelutin.com

r2123 - trunk/nuiton-utils/src/main/java/org/nuiton/util
by echatellier＠users.nuiton.org April 28, 2011

April 28, 2011

Author: echatellier Date: 2011-04-28 12:14:57 +0200 (Thu, 28 Apr 2011) New Revision: 2123 Url: http://nuiton.org/repositories/revision/nuiton-utils/2123 Log: Fix javadoc Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/TimeLog.java Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/TimeLog.java =================================================================== --- trunk/nuiton-utils/src/main/java/org/nuiton/util/TimeLog.java 2011-04-28 10:13:02 UTC (rev 2122) +++ trunk/nuiton-utils/src/main/java/org/nuiton/util/TimeLog.java 2011-04-28 10:14:57 UTC (rev 2123) @@ -159,7 +159,7 @@ /** * - * @param timeToWarnInfoMs time in milliseconde after that we log warn + * @param timeToLogWarnMs time in milliseconde after that we log warn */ public void setTimeToLogWarn(long timeToLogWarnMs) { this.timeToLogWarn = timeToLogWarnMs * 1000000l; // convert ms -> ns

1 0

r2122 - trunk/nuiton-utils/src/test/java/org/nuiton/util
by echatellier＠users.nuiton.org April 28, 2011

April 28, 2011

Author: echatellier Date: 2011-04-28 12:13:02 +0200 (Thu, 28 Apr 2011) New Revision: 2122 Url: http://nuiton.org/repositories/revision/nuiton-utils/2122 Log: Remove log class Removed: trunk/nuiton-utils/src/test/java/org/nuiton/util/LogTest.java Deleted: trunk/nuiton-utils/src/test/java/org/nuiton/util/LogTest.java =================================================================== --- trunk/nuiton-utils/src/test/java/org/nuiton/util/LogTest.java 2011-04-28 10:10:36 UTC (rev 2121) +++ trunk/nuiton-utils/src/test/java/org/nuiton/util/LogTest.java 2011-04-28 10:13:02 UTC (rev 2122) @@ -1,136 +0,0 @@ -/* - * #%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% - */ - -/* * - * LogTest.java - * - * Created: 12 août 2004 - * - * @author Benjamin Poussin <poussin(a)codelutin.com> - * @version $Revision$ - * - * Mise a jour: $Date$ - * par : */ - -package org.nuiton.util; - -import junit.framework.TestCase; - -/** - * @deprecated since 1.4.1, will not be replaced. - */ -@Deprecated -public class LogTest extends TestCase { // LogTest - - protected int callTest = 0; - protected int callAll = 0; - protected int taskMax = 0; - protected int taskValue = 0; - - public class LogListenerTest implements Log.LogListener { - boolean all = false; - - public LogListenerTest(boolean all) { - this.all = all; - } - - public void logMessage(Log.LogEvent e) { - if (all) callAll++; - else callTest++; - } - - public void logTask(Log.LogEvent e) { - taskMax = e.getTaskMax(); - taskValue = e.getTaskValue(); - } - } - - public void testLog() throws Exception { - LogListenerTest ltest = new LogListenerTest(false); - LogListenerTest lall = new LogListenerTest(true); - - Log.addLogListener(lall); - Log.addLogListener(ltest, "TEST"); - - assertEquals(callTest, 0); - assertEquals(callAll, 0); - - Log.logUserInfo("TEST", "coucou"); - - assertEquals(callTest, 1); - assertEquals(callAll, 1); - - Log.logUserInfo("OTHERTEST", "coucou"); - - assertEquals(callTest, 1); - assertEquals(callAll, 2); - - Log.removeLogListener(lall); - Log.logUserInfo("TEST", "coucou"); - - assertEquals(callTest, 2); - assertEquals(callAll, 2); - - Log.logUserInfo("OTHERTEST", "coucou"); - - assertEquals(callTest, 2); - assertEquals(callAll, 2); - - Log.removeLogListener(ltest, "TEST"); - Log.logUserInfo("TEST", "coucou"); - - assertEquals(callTest, 2); - assertEquals(callAll, 2); - - Log.addLogListener(lall); - Log.logUserInfo("TEST", "coucou"); - - assertEquals(callTest, 2); - assertEquals(callAll, 3); - - // test des task - - assertEquals(0, taskMax); - assertEquals(0, taskValue); - - Log.logTask("TEST", "on avance", -1, 0); - assertEquals(-1, taskMax); - assertEquals(0, taskValue); - - Log.logTask("TEST", "on avance", 0, 0); - assertEquals(0, taskMax); - assertEquals(0, taskValue); - - Log.logTask("TEST", "on avance", 10, 5); - assertEquals(10, taskMax); - assertEquals(5, taskValue); - - Log.logTask("TEST", "on avance", 10, 10); - assertEquals(10, taskMax); - assertEquals(10, taskValue); - } - -} // LogTest -

1 0

r2121 - trunk/nuiton-utils/src/main/java/org/nuiton/util
by echatellier＠users.nuiton.org April 28, 2011

April 28, 2011

Author: echatellier Date: 2011-04-28 12:10:36 +0200 (Thu, 28 Apr 2011) New Revision: 2121 Url: http://nuiton.org/repositories/revision/nuiton-utils/2121 Log: Remove log class Removed: trunk/nuiton-utils/src/main/java/org/nuiton/util/Log.java Deleted: trunk/nuiton-utils/src/main/java/org/nuiton/util/Log.java =================================================================== --- trunk/nuiton-utils/src/main/java/org/nuiton/util/Log.java 2011-04-28 09:47:23 UTC (rev 2120) +++ trunk/nuiton-utils/src/main/java/org/nuiton/util/Log.java 2011-04-28 10:10:36 UTC (rev 2121) @@ -1,293 +0,0 @@ -/* - * #%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% - */ - -/* * - * Log.java - * - * Created: 12 août 2004 - * - * @author Benjamin Poussin <poussin(a)codelutin.com> - * @version $Revision$ - * - * Mise a jour: $Date$ - * par : */ - -package org.nuiton.util; - -import java.util.EventListener; -import java.util.EventObject; -import java.util.logging.Level; -import java.util.logging.Logger; - -/** - * Cette classe permet de mettre en place un monitoring d'application simplement. - * Le développeur a chaque fois qu'il le souhaite ajoute dans son code un - * Log.logUserInfo("...", "....") qui indique un message que l'utilisateur est - * suceptible de vouloir, par exemple le résultat de la sauvegarde d'un fichier. - * Ou bien si l'application effectue un traitement, il peut utiliser - * Log.logTask("...", "...", max, value) pour indiquer qu'un traitement est - * en cours. - * <p/> - * Il suffit ensuite de creer un objet qui herite de {@link LogListener}, puis - * de l'enregistrer sur certaine category d'event il recevra alors les - * evenements de l'utilisateur. - * <p/> - * Une utilisation peut-être la bar de status qui afficherait le message. - * <p/> - * exemple de code - * <pre> - * LogListener l = new StatusBar(); - * Log.addLogListener(l); - * ... - * ... - * ... - * Log.logTask("SAVE", "Sauvegarde en cours", -1, 0); - * ... // sauvegarde - * Log.logUserInfo("SAVE", "Sauvegarde réussie"); - * Log.logTask("SAVE", "Sauvegarde terminée", 0, 0); - * </pre> - * @deprecated since 1.4.1, there should be some others libraries much better than that... - */ -@Deprecated -public class Log { // Log - - static private Log LOG_INSTANCE = new Log(); - - /** L'interface que doivent respecter un listener */ - public interface LogListener extends EventListener { - void logMessage(LogEvent e); - - void logTask(LogEvent e); - } - - /** Les events envoyes aux listeners */ - static public class LogEvent extends EventObject { - /** */ - private static final long serialVersionUID = 6597052732707368243L; - - protected String category; - protected Level level; - protected String message; - protected Throwable exception; - protected int taskMax = 0; - protected int taskValue = 0; - - public LogEvent(Object source, String category, Level level, String message, Throwable exception) { - super(source == null ? LOG_INSTANCE : source); - this.category = category; - this.level = level; - this.message = message; - this.exception = exception; - } - - public LogEvent(Object source, String category, String message, int taskMax, int taskValue) { - super(source == null ? LOG_INSTANCE : source); - this.category = category; - this.message = message; - this.taskMax = taskMax; - this.taskValue = taskValue; - } - - public String getCategory() { - return category; - } - - /** Retourne une valeur que si l'event est un sendMessage, sinon null; */ - public Level getLevel() { - return level; - } - - public String getMessage() { - return message; - } - - /** - * L'exception envoyé dans le log, si le log ne contient pas d'exception - * alors null est retourne. - */ - public Throwable getException() { - return exception; - } - - public int getTaskMax() { - return taskMax; - } - - public int getTaskValue() { - return taskValue; - } - - } - - /** Le Level pour les log utilisateur */ - static private class UserLevel extends Level { - /** */ - private static final long serialVersionUID = -9075227788352473733L; - - public UserLevel(String name, int value) { - super(name, value); - } - } - - /** Tous les listeners */ - static protected CategorisedListenerSet<LogListener> listeners = new CategorisedListenerSet<LogListener>(); - - /** Level.INFO = 700 Level.FINE=500 * */ - public static final Level USER_INFO = new UserLevel("USERINFO", 600); - - /** Ajoute un listener sur tous les logs envoye */ - static public void addLogListener(LogListener l) { - listeners.add(LOG_INSTANCE, l); - } - - /** enleve un listener sur tous les logs envoye */ - static public void removeLogListener(LogListener l) { - listeners.remove(LOG_INSTANCE, l); - } - - /** Ajoute un listener sur une certaine category de log */ - static public void addLogListener(LogListener l, String category) { - listeners.add(category, l); - } - - /** enleve un listener sur une certaine category de log */ - static public void removeLogListener(LogListener l, String category) { - listeners.remove(category, l); - } - - static protected void fire(String category, Level level, String message, Throwable exception) { - LogEvent e = new LogEvent(null, category, level, message, exception); - try { - logDevFinest("org.nuiton.util.Log.fire", "Category: " + category + " listeners enregistrés: " + listeners); - listeners.fire(category, "logMessage", e); - listeners.fire(LOG_INSTANCE, "logMessage", e); - } catch (Exception eee) { - Logger.getLogger(Log.class.getName() + ".fire").log(Level.WARNING, "Error during send log event", eee); - } - } - - static protected void fire(String category, String message, int max, int value) { - LogEvent e = new LogEvent(null, category, message, max, value); - try { - log("org.nuiton.util.Log.fire", Level.FINEST, "Category: " + category + " listeners enregistrés: " + listeners, null); - listeners.fire(category, "logTask", e); - listeners.fire(LOG_INSTANCE, "logTask", e); - } catch (Exception eee) { - Logger.getLogger(Log.class.getName() + ".fire").log(Level.WARNING, "Error during send log event", eee); - } - } - - /** - * Ajoute un message dans le USER_LEVEL. - * - * @param category la category du message, souvent un nom de module d'une - * application. - * @param message le message a envoyer - */ - static public void logUserInfo(String category, String message) { - logUserInfo(category, message, null); - } - - static public void logUserInfo(String category, String message, Throwable e) { - log(category, USER_INFO, message, e); - fire(category, USER_INFO, message, e); - } - - /** - * Permet d'indiquer l'avancement d'une tache. Si l'on ne connait pas la - * longueur de la tache il suffit d'indiquer -1 dans max, pour indiquer - * une tache en cours dont on ne connait pas la fin. - * lorsque la tache est termine, il suffit d'appeler cette methode avec max - * valant 0. - * - * @param category la category de la tache - * @param message le message a afficher, le message peut-etre null - * @param max l'entier qui indique la fin de la tache. La tache commence a - * 0 et fini lorsque l'on arrive a max. Si max vaut -1 cela veut dire - * que la tache debute mais qu'on ne connait pas sa longueur - * @param current la valeur courante de la tache. - */ - static public void logTask(String category, String message, int max, int current) { - log(category, USER_INFO, "task: " + message + "[" + current + "/" + max + "]", null); - fire(category, message, max, current); - } - - static public void log(String category, Level level, String message, Throwable e) { - if (e == null) { - Logger.getLogger(category).log(level, message); - } else { - Logger.getLogger(category).log(level, message, e); - } - } - - static public void logDevFinest(String category, String message) { - logDevFinest(category, message, null); - } - - static public void logDevFinest(String category, String message, Throwable e) { - log(category, Level.FINEST, message, e); - } - - static public void logDevFiner(String category, String message) { - logDevFiner(category, message, null); - } - - static public void logDevFiner(String category, String message, Throwable e) { - log(category, Level.FINER, message, e); - } - - static public void logDevFine(String category, String message) { - logDevFine(category, message, null); - } - - static public void logDevFine(String category, String message, Throwable e) { - log(category, Level.FINE, message, e); - } - - static public void logDevInfo(String category, String message) { - logDevInfo(category, message, null); - } - - static public void logDevInfo(String category, String message, Throwable e) { - log(category, Level.INFO, message, e); - } - - static public void logDevWarn(String category, String message) { - logDevInfo(category, message, null); - } - - static public void logDevWarn(String category, String message, Throwable e) { - log(category, Level.WARNING, message, e); - } - - static public void logDevSevere(String category, String message) { - logDevSevere(category, message, null); - } - - static public void logDevSevere(String category, String message, Throwable e) { - log(category, Level.SEVERE, message, e); - } - -} // Log

1 0

r2120 - trunk/nuiton-utils/src/main/java/org/nuiton/util
by echatellier＠users.nuiton.org April 28, 2011

April 28, 2011

Author: echatellier Date: 2011-04-28 11:47:23 +0200 (Thu, 28 Apr 2011) New Revision: 2120 Url: http://nuiton.org/repositories/revision/nuiton-utils/2120 Log: Deprecate class Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/StreamKeywordTokenizer.java Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/StreamKeywordTokenizer.java =================================================================== --- trunk/nuiton-utils/src/main/java/org/nuiton/util/StreamKeywordTokenizer.java 2011-04-28 09:41:53 UTC (rev 2119) +++ trunk/nuiton-utils/src/main/java/org/nuiton/util/StreamKeywordTokenizer.java 2011-04-28 09:47:23 UTC (rev 2120) @@ -44,7 +44,9 @@ /** * TODO What is it for ? + * @deprecated since 2.2 : unused, undocumented */ +@Deprecated public class StreamKeywordTokenizer extends StreamTokenizer { // StreamKeywordTokenizer public static final int TT_KEYWORD = -101;

1 0

r2119 - trunk/nuiton-utils/src/main/java/org/nuiton/util
by echatellier＠users.nuiton.org April 28, 2011

April 28, 2011

Author: echatellier Date: 2011-04-28 11:41:53 +0200 (Thu, 28 Apr 2011) New Revision: 2119 Url: http://nuiton.org/repositories/revision/nuiton-utils/2119 Log: Remove deprecated method getConfigProperties() Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/Resource.java 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-26 17:03:12 UTC (rev 2118) +++ trunk/nuiton-utils/src/main/java/org/nuiton/util/Resource.java 2011-04-28 09:41:53 UTC (rev 2119) @@ -5,7 +5,7 @@ * $Id$ * $HeadURL$ * %% - * Copyright (C) 2004 - 2010 CodeLutin + * Copyright (C) 2004 - 2011 CodeLutin, Chatellier Eric * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -23,18 +23,6 @@ * #L% */ -/** - * Resource.java - * - * Created: Sun Apr 14 2002 - * - * @author POUSSIN Benjamin <bpoussin(a)free.fr> - * Copyright Code Lutin - * @version $Revision$ - * - * Mise a jour: $Date$ - * par : */ - package org.nuiton.util; import org.apache.commons.logging.Log; @@ -111,7 +99,6 @@ method.invoke(classLoader, url); } catch (Exception eee) { throw new RuntimeException(_("nuitonutil.error.add.url.in.classloader", classLoader, eee)); - //throw new RuntimeException("Can't add url in classloader " + classLoader,eee); } } @@ -182,84 +169,6 @@ } /** - * Recherche et retourne l'objet properties de configuration à utiliser. - * <p/> - * Les différents fichiers trouvé sont chainé. L'ordre de recherche est le - * classpath, le fichier dans /etc et enfin le chemin sur le filesystem. - * - * @param filename le nom du fichier à rechercher - * @return l'objet Properties de configuration - * @throws IOException si une erreur est survenue - * @deprecated since 1.1.2, use {@link ApplicationConfig} class instead - * to {@link ApplicationConfig#setConfigFileName(String) } - * and search properties file from more folders with - * {@link ApplicationConfig#parse(String[]) } method - */ - @Deprecated - static public Properties getConfigProperties(String filename) - throws IOException { - Properties result; - result = getConfigProperties(filename, null); - return result; - } - - /** - * Recherche et retourne l'objet properties de configuration à utiliser. - * <p/> - * Les différents fichiers trouvé sont chainé. L'ordre de recherche est le - * classpath, le fichier dans /etc et enfin le chemin sur le filesystem. - * - * @param filename le nom du fichier à rechercher - * @param parent les proprietes parent a surcharger - * @return l'objet Properties de configuration - * @throws IOException si une erreur est survenue - * @deprecated since 1.1.2, use {@link ApplicationConfig} class instead - * to {@link ApplicationConfig#setConfigFileName(String) } - * and search properties file from more folders with - * {@link ApplicationConfig#parse(String[]) } method - */ - @Deprecated - static public Properties getConfigProperties(String filename, - Properties parent) throws IOException { - Properties result; - if (parent != null) { - result = new Properties(parent); - } else { - result = new Properties(); - } - - URL inClasspath = ClassLoader.getSystemClassLoader().getResource( - filename); - if (inClasspath == null) { - inClasspath = Resource.class.getResource(filename); - } - if (inClasspath == null) { - inClasspath = getURLOrNull(filename); - } - if (inClasspath != null) { - log.info("Chargement du fichier de config: " + inClasspath); - result.load(inClasspath.openStream()); - result = new Properties(result); - } - - File etcConfig = new File("/etc/" + filename); - if (etcConfig.exists()) { - log.info("Chargement du fichier de config: " + etcConfig); - result.load(etcConfig.toURI().toURL().openStream()); - result = new Properties(result); - } - - File config = new File(filename); - if (config.exists()) { - log.info("Chargement du fichier de config: " + config); - result.load(config.toURI().toURL().openStream()); - result = new Properties(result); - } - - return result; - } - - /** * Retourner la liste des fichiers du classLoader. Ces fichiers doivent * correspondre au pattern donne. *

1 0

r2118 - in trunk: . nuiton-profiling nuiton-utils nuiton-validator
by sletellier＠users.nuiton.org April 26, 2011

April 26, 2011

Author: sletellier Date: 2011-04-26 19:03:12 +0200 (Tue, 26 Apr 2011) New Revision: 2118 Url: http://nuiton.org/repositories/revision/nuiton-utils/2118 Log: [maven-release-plugin] prepare for next development iteration Modified: trunk/nuiton-profiling/pom.xml trunk/nuiton-utils/pom.xml trunk/nuiton-validator/pom.xml trunk/pom.xml Modified: trunk/nuiton-profiling/pom.xml =================================================================== --- trunk/nuiton-profiling/pom.xml 2011-04-26 17:03:09 UTC (rev 2117) +++ trunk/nuiton-profiling/pom.xml 2011-04-26 17:03:12 UTC (rev 2118) @@ -33,7 +33,7 @@ <parent> <groupId>org.nuiton</groupId> <artifactId>nuiton-utils-parent</artifactId> - <version>2.1.2</version> + <version>2.2-SNAPSHOT</version> </parent> <artifactId>nuiton-profiling</artifactId> Modified: trunk/nuiton-utils/pom.xml =================================================================== --- trunk/nuiton-utils/pom.xml 2011-04-26 17:03:09 UTC (rev 2117) +++ trunk/nuiton-utils/pom.xml 2011-04-26 17:03:12 UTC (rev 2118) @@ -33,7 +33,7 @@ <parent> <groupId>org.nuiton</groupId> <artifactId>nuiton-utils-parent</artifactId> - <version>2.1.2</version> + <version>2.2-SNAPSHOT</version> </parent> <artifactId>nuiton-utils</artifactId> Modified: trunk/nuiton-validator/pom.xml =================================================================== --- trunk/nuiton-validator/pom.xml 2011-04-26 17:03:09 UTC (rev 2117) +++ trunk/nuiton-validator/pom.xml 2011-04-26 17:03:12 UTC (rev 2118) @@ -33,7 +33,7 @@ <parent> <groupId>org.nuiton</groupId> <artifactId>nuiton-utils-parent</artifactId> - <version>2.1.2</version> + <version>2.2-SNAPSHOT</version> </parent> <artifactId>nuiton-validator</artifactId> Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2011-04-26 17:03:09 UTC (rev 2117) +++ trunk/pom.xml 2011-04-26 17:03:12 UTC (rev 2118) @@ -37,7 +37,7 @@ </parent> <artifactId>nuiton-utils-parent</artifactId> - <version>2.1.2</version> + <version>2.2-SNAPSHOT</version> <modules> <module>nuiton-utils</module> @@ -217,12 +217,12 @@  <scm> <connection> - scm:svn:http://svn.nuiton.org/svn/nuiton-utils/tags/nuiton-utils-parent-2.1… + scm:svn:http://svn.nuiton.org/svn/nuiton-utils/trunk </connection> <developerConnection> - scm:svn:http://svn.nuiton.org/svn/nuiton-utils/tags/nuiton-utils-parent-2.1… + scm:svn:http://svn.nuiton.org/svn/nuiton-utils/trunk </developerConnection> - <url>http://www.nuiton.org/repositories/browse/nuiton-utils/tags/nuiton-utils-pa…</url> + <url>http://www.nuiton.org/repositories/browse/nuiton-utils/trunk</url> </scm> </project>

1 0

r2117 - in tags: . nuiton-utils-parent-2.1.2
by sletellier＠users.nuiton.org April 26, 2011

April 26, 2011

Author: sletellier Date: 2011-04-26 19:03:09 +0200 (Tue, 26 Apr 2011) New Revision: 2117 Url: http://nuiton.org/repositories/revision/nuiton-utils/2117 Log: [maven-release-plugin] copy for tag nuiton-utils-parent-2.1.2 Added: tags/nuiton-utils-parent-2.1.2/ Property changes on: tags/nuiton-utils-parent-2.1.2 ___________________________________________________________________ Added: svn:ignore + target velocity.log maven.log .eclipse .classpath *.iml *.ipr *.iws .settings .project testdir Added: svn:mergeinfo +

1 0

r2116 - in trunk: . nuiton-profiling nuiton-utils nuiton-validator
by sletellier＠users.nuiton.org April 26, 2011

April 26, 2011

Author: sletellier Date: 2011-04-26 19:03:03 +0200 (Tue, 26 Apr 2011) New Revision: 2116 Url: http://nuiton.org/repositories/revision/nuiton-utils/2116 Log: [maven-release-plugin] prepare release nuiton-utils-parent-2.1.2 Modified: trunk/nuiton-profiling/pom.xml trunk/nuiton-utils/pom.xml trunk/nuiton-validator/pom.xml trunk/pom.xml Modified: trunk/nuiton-profiling/pom.xml =================================================================== --- trunk/nuiton-profiling/pom.xml 2011-04-26 09:27:29 UTC (rev 2115) +++ trunk/nuiton-profiling/pom.xml 2011-04-26 17:03:03 UTC (rev 2116) @@ -33,7 +33,7 @@ <parent> <groupId>org.nuiton</groupId> <artifactId>nuiton-utils-parent</artifactId> - <version>2.2-SNAPSHOT</version> + <version>2.1.2</version> </parent> <artifactId>nuiton-profiling</artifactId> Modified: trunk/nuiton-utils/pom.xml =================================================================== --- trunk/nuiton-utils/pom.xml 2011-04-26 09:27:29 UTC (rev 2115) +++ trunk/nuiton-utils/pom.xml 2011-04-26 17:03:03 UTC (rev 2116) @@ -33,7 +33,7 @@ <parent> <groupId>org.nuiton</groupId> <artifactId>nuiton-utils-parent</artifactId> - <version>2.2-SNAPSHOT</version> + <version>2.1.2</version> </parent> <artifactId>nuiton-utils</artifactId> Modified: trunk/nuiton-validator/pom.xml =================================================================== --- trunk/nuiton-validator/pom.xml 2011-04-26 09:27:29 UTC (rev 2115) +++ trunk/nuiton-validator/pom.xml 2011-04-26 17:03:03 UTC (rev 2116) @@ -33,7 +33,7 @@ <parent> <groupId>org.nuiton</groupId> <artifactId>nuiton-utils-parent</artifactId> - <version>2.2-SNAPSHOT</version> + <version>2.1.2</version> </parent> <artifactId>nuiton-validator</artifactId> Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2011-04-26 09:27:29 UTC (rev 2115) +++ trunk/pom.xml 2011-04-26 17:03:03 UTC (rev 2116) @@ -37,7 +37,7 @@ </parent> <artifactId>nuiton-utils-parent</artifactId> - <version>2.2-SNAPSHOT</version> + <version>2.1.2</version> <modules> <module>nuiton-utils</module> @@ -217,12 +217,12 @@  <scm> <connection> - scm:svn:http://svn.nuiton.org/svn/nuiton-utils/trunk + scm:svn:http://svn.nuiton.org/svn/nuiton-utils/tags/nuiton-utils-parent-2.1… </connection> <developerConnection> - scm:svn:http://svn.nuiton.org/svn/nuiton-utils/trunk + scm:svn:http://svn.nuiton.org/svn/nuiton-utils/tags/nuiton-utils-parent-2.1… </developerConnection> - <url>http://www.nuiton.org/repositories/browse/nuiton-utils/trunk</url> + <url>http://www.nuiton.org/repositories/browse/nuiton-utils/tags/nuiton-utils-pa…</url> </scm> </project>

1 0

r2115 - trunk/nuiton-utils/src/main/java/org/nuiton/util
by sletellier＠users.nuiton.org April 26, 2011

April 26, 2011

Author: sletellier Date: 2011-04-26 11:27:29 +0200 (Tue, 26 Apr 2011) New Revision: 2115 Url: http://nuiton.org/repositories/revision/nuiton-utils/2115 Log: Fix ApplicationConfig documentation Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/ApplicationConfig.java Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/ApplicationConfig.java =================================================================== --- trunk/nuiton-utils/src/main/java/org/nuiton/util/ApplicationConfig.java 2011-04-22 16:36:21 UTC (rev 2114) +++ trunk/nuiton-utils/src/main/java/org/nuiton/util/ApplicationConfig.java 2011-04-26 09:27:29 UTC (rev 2115) @@ -90,7 +90,7 @@ * * <h3>Bonnes pratiques</h3> * - * Vous devez créer une factory pour créer les ApplicationConfig qui contiendra par exemple une méthode : + * Vous devez créer une factory pour créer les instances d'{@link ApplicationConfig} qui contiendra par exemple une méthode : * * <pre> * @@ -717,7 +717,7 @@ * * @param alias the alias to add for the given method action * @param actionMethod must be fully qualified method path: - * package.Class.method + * package.Class#method */ public void addActionAlias(String alias, String actionMethod) { addAlias(alias, "--" + actionMethod); @@ -2031,11 +2031,15 @@ public interface ActionDef extends Serializable { /** + * Must return fully qualified method path : package.Class#method + * * @return action to run */ String getAction(); /** + * Return all alias used to execute action. + * * @return aliases used to execute action */ String[] getAliases();

1 0

r2114 - trunk/nuiton-utils/src/main/java/org/nuiton/util
by sletellier＠users.nuiton.org April 22, 2011

April 22, 2011

Author: sletellier Date: 2011-04-22 18:36:21 +0200 (Fri, 22 Apr 2011) New Revision: 2114 Url: http://nuiton.org/repositories/revision/nuiton-utils/2114 Log: Fix and update configuration with best practice and simple exemple Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/ApplicationConfig.java Modified: trunk/nuiton-utils/src/main/java/org/nuiton/util/ApplicationConfig.java =================================================================== --- trunk/nuiton-utils/src/main/java/org/nuiton/util/ApplicationConfig.java 2011-04-16 13:12:15 UTC (rev 2113) +++ trunk/nuiton-utils/src/main/java/org/nuiton/util/ApplicationConfig.java 2011-04-22 16:36:21 UTC (rev 2114) @@ -85,26 +85,45 @@ * il y a un bout des actions qui sont des chaines (nom de la methode). Il faudrait * faire un plugin maven qui check que l'action existe bien durant la compilation. * Il est simple de le faire a l'execution mais c trop tard :( + * <li>Ajouter de la documentation pour {@link #getOptionAsList(String)} * </ul> * - * <h3>Usage</h3> - * Create subclass of {@link ApplicationConfig}, where in constructor you call - * {@link #setConfigFileName(String)}, {@link #setDefaultOption(String, String)}, - * {@link #addAlias(String, String...)}, {@link #addActionAlias(String, String)}, - * to have properly value. - * <pre> - * conf = new MonAppConfig(); - * conf.parse(args); - * here you can used conf.getOption(key); - * conf.doAction(0); - * ... - * conf.doAction(n); + * <h3>Bonnes pratiques</h3> + * + * Vous devez créer une factory pour créer les ApplicationConfig qui contiendra par exemple une méthode : + * + * <pre> + * + * static public ApplicationConfig getConfig( + * Properties props, String configFilename, String ... args) { + * + * ApplicationConfig conf = new ApplicationConfig( + * MyAppConfigOption.class, MyAppConfigAction.class, + * props, configFilename); + * + * try { + * conf.parse(args); + * } catch (ArgumentsParserException eee) { + * if (log.isErrorEnabled()) { + * log.error("Can't load app configuration", eee); + * } + * } + * return conf; + * } + * * </pre> - * + * + * <ul> + * <li>MyAppConfigOption doit étendre {@link OptionDef} et décrir la configuration de l'application. + * <li>MyAppConfigAction doit étendre {@link ActionDef} et décrir la liste des options + * et de leur alias disponible pour l'application. + * </ul> + * * <h3>Lecture des fichiers de configuration</h3> * * La lecture des fichiers de configuration se fait durant l'appel de la methode - * {@link #parse} en utilisant la valeur de {@link #getConfigFileName} pour + * {@link #parse(String...)} en utilisant la valeur de qui doit être définit + * dans les options avec pour clef {@link ApplicationConfig#CONFIG_FILE_NAME} pour * trouver les fichiers (voir Les options de configuration pour l'ordre de * chargement des fichiers) * @@ -112,13 +131,13 @@ * La sauvegarde des options se fait via une des trois methodes disponibles : * <ul> * <li> {@link #save(File, boolean,String...)} sauve les données dans le fichier demandé - * <li> {@link #saveForSystem} sauvegarde les donnees dans /etc - * <li> {@link #saveForUser} sauvegarde les donnees dans $HOME + * <li> {@link #saveForSystem(String...)} sauvegarde les donnees dans /etc + * <li> {@link #saveForUser(String...)} sauvegarde les donnees dans $HOME * </ul> * - * Lors de l'utilisation de la methode {@link #saveForSystem} ou - * {@link #saveForUser} seules les options lues dans un fichier ou modifiées par - * programmation ({@link #setOption} seront sauvegardées. Par exemple les + * Lors de l'utilisation de la methode {@link #saveForSystem(String...)} ou + * {@link #saveForUser(String...)} seules les options lues dans un fichier ou modifiées par + * programmation ({@link #setOption(String, String)} seront sauvegardées. Par exemple les * options passees sur la ligne de commande ne seront pas sauvees. * * <h3>Les options de configuration</h3> @@ -185,7 +204,7 @@ * d'utiliser une methode avec des arguments variants * <p/> * Les actions ne sont pas execute mais seulement parsees. Pour les executer - * il faut utiliser la méthode {@link #doAction} qui prend en argument un numero + * il faut utiliser la méthode {@link #doAction(int)} qui prend en argument un numero * de 'step'. Par defaut toutes les actions sont de niveau 0 et sont executee * dans l'ordre d'apparition sur la ligne de commande. Si l'on souhaite * distinguer les actions il est possible d'utiliser l'annotation @@ -215,7 +234,7 @@ * On voit qu'aussi bien pour les actions que pour les options, le nom de la * methode doit etre utilise. Pour eviter ceci il est possible de definir * des alias ce qui permet de creer des options courtes par exemple. Pour cela, - * on utilise la methode {@link #addAlias}. + * on utilise la methode {@link #addAlias(String, String...)}. * <pre> * addAlias("-v", "--option", "verbose", "true"); * addAlias("-o", "--option", "outputfile"); @@ -404,7 +423,7 @@ * * @param configFilename name of config to use */ - public ApplicationConfig(String configFilename) throws ArgumentsParserException { + public ApplicationConfig(String configFilename) { this(null, null, null, configFilename); } @@ -428,7 +447,6 @@ * @param actionClass class that describe action, can be null * @param defaults properties that override default value of optionClass, can be null * @param configFilename override default config filename, can be null - * @param args command line argument can be empty */ public <O extends OptionDef, A extends ActionDef> ApplicationConfig( Class<O> optionClass, Class<A> actionClass, @@ -1278,7 +1296,7 @@ /** * Set manually options when you don't want to use parse method to check - * properties file configured by {@link #setConfigFileName}. + * properties file configured by {@link #setConfigFileName(String)}. * * @param options Properties which contains all options to set */ @@ -1494,6 +1512,7 @@ * Load configuration file and prepare Action. * * @param args argument as main(String[] args) + * @return ApplicationConfig instance * @throws ArgumentsParserException if parsing failed */ public ApplicationConfig parse(String... args) throws ArgumentsParserException { @@ -1838,6 +1857,85 @@ * Le contrat de marquage des options, on utilise cette interface pour * caracteriser une option de configuration. * + * <pre> + * public enum MyConfigOption implements OptionDef { + * + * APP_CONFIG_FILE( + * ApplicationConfig.CONFIG_FILE_NAME, + * "Main configuration app file", + * "myApp-config.properties", + * String.class, true, true), + * + * APP_NAME( + * ApplicationConfig.CONFIG_FILE_NAME, + * Application name, + * "MyApp", + * String.class, true, true); + * + * public String key; + * public String description; + * public String defaultValue; + * public Class<?> type; + * public boolean isTransient; + * public boolean isFinal; + * + * private WikittyConfigOption(String key, String description, + * String defaultValue, Class<?> type, boolean isTransient, boolean isFinal) { + * this.key = key; + * this.description = description; + * this.defaultValue = defaultValue; + * this.type = type; + * this.isTransient = isTransient; + * this.isFinal = isFinal; + * } + * + * @Override + * public boolean isFinal() { + * return isFinal; + * } + * + * @Override + * public boolean isTransient() { + * return isTransient; + * } + * + * @Override + * public String getDefaultValue() { + * return defaultValue; + * } + * + * @Override + * public String getDescription() { + * return description; + * } + * + * @Override + * public String getKey() { + * return key; + * } + * + * @Override + * public Class<?> getType() { + * return type; + * } + * + * @Override + * public void setDefaultValue(String defaultValue) { + * this.defaultValue = defaultValue; + * } + * + * @Override + * public void setTransient(boolean isTransient) { + * this.isTransient = isTransient; + * } + * + * @Override + * public void setFinal(boolean isFinal) { + * this.isFinal = isFinal; + * } + * } + * </pre> + * * @since 1.0.0-rc-9 */ public interface OptionDef extends Serializable { @@ -1901,6 +1999,32 @@ * Le contrat de marquage des action, on utilise cette interface pour * caracteriser une action. * + * Ex : + * + * <pre> + * public enum MyAppConfigAction implements ActionDef { + * HELP(MyAppHelpAction.class.getName() + "#show", "-h", "--help"); + * public String action; + * public String[] aliases; + * + * private WikittyConfigAction(String action, String... aliases) { + * this.action = action; + * this.aliases = aliases; + * } + * + * @Override + * public String getAction() { + * return action; + * } + * + * @Override + * public String[] getAliases() { + * return aliases; + * } + * + * } + * </pre> + * * @author sletellier * @since 1.5.2 */

1 0