GordianRequired.java

/*
 * GordianKnot: Security Suite
 * Copyright 2012-2026. Tony Washer
 *
 * 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 io.github.tonywasher.joceanus.gordianknot.api.base;

/**
 * Is an item required? Possible/Always/Never.
 */
public enum GordianRequired {
    /**
     * Never.
     */
    NEVER,

    /**
     * Possible.
     */
    POSSIBLE,

    /**
     * Always.
     */
    ALWAYS;

    /**
     * can the item exist?
     *
     * @return true/false
     */
    public boolean canExist() {
        return this != NEVER;
    }

    /**
     * can the item not exist?
     *
     * @return true/false
     */
    public boolean canNotExist() {
        return this != ALWAYS;
    }

    /**
     * must the item exist?
     *
     * @return true/false
     */
    public boolean mustExist() {
        return this == ALWAYS;
    }

    /**
     * must the item not exist?
     *
     * @return true/false
     */
    public boolean mustNotExist() {
        return this == NEVER;
    }
}