validationcontext.java

### File Source: validationcontext.java

             /*
        P/P   *  Method: net.sourceforge.pebble.web.validation.ValidationContext__static_init
              */
         1  /*
         2   * Copyright (c) 2003-2006, Simon Brown
         3   * All rights reserved.
         4   *
         5   * Redistribution and use in source and binary forms, with or without
         6   * modification, are permitted provided that the following conditions are met:
         7   *
         8   *   - Redistributions of source code must retain the above copyright
         9   *     notice, this list of conditions and the following disclaimer.
        10   *
        11   *   - Redistributions in binary form must reproduce the above copyright
        12   *     notice, this list of conditions and the following disclaimer in
        13   *     the documentation and/or other materials provided with the
        14   *     distribution.
        15   *
        16   *   - Neither the name of Pebble nor the names of its contributors may
        17   *     be used to endorse or promote products derived from this software
        18   *     without specific prior written permission.
        19   *
        20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
        23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
        24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
        25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
        26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
        27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
        28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
        29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
        30   * POSSIBILITY OF SUCH DAMAGE.
        31   */
        32  package net.sourceforge.pebble.web.validation;
        33
        34  import java.util.ArrayList;
        35  import java.util.Collections;
        36  import java.util.List;
        37
        38  /**
        39   * A context within which to perform validation and raise errors against.
        40   *
        41   * @author    Simon Brown
        42   */
             /*
        P/P   *  Method: void net.sourceforge.pebble.web.validation.ValidationContext()
              *
              *  Postconditions:
              *    this.errors == &new ArrayList(ValidationContext#1)
              *    new ArrayList(ValidationContext#1) num objects == 1
              */
        43  public class ValidationContext {
        44
        45    /** the list of errors */
        46    private List errors = new ArrayList();
        47
        48    /**
        49     * Adds a new error to this context.
        50     *
        51     * @param message   the error message as a String
        52     */
        53    public void addError(String message) {
                 /*
        P/P       *  Method: void addError(String)
                  *
                  *  Preconditions:
                  *    this.errors != null
                  */
        54      addError(new ValidationError(message));
        55    }
        56
        57    /**
        58     * Adds a new error to this context.
        59     *
        60     * @param error   a ValidationError instance
        61     */
        62    public void addError(ValidationError error) {
                 /*
        P/P       *  Method: void addError(ValidationError)
                  *
                  *  Preconditions:
                  *    this.errors != null
                  */
        63      errors.add(error);
        64    }
        65
        66    /**
        67     * Determines whether this context has errors rasied against it.
        68     *
        69     * @return  true if this context has errors, false otherwise
        70     */
        71    public boolean hasErrors() {
                 /*
        P/P       *  Method: bool hasErrors()
                  *
                  *  Preconditions:
                  *    this.errors != null
                  *
                  *  Postconditions:
                  *    init'ed(return_value)
                  */
        72      return !errors.isEmpty();
        73    }
        74
        75    /**
        76     * Gets a list of all errors raised against this context.
        77     *
        78     * @return  a List of ValidationError instances
        79     */
        80    public List getErrors() {
                 /*
        P/P       *  Method: List getErrors()
                  *
                  *  Preconditions:
                  *    init'ed(this.errors)
                  *
                  *  Postconditions:
                  *    init'ed(return_value)
                  */
        81      return Collections.unmodifiableList(errors);
        82    }
        83
        84    /**
        85     * Gets the number of errors.
        86     *
        87     * @return  the number of errors as in int
        88     */
        89    public int getNumberOfErrors() {
                 /*
        P/P       *  Method: int getNumberOfErrors()
                  *
                  *  Preconditions:
                  *    this.errors != null
                  *
                  *  Postconditions:
                  *    init'ed(return_value)
                  */
        90      return errors.size();
        91    }
        92
        93    /**
        94     * Gets the specified ValidationError.
        95     *
        96     * @param index   the index of the error to get
        97     * @return  the ValidationError at the specified index
        98     */
        99    public ValidationError getError(int index) {
                 /*
        P/P       *  Method: ValidationError getError(int)
                  *
                  *  Preconditions:
                  *    this.errors != null
                  *
                  *  Postconditions:
                  *    init'ed(return_value)
                  */
       100      return (ValidationError)errors.get(index);
       101    }
       102
       103  }

SofCheck Inspector Build Version : 2.22510

validationcontext.java | 2010-Jun-25 19:40:32
validationcontext.class | 2010-Jul-19 20:23:38