javax.mvc.validation.ValidationResult Maven / Gradle / Ivy

Go to download
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * http://glassfish.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package javax.mvc.validation;

import javax.validation.ConstraintViolation;
import java.util.Set;

/**
 * Describes the validation result of all resource fields and resource
 * method parameters which are annotated with {@link javax.validation.Valid}.
 *
 * Controller methods which declare a parameter of this type will be executed
 * even if the validation for fields and method parameters fails.
 *
 * @author Christian Kaltepoth
 * @since 1.0
 */
public interface ValidationResult extends Iterable> {

    /**
     * Returns true if there is at least one constraint violation.
     * Same as checking whether {@link #getViolationCount()} is greater than zero.
     *
     * @return true if there is at least one constraint violation.
     */
    boolean isFailed();

    /**
     * Returns the total number of constraint violations detected. Same as calling
     * getAllViolations().size().
     *
     * @return The number of constraint violations
     */
    int getViolationCount();

    /**
     * Returns an immutable set of all constraint violations detected.
     *
     * @return All constraint violations detected
     */
    Set> getAllViolations();

    /**
     * Returns an immutable set of all constraint violations detected
     * for a property specified by the given property path.
     *
     * @param propertyPath The property path (e.g. person.age)
     * @return All constraint violations detected
     * @see #getViolation(String)
     */
    Set> getViolations(String propertyPath);

    /**
     * Returns a single constraint violation detected for a property
     * specified by the given property path. Will return the first violation if there
     * are more than one detected and null if no violation was detected.
     *
     * @param propertyPath The property path (e.g. person.age)
     * @return The first constraint violation or null if there are no violations.
     */
    ConstraintViolation getViolation(String propertyPath);
}