Author: tchemit Date: 2008-08-15 19:27:37 +0000 (Fri, 15 Aug 2008) New Revision: 1028 Modified: trunk/lutinutil/src/main/java/org/codelutin/util/ApplicationConfig.java Log: javadoc Modified: trunk/lutinutil/src/main/java/org/codelutin/util/ApplicationConfig.java =================================================================== --- trunk/lutinutil/src/main/java/org/codelutin/util/ApplicationConfig.java 2008-08-15 19:13:47 UTC (rev 1027) +++ trunk/lutinutil/src/main/java/org/codelutin/util/ApplicationConfig.java 2008-08-15 19:27:37 UTC (rev 1028) @@ -97,8 +97,8 @@ * <li> {@link #saveForUser} sauvegarde les donnees dans $HOME * </ul> * <p/> - * Lors de l'utilisation de la methode {@link saveForSystem} ou - * {@link saveForUser} seul les options lu dans un fichier ou modifier par + * Lors de l'utilisation de la methode {@link #saveForSystem()} ou + * {@link #saveForUser()} seul les options lu dans un fichier ou modifier par * programmation ({@link #setOption} seront sauvegardees. Par exemple les * options passees sur la ligne de commande ne seront pas sauvees. * <p/> @@ -361,8 +361,8 @@ * Used to put default configuration option in config option. Those options * are used as fallback value. * - * @param key - * @param value + * @param key default property key + * @param value default property value */ protected void setDefaultOption(String key, String value) { defaults.setProperty(key, value); @@ -371,10 +371,10 @@ /** * Save configuration, in specified file * - * @param logOnError if true not throw exception but log error - * @param file file where config will be writen - * @param forceAll if true save all config option - * (with defaults, classpath, env, command line) + * @param file file where config will be writen + * @param forceAll if true save all config option + * (with defaults, classpath, env, command line) + * @throws java.io.IOException if IO pb */ public void save(File file, boolean forceAll) throws IOException { Properties prop = new Properties(); @@ -477,9 +477,9 @@ /** * Add alias for action. This method put just -- front the actionMethod and - * call {@link addAlias} + * call {@link #addAlias(String, String[])} * - * @param alias + * @param alias the alias to add for the given method action * @param actionMethod must be fully qualified method path: package.Class.method */ public void addActionAlias(String alias, String actionMethod) { @@ -488,7 +488,7 @@ /** * Set name of file where options are read (in /etc, $HOME, $CURDIR) - * This set used {@link setDefaultOption} + * This set used {@link #setDefaultOption(String, String)} * * @param name file name */ @@ -505,8 +505,8 @@ /** * Set option value * - * @param key - * @param value + * @param key property key + * @param value property value */ public void setOption(String key, String value) { options.setProperty(key, value); @@ -515,7 +515,7 @@ /** * get option value as string * - * @param key + * @param key the option's key * @return String representation value */ public String getOption(String key) { @@ -527,7 +527,7 @@ * get option value as typed value * * @param clazz type of object wanted as return type - * @param key + * @param key the option's key * @return typed value */ public <T> T getOption(Class<T> clazz, String key) { @@ -554,7 +554,7 @@ /** * get option value as typed value * - * @param key + * @param key the option's key * @return typed value */ public File getOptionAsFile(String key) { @@ -566,7 +566,7 @@ /** * get option value as typed value * - * @param key + * @param key the option's key * @return typed value */ public URL getOptionAsURL(String key) { @@ -577,7 +577,7 @@ /** * get option value as typed value * - * @param key + * @param key the option's key * @return typed value */ public Class getOptionAsClass(String key) { @@ -588,7 +588,7 @@ /** * get option value as typed value * - * @param key + * @param key the option's key * @return typed value */ public Date getOptionAsDate(String key) { @@ -599,7 +599,7 @@ /** * get option value as typed value * - * @param key + * @param key the option's key * @return typed value */ public Time getOptionAsTime(String key) { @@ -610,7 +610,7 @@ /** * get option value as typed value * - * @param key + * @param key the option's key * @return typed value */ public Timestamp getOptionAsTimestamp(String key) { @@ -621,7 +621,7 @@ /** * get option value as typed value * - * @param key + * @param key the option's key * @return typed value */ public int getOptionAsInt(String key) { @@ -632,7 +632,7 @@ /** * get option value as typed value * - * @param key + * @param key the option's key * @return typed value */ public double getOptionAsDouble(String key) { @@ -643,7 +643,7 @@ /** * get option value as typed value * - * @param key + * @param key the option's key * @return typed value */ public boolean getOptionAsBoolean(String key) { @@ -677,7 +677,7 @@ * * @param m the method to call * @param args iterator with many argument (equals or more than necessary - * @throws java.lang.Exception if call failed + * @return the arguments found for the given method */ protected String[] getParams(Method m, ListIterator<String> args) { List<String> result = new ArrayList<String>(); @@ -708,8 +708,8 @@ * Create action from string, string must be [package.][class][#][method] * if package, class or method missing, default is used * - * @param name - * @param params + * @param name name of the action + * @param args * @return */ protected Action createAction(String name, ListIterator<String> args) throws ArgumentsParserException, InstantiationException, IllegalAccessException, IllegalArgumentException, InvocationTargetException {