validator/src/com/android/tools/idea/validator/ValidatorData.java

/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * 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.android.tools.idea.validator;

import com.android.tools.layoutlib.annotations.NotNull;
import com.android.tools.layoutlib.annotations.Nullable;

import java.util.EnumSet;

/**
 * Data used for layout validation.
 */
public class ValidatorData {

    /**
     * Category of validation
     */
    public enum Type {
        ACCESSIBILITY,
        RENDER,
    }

    /**
     * Level of importance
     */
    public enum Level {
        ERROR,
        WARNING,
        INFO,
        /** The test not ran or suppressed. */
        VERBOSE,
    }

    /**
     * Determine what types and levels of validation to run.
     */
    public static class Policy {
        @NotNull final EnumSet<Type> mTypes;
        @NotNull final EnumSet<Level> mLevels;

        public Policy(@NotNull EnumSet<Type> types, @NotNull EnumSet<Level> levels) {
            mTypes = types;
            mLevels = levels;
        }
    }

    /**
     * Suggested fix to the user or to the studio.
     */
    public static class Fix {
        @NotNull public final String mFix;

        public Fix(String fix) {
            mFix = fix;
        }
    }

    /**
     * Issue describing the layout problem.
     */
    public static class Issue{
        @NotNull public final Type mType;
        @NotNull public final String mMsg;
        @NotNull public final Level mLevel;
        @Nullable public final Long mSrcId;
        @Nullable public final Fix mFix;
        // Used for debugging.
        @Nullable public String mSourceClass;

        public Issue(
                @NotNull Type type,
                @NotNull String msg,
                @NotNull Level level,
                @Nullable Long srcId,
                @Nullable Fix fix) {
            mType = type;
            mMsg = msg;
            mLevel = level;
            mSrcId = srcId;
            mFix = fix;
        }
    }
}