Author: tchemit Date: 2011-01-17 19:49:58 +0100 (Mon, 17 Jan 2011) New Revision: 2016 Url: http://nuiton.org/repositories/revision/nuiton-utils/2016 Log: begin of documentation for the new validator api Added: 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 Added: trunk/nuiton-validator/src/main/java/org/nuiton/validator/package-info.java =================================================================== --- trunk/nuiton-validator/src/main/java/org/nuiton/validator/package-info.java (rev 0) +++ trunk/nuiton-validator/src/main/java/org/nuiton/validator/package-info.java 2011-01-17 18:49:58 UTC (rev 2016) @@ -0,0 +1,60 @@ +/* + * #%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 Nuiton-validator api. + * + * <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}. + * </p> + * + * <pre> + * NuitonValidator<O> validator = XXX; + * NuitonValidatorResult result = validator.validate(o); + * </pre> + * + * <h2>Obtain a validator</h2> + * To obtain a validator use the factory of validators ({@link NuitonValidatorFactory}. + * <br/> + * <pre> + * NuitonValidator<O> validator = NuitonValidatorFactory.newValidator(O.class); + * </pre> + * + * <h2>Implements the validator api</h2> + * + * At the moment, there is an offered implementation based on xwork2 framework. + * + * <strong>To be continued...</strong> + * + * @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 Property changes on: trunk/nuiton-validator/src/main/java/org/nuiton/validator/package-info.java ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL Added: svn:eol-style + native Added: 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 (rev 0) +++ trunk/nuiton-validator/src/main/java/org/nuiton/validator/xwork2/package-info.java 2011-01-17 18:49:58 UTC (rev 2016) @@ -0,0 +1,36 @@ +/* + * #%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 xworks2 implementation of the Nuiton-validator api. + * + * <strong>To be continued...</strong> + * + * @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 Property changes on: trunk/nuiton-validator/src/main/java/org/nuiton/validator/xwork2/package-info.java ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL Added: svn:eol-style + native