com.intellij.openapi.ui.ValidationInfo.java Source code

Introduction

Here is the source code for com.intellij.openapi.ui.ValidationInfo.java

Source

/*
 * Copyright 2000-2012 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.openapi.ui;

import com.intellij.openapi.util.text.StringUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import javax.swing.*;

/**
 * Describes why the data entered in a DialogWrapper is invalid.
 *
 * @author Konstantin Bulenkov
 * @see DialogWrapper#doValidate()
 * @see <a href="https://jetbrains.design/intellij/principles/validation_errors/">Validation errors guidelines</a>
 */
public final class ValidationInfo {
    @NotNull
    public final String message;

    @Nullable
    public final JComponent component;

    public boolean okEnabled;
    public boolean warning;

    /**
     * Creates a validation error message associated with a specific component. The component will have an error icon drawn next to it,
     * and will be focused when the user tries to close the dialog by pressing OK.
     *
     * @param message   the error message to display.
     * @param component the component containing the invalid data.
     */
    public ValidationInfo(@NotNull String message, @Nullable JComponent component) {
        this.message = message;
        this.component = component;
    }

    /**
     * Creates a validation error message not associated with a specific component.
     *
     * @param message the error message to display.
     */
    public ValidationInfo(@NotNull String message) {
        this(message, null);
    }

    public ValidationInfo withOKEnabled() {
        okEnabled = true;
        return this;
    }

    public ValidationInfo asWarning() {
        warning = true;
        return this;
    }

    public ValidationInfo forComponent(@Nullable JComponent component) {
        ValidationInfo result = new ValidationInfo(message, component);
        result.warning = warning;
        result.okEnabled = okEnabled;
        return result;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o)
            return true;
        if (!(o instanceof ValidationInfo))
            return false;

        ValidationInfo that = (ValidationInfo) o;
        return StringUtil.equals(this.message, that.message) && this.component == that.component
                && this.okEnabled == that.okEnabled && this.warning == that.warning;
    }
}