org.nuiton.validator.bean.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of validation-api Show documentation

Validation API module

The newest version!

/*
 * #%L
 * Validation :: API
 * %%
 * Copyright (C) 2021 - 2024 Ultreia.io
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */
/**
 * Package of Nuiton - Simple Bean Validator api.
 *
 * The BeanValidator api
 * 
 * The {@link org.nuiton.validator.bean.BeanValidator} purpose is to validate
 * a bean, with a listener api to interact with outside world.
 * 
 * It is mainly used in GUI parts of an application (Jaxx-validator use it).
 * 
 * The idea is to attach the bean to validate inside the validator, then the
 * validator listen any modification of the bean to revalidate it and fires
 * events when messages has changed on a field.
 * 
 * BeanValidatorListener listener = new BeanValidatorListener() {XXX};
 * BeanValidator<O> validator = XXX;
 * validator.addSimpleBeanValidatorListener(listener);
 * validator.setBean(o);
 * 
 * Obtain a validator
 * To obtain a bean validator use the factory method of the
 * {@link org.nuiton.validator.bean.BeanValidator}.
 *  * BeanValidator<O> validator = BeanValidator.newValidator(...);
 * 
 *
 * @since 2.0
 */
package org.nuiton.validator.bean;