//# 0 errors, 35 messages
//#
/*
    //#ValidationResponse.java:1:1: class: com.dmdirc.config.prefs.validator.ValidationResponse
    //#ValidationResponse.java:1:1: method: com.dmdirc.config.prefs.validator.ValidationResponse.com.dmdirc.config.prefs.validator.ValidationResponse__static_init
 * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.dmdirc.config.prefs.validator;

/**
 * Describes the response from a Validator. The response may be either positive
 * or negative. Negative responses have an associated failure reason.
 * 
 * @author chris
 */
public class ValidationResponse {
   
    /** The failure reason, or null if the validation passed. */
    private final String failure;
    
    /**
     * Creates a new ValidationResponse for a positive response.
     */
    public ValidationResponse() {
    //#ValidationResponse.java:38: method: void com.dmdirc.config.prefs.validator.ValidationResponse.com.dmdirc.config.prefs.validator.ValidationResponse()
    //#input(void com.dmdirc.config.prefs.validator.ValidationResponse()): this
    //#output(void com.dmdirc.config.prefs.validator.ValidationResponse()): this.failure
    //#post(void com.dmdirc.config.prefs.validator.ValidationResponse()): this.failure == null
        this.failure = null;
    }
    //#ValidationResponse.java:40: end of method: void com.dmdirc.config.prefs.validator.ValidationResponse.com.dmdirc.config.prefs.validator.ValidationResponse()
    
    /**
     * Creates a new ValidationResponse for a negative response.
     * 
     * @param failure The reason for the negative response.
     */
    public ValidationResponse(final String failure) {
    //#ValidationResponse.java:47: method: void com.dmdirc.config.prefs.validator.ValidationResponse.com.dmdirc.config.prefs.validator.ValidationResponse(String)
    //#input(void com.dmdirc.config.prefs.validator.ValidationResponse(String)): failure
    //#input(void com.dmdirc.config.prefs.validator.ValidationResponse(String)): this
    //#output(void com.dmdirc.config.prefs.validator.ValidationResponse(String)): this.failure
    //#post(void com.dmdirc.config.prefs.validator.ValidationResponse(String)): this.failure == failure
    //#post(void com.dmdirc.config.prefs.validator.ValidationResponse(String)): init'ed(this.failure)
        this.failure = failure;
    }
    //#ValidationResponse.java:49: end of method: void com.dmdirc.config.prefs.validator.ValidationResponse.com.dmdirc.config.prefs.validator.ValidationResponse(String)
    
    /**
     * Determines whether or not this response indicates that a failure occured.
     * 
     * @return True if a failure occured, false otherwise.
     */
    public boolean isFailure() {
        return failure != null;
    //#ValidationResponse.java:57: method: bool com.dmdirc.config.prefs.validator.ValidationResponse.isFailure()
    //#input(bool isFailure()): this
    //#input(bool isFailure()): this.failure
    //#output(bool isFailure()): return_value
    //#post(bool isFailure()): init'ed(return_value)
    //#ValidationResponse.java:57: end of method: bool com.dmdirc.config.prefs.validator.ValidationResponse.isFailure()
    }
    
    /**
     * Retrieves the reason for the validation failure.
     * 
     * @return The reason for the validation failure.
     */
    public String getFailureReason() {
        return failure;
    //#ValidationResponse.java:66: method: String com.dmdirc.config.prefs.validator.ValidationResponse.getFailureReason()
    //#input(String getFailureReason()): this
    //#input(String getFailureReason()): this.failure
    //#output(String getFailureReason()): return_value
    //#post(String getFailureReason()): return_value == this.failure
    //#post(String getFailureReason()): init'ed(return_value)
    //#ValidationResponse.java:66: end of method: String com.dmdirc.config.prefs.validator.ValidationResponse.getFailureReason()
    }

}
    //#output(com.dmdirc.config.prefs.validator.ValidationResponse__static_init): __Descendant_Table[com/dmdirc/config/prefs/validator/ValidationResponse]
    //#output(com.dmdirc.config.prefs.validator.ValidationResponse__static_init): __Dispatch_Table.getFailureReason()Ljava/lang/String;
    //#output(com.dmdirc.config.prefs.validator.ValidationResponse__static_init): __Dispatch_Table.isFailure()Z
    //#post(com.dmdirc.config.prefs.validator.ValidationResponse__static_init): __Descendant_Table[com/dmdirc/config/prefs/validator/ValidationResponse] == &__Dispatch_Table
    //#post(com.dmdirc.config.prefs.validator.ValidationResponse__static_init): __Dispatch_Table.getFailureReason()Ljava/lang/String; == &getFailureReason
    //#post(com.dmdirc.config.prefs.validator.ValidationResponse__static_init): __Dispatch_Table.isFailure()Z == &isFailure
    //#ValidationResponse.java:: end of method: com.dmdirc.config.prefs.validator.ValidationResponse.com.dmdirc.config.prefs.validator.ValidationResponse__static_init
    //#ValidationResponse.java:: end of class: com.dmdirc.config.prefs.validator.ValidationResponse
