Author: tchemit Date: 2011-01-27 09:10:53 +0100 (Thu, 27 Jan 2011) New Revision: 2068 Url: http://nuiton.org/repositories/revision/nuiton-utils/2068 Log: improve nuiton-validator javadoc : Evolution #1184: Do a better documentation Added: trunk/nuiton-validator/src/main/java/org/nuiton/validator/xwork2/field/package-info.java Modified: trunk/nuiton-validator/src/main/java/org/nuiton/validator/bean/BeanValidatorFactory.java trunk/nuiton-validator/src/main/java/org/nuiton/validator/bean/BeanValidatorUtil.java trunk/nuiton-validator/src/main/java/org/nuiton/validator/bean/package-info.java trunk/nuiton-validator/src/main/java/org/nuiton/validator/package-info.java trunk/nuiton-validator/src/main/java/org/nuiton/validator/xwork2/package-info.java trunk/nuiton-validator/src/site/apt/index.apt Modified: trunk/nuiton-validator/src/main/java/org/nuiton/validator/bean/BeanValidatorFactory.java =================================================================== --- trunk/nuiton-validator/src/main/java/org/nuiton/validator/bean/BeanValidatorFactory.java 2011-01-26 18:55:45 UTC (rev 2067) +++ trunk/nuiton-validator/src/main/java/org/nuiton/validator/bean/BeanValidatorFactory.java 2011-01-27 08:10:53 UTC (rev 2068) @@ -167,7 +167,14 @@ /** * Contract to create a {@link BeanValidator}. + * <p/> + * A such object is registred in the {@link BeanValidatorFactory} to create + * new instances of a {@link BeanValidator}. * + * @see BeanValidatorFactory + * @see BeanValidatorFactory#getCreator() + * @see BeanValidatorFactory#setCreator(BeanValidatorCreator) + * @see BeanValidatorFactory#isDefaultCreator() * @since 2.0 */ public interface BeanValidatorCreator { @@ -194,6 +201,9 @@ /** * Default implementation of {@link BeanValidatorCreator} which just * instanciate a {@link BeanValidator} from the given parameters. + * <p/> + * If no bean validator creator is given to the {@link BeanValidatorFactory} + * it will instanciate a such creator and use it unless you change it. * * @author tchemit <chemit@codelutin.com> * @since 2.0 Modified: trunk/nuiton-validator/src/main/java/org/nuiton/validator/bean/BeanValidatorUtil.java =================================================================== --- trunk/nuiton-validator/src/main/java/org/nuiton/validator/bean/BeanValidatorUtil.java 2011-01-26 18:55:45 UTC (rev 2067) +++ trunk/nuiton-validator/src/main/java/org/nuiton/validator/bean/BeanValidatorUtil.java 2011-01-27 08:10:53 UTC (rev 2068) @@ -36,7 +36,7 @@ import java.util.List; /** - * The helper class for validation module. + * The helper class for bean validation module. * * @author tchemit <chemit@codelutin.com> * @since 2.0 Modified: trunk/nuiton-validator/src/main/java/org/nuiton/validator/bean/package-info.java =================================================================== --- trunk/nuiton-validator/src/main/java/org/nuiton/validator/bean/package-info.java 2011-01-26 18:55:45 UTC (rev 2067) +++ trunk/nuiton-validator/src/main/java/org/nuiton/validator/bean/package-info.java 2011-01-27 08:10:53 UTC (rev 2068) @@ -22,14 +22,13 @@ * <http://www.gnu.org/licenses/lgpl-3.0.html>. * #L% */ -package org.nuiton.validator.bean; /** * Package of Nuiton- beanValidator api. * * <h1>The <b>BeanValidator</b> api</h1> * <p> - * The {@link BeanValidator} purpose is to validate a bean, with a listener api - * to interact with outside world. + * The {@link org.nuiton.validator.bean.BeanValidator} purpose is to validate + * a bean, with a listener api to interact with outside world. * </p> * It is mainly used in GUI parts of an application (Jaxx-validator use it). * <br/> @@ -46,28 +45,26 @@ * * <h2>Obtain a validator</h2> * To obtain a bean validator use the factory of validators - * ({@link BeanValidatorFactory}. + * {@link org.nuiton.validator.bean.BeanValidatorFactory}. * <br/> * <pre> * BeanValidator<O> validator = BeanValidatorFactory.newBeanValidator(O.class); * </pre> * - * <h2>Using the {@link BeanValidatorCreator}</h2> + * <h2>Using the {@link org.nuiton.validator.bean.BeanValidatorFactory.BeanValidatorCreator}</h2> * - * It is possible to use a {@link BeanValidatorCreator} to change the - * implementation of {@link BeanValidator} instanticated by the factory. + * It is possible to use a {@link org.nuiton.validator.bean.BeanValidatorFactory.BeanValidatorCreator} to change the + * implementation of {@link org.nuiton.validator.bean.BeanValidator} + * instanticated by the factory. * * For this just use the method - * {@link BeanValidatorFactory#setCreator(BeanValidatorCreator)}. + * {@link org.nuiton.validator.bean.BeanValidatorFactory#setCreator(BeanValidatorCreator)}. * * By default it will us a default creator - * ({@link BeanValidatorFactory.DefaultBeanValidatorCreator}). + * ({@link org.nuiton.validator.bean.BeanValidatorFactory.DefaultBeanValidatorCreator}). * * <strong>To be continued...</strong> * * @since 2.0 */ - -import org.nuiton.validator.bean.BeanValidatorFactory; -import org.nuiton.validator.bean.BeanValidatorFactory.BeanValidatorCreator; -import org.nuiton.validator.bean.BeanValidator; +package org.nuiton.validator.bean; \ No newline at end of file Modified: trunk/nuiton-validator/src/main/java/org/nuiton/validator/package-info.java =================================================================== --- trunk/nuiton-validator/src/main/java/org/nuiton/validator/package-info.java 2011-01-26 18:55:45 UTC (rev 2067) +++ trunk/nuiton-validator/src/main/java/org/nuiton/validator/package-info.java 2011-01-27 08:10:53 UTC (rev 2068) @@ -27,9 +27,10 @@ * * <h1>The <b>Validator</b> api</h1> * <p> - * The {@link NuitonValidator} is the object responsible to launch validation - * for a given object and then return the result of validation in a - * {@link NuitonValidatorResult} via the method {@code validate}. + * The {@link org.nuiton.validator.NuitonValidator} is the object responsible + * to launch validation for a given object and then return the result of + * validation in a {@link org.nuiton.validator.NuitonValidatorResult} via the + * method {@link org.nuiton.validator.NuitonValidator#validate(Object)}. * </p> * * <pre> @@ -38,7 +39,7 @@ * </pre> * * <h2>Obtain a validator</h2> - * To obtain a validator use the factory of validators ({@link NuitonValidatorFactory}. + * To obtain a validator use the factory of validators : {@link org.nuiton.validator.NuitonValidatorFactory}. * <br/> * <pre> * NuitonValidator<O> validator = NuitonValidatorFactory.newValidator(O.class); @@ -53,8 +54,3 @@ * @since 2.0 */ package org.nuiton.validator; - - -import org.nuiton.validator.NuitonValidator; -import org.nuiton.validator.NuitonValidatorFactory; -import org.nuiton.validator.NuitonValidatorResult; \ No newline at end of file Added: trunk/nuiton-validator/src/main/java/org/nuiton/validator/xwork2/field/package-info.java =================================================================== --- trunk/nuiton-validator/src/main/java/org/nuiton/validator/xwork2/field/package-info.java (rev 0) +++ trunk/nuiton-validator/src/main/java/org/nuiton/validator/xwork2/field/package-info.java 2011-01-27 08:10:53 UTC (rev 2068) @@ -0,0 +1,32 @@ +/* + * #%L + * Nuiton Utils :: Nuiton Validator + * + * $Id$ + * $HeadURL$ + * %% + * Copyright (C) 2011 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% + */ +/** + * Package of extra xworks2 field validators. + * + * <strong>To be continued...</strong> + * + * @since 2.0 + */ +package org.nuiton.validator.xwork2.field; Property changes on: trunk/nuiton-validator/src/main/java/org/nuiton/validator/xwork2/field/package-info.java ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL Added: svn:eol-style + native Modified: trunk/nuiton-validator/src/main/java/org/nuiton/validator/xwork2/package-info.java =================================================================== --- trunk/nuiton-validator/src/main/java/org/nuiton/validator/xwork2/package-info.java 2011-01-26 18:55:45 UTC (rev 2067) +++ trunk/nuiton-validator/src/main/java/org/nuiton/validator/xwork2/package-info.java 2011-01-27 08:10:53 UTC (rev 2068) @@ -30,7 +30,3 @@ * @since 2.0 */ package org.nuiton.validator.xwork2; - -import org.nuiton.validator.NuitonValidator; -import org.nuiton.validator.NuitonValidatorFactory; -import org.nuiton.validator.NuitonValidatorResult; \ No newline at end of file Modified: trunk/nuiton-validator/src/site/apt/index.apt =================================================================== --- trunk/nuiton-validator/src/site/apt/index.apt 2011-01-26 18:55:45 UTC (rev 2067) +++ trunk/nuiton-validator/src/site/apt/index.apt 2011-01-27 08:10:53 UTC (rev 2068) @@ -1,18 +1,11 @@ - ---- - Nuiton utils - ---- - ---- - 2009-08-23 - ---- - ~~~ ~~ #%L -~~ Nuiton Utils +~~ Nuiton Utils :: Nuiton Validator ~~ ~~ $Id$ ~~ $HeadURL$ ~~ %% -~~ Copyright (C) 2004 - 2010 CodeLutin +~~ Copyright (C) 2011 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 @@ -29,39 +22,56 @@ ~~ <http://www.gnu.org/licenses/lgpl-3.0.html>. ~~ #L% ~~~ + ---- + Nuiton Validator + ---- + ---- + 2011-01-27 + ---- + Présentation - Ensemble de classe Java permettant de simplifier le développement en - factorisant des besoins que l'on retrouve dans tous les développements. - On y trouve des fonctions de travail sur les chaînes de caractères, des - fonctions de parsage des arguements de la ligne de commande, des fonctions - permettant très simplement de rechercher une resource (images, fichier de - propriétés, ...), ... + La librairie <Nuiton-validator> propose une api neutre de validation intégrant + la notion de niveau de validation. -Librairie Util +Implantation (xwork2) - Librairie regroupant les utilitaires classiques sur les fichiers, les tableaux, - 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. + Actuellement la seule implantation disponible se base sur XWork2. -Librairie LutinLog +* Configuration - N'existe plus depuis la version <<1.1>>. - -Librairie i18n + La configuration des validateurs se font via des fichier xml. - Depuis la version <<1.1>>, cette librairie est déplacé dans le projet - {{{http://maven-site.nuiton.org/i18n/nuiton-i18n}nuiton-i18n}}. +* Ajout d'un validateur - Librairie permettant de rendre les programmes Java multilangue de façon - simple. Il utilise la même philosophie que gettext. C'est à dire que chaque - chaîne de caractères devant être traduite sont tagge avec I18n._("..."). - Ensuite il suffit d'extraire ces cha?nes pour les mettres dans un fichier de - propriété, et d'indiquer quel fichier de propré?té charger au démarrage de - l'application selon la langue souhaitée. + Pour enregister un nouveau validateur sur un bean, il suffit de placer dans + le même paquetage que le bean un fichier <XXX[-context]-scope-validation.xml> où + XXX est le nom non qualifié du bean. + Le context optionel permet de définir plusieurs contexts de validation. + Le scope parmi les suivants : fatal, error, warning, info donne le niveau de + validation. + +* Ajout d'un nouveau type de validateur + + Il est aussi possible de définir de nouveau type de validateurs : + + * créer une classe qui étend FieldValidator + + * ajouter un fichier <validators.xml> (ou ajouter dans un tel fichier la + définition du nouveau validator) à la racine du class-path. + +* I18n + + Afin de rendre le mécanisme multi-langue, on propose dans les fichiers de + validations d'utiliser des clef i18n pour les messages. + + Un nouveau parseur dans notre plugin i18n a été ajouté pour détecter ces + clefs. (<i18n:parserValidation>) + + <Veuillez consulter la JavaDoc pour de plus ample détails sur les différentes librairies.>