/* 
    P/P   *  Method: com.dmdirc.config.prefs.validator.ValidationResponse__static_init
          */
     1  /*
     2   * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
     3   *
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   *
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   *
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  package com.dmdirc.config.prefs.validator;
    23  
    24  /**
    25   * Describes the response from a Validator. The response may be either positive
    26   * or negative. Negative responses have an associated failure reason.
    27   * 
    28   * @author chris
    29   */
    30  public class ValidationResponse {
    31     
    32      /** The failure reason, or null if the validation passed. */
    33      private final String failure;
    34      
    35      /**
    36       * Creates a new ValidationResponse for a positive response.
    37       */
             /* 
    P/P       *  Method: void com.dmdirc.config.prefs.validator.ValidationResponse()
              * 
              *  Postconditions:
              *    this.failure == null
              */
    38      public ValidationResponse() {
    39          this.failure = null;
    40      }
    41      
    42      /**
    43       * Creates a new ValidationResponse for a negative response.
    44       * 
    45       * @param failure The reason for the negative response.
    46       */
             /* 
    P/P       *  Method: void com.dmdirc.config.prefs.validator.ValidationResponse(String)
              * 
              *  Postconditions:
              *    this.failure == failure
              *    init'ed(this.failure)
              */
    47      public ValidationResponse(final String failure) {
    48          this.failure = failure;
    49      }
    50      
    51      /**
    52       * Determines whether or not this response indicates that a failure occured.
    53       * 
    54       * @return True if a failure occured, false otherwise.
    55       */
    56      public boolean isFailure() {
                 /* 
    P/P           *  Method: bool isFailure()
                  * 
                  *  Postconditions:
                  *    init'ed(return_value)
                  */
    57          return failure != null;
    58      }
    59      
    60      /**
    61       * Retrieves the reason for the validation failure.
    62       * 
    63       * @return The reason for the validation failure.
    64       */
    65      public String getFailureReason() {
                 /* 
    P/P           *  Method: String getFailureReason()
                  * 
                  *  Postconditions:
                  *    return_value == this.failure
                  *    init'ed(return_value)
                  */
    66          return failure;
    67      }
    68  
    69  }