/*
 * Copyright 2014 - 2020 Rafael Winterhalter
 *
 * 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 net.bytebuddy.dynamic.scaffold;

 If type validation is enabled, Byte Buddy performs several checks to ensure that a generated class file is specified in a valid manner. This involves checks of the generated instrumented type and checks of the generated byte code. Byte Buddy's Implementation instances perform their own checks, independently of any type validation. 

The JVM's verifier performs its own checks; an illegal class file is never loaded. However, Byte Buddy's
checks might be more expressive in the context of using the library. Also, Byte Buddy emits exceptions
at class creation time while the JVM emits errors at class loading time.

/**
 * <p>
 * If type validation is enabled, Byte Buddy performs several checks to ensure that a generated
 * class file is specified in a valid manner. This involves checks of the generated instrumented
 * type and checks of the generated byte code. Byte Buddy's {@link net.bytebuddy.implementation.Implementation}
 * instances perform their own checks, independently of any type validation.
 * </p>
 * <p>
 * The JVM's verifier performs its own checks; an illegal class file is never loaded. However, Byte Buddy's
 * checks might be more expressive in the context of using the library. Also, Byte Buddy emits exceptions
 * at class creation time while the JVM emits errors at class loading time.
 * </p>
 */
public enum TypeValidation {

    
Enables Byte Buddy's validation.
/**
     * Enables Byte Buddy's validation.
     */
    ENABLED(true),

    
Disables Byte Buddy's validation.
/**
     * Disables Byte Buddy's validation.
     */
    DISABLED(false);

    
true if type validation is enabled. /**
     * {@code true} if type validation is enabled.
     */
    private final boolean enabled;

    
Creates a new type validation enumeration.
Params:
enabled – true if type validation is enabled./**
     * Creates a new type validation enumeration.
     *
     * @param enabled {@code true} if type validation is enabled.
     */
    TypeValidation(boolean enabled) {
        this.enabled = enabled;
    }

    
Returns ENABLED if the supplied argument is true. 
Params:
enabled – true if type validation should be enabled.
Returns:
A suitable type validation representation./**
     * Returns {@link TypeValidation#ENABLED} if the supplied argument is {@code true}.
     *
     * @param enabled {@code true} if type validation should be enabled.
     * @return A suitable type validation representation.
     */
    public static TypeValidation of(boolean enabled) {
        return enabled
                ? ENABLED
                : DISABLED;
    }

    
Returns true if type validation is enabled. 
Returns:
true if type validation is enabled./**
     * Returns {@code true} if type validation is enabled.
     *
     * @return {@code true} if type validation is enabled.
     */
    public boolean isEnabled() {
        return enabled;
    }
}