/*
 * 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.description.modifier;

import org.objectweb.asm.Opcodes;

Describes if a method parameter is mandated, i.e. not explicitly specified in the source code.
/**
 * Describes if a method parameter is mandated, i.e. not explicitly specified in the source code.
 */
public enum ProvisioningState implements ModifierContributor.ForParameter {

    
Defines a parameter to not be mandated. (This is the default modifier.)
/**
     * Defines a parameter to not be mandated. (This is the default modifier.)
     */
    PLAIN(EMPTY_MASK),

    
Defines a parameter to be mandated.
/**
     * Defines a parameter to be mandated.
     */
    MANDATED(Opcodes.ACC_MANDATED);

    
The mask of this provisioning state.
/**
     * The mask of this provisioning state.
     */
    private final int mask;

    
Creates a new provisioning state.
Params:
mask – The mask of this provisioning state./**
     * Creates a new provisioning state.
     *
     * @param mask The mask of this provisioning state.
     */
    ProvisioningState(int mask) {
        this.mask = mask;
    }

    
{@inheritDoc}
/**
     * {@inheritDoc}
     */
    public int getMask() {
        return mask;
    }

    
{@inheritDoc}
/**
     * {@inheritDoc}
     */
    public int getRange() {
        return Opcodes.ACC_MANDATED;
    }

    
{@inheritDoc}
/**
     * {@inheritDoc}
     */
    public boolean isDefault() {
        return this == PLAIN;
    }

    
Checks if this instance represents a mandated parameter or not.
Returns:
true if this instance represents a mandated parameter./**
     * Checks if this instance represents a mandated parameter or not.
     *
     * @return {@code true} if this instance represents a mandated parameter.
     */
    public boolean isMandated() {
        return this == MANDATED;
    }
}