com.hp.autonomy.frontend.configuration.validation.ValidationResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of configuration-impl Show documentation

There is a newer version: 3.5.0

/*
 * Copyright 2013-2015 Open Text.
 *
 * Licensed under the MIT License (the "License"); you may not use this file
 * except in compliance with the License.
 *
 * The only warranties for products and services of Open Text and its affiliates
 * and licensors ("Open Text") are as may be set forth in the express warranty
 * statements accompanying such products and services. Nothing herein should be
 * construed as constituting an additional warranty. Open Text shall not be
 * liable for technical or editorial errors or omissions contained herein. The
 * information contained herein is subject to change without notice.
 */

package com.hp.autonomy.frontend.configuration.validation;

/**
 * Associates a boolean with an object of arbitrary type which may provide additional information in
 * cases of validation failure or as side effects to the validation process.
 *
 * @param  The type of the additional data.  This should be {@link Void} if no data is to be returned.
 */
public class ValidationResult {

    private final T data;
    private final boolean isValid;

    public ValidationResult(final boolean valid) {
        this(valid, null);
    }

    public ValidationResult(final boolean valid, final T data) {
        this.data = data;
        isValid = valid;
    }

    /**
     * Returns the data associated with the validation.  The presence of data does not imply anything about
     * the success or failure of the validation.
     *
     * @return The data associated with the validation.
     */
    public T getData() {
        return data;
    }

    public boolean isValid() {
        return isValid;
    }
}