/*
 * Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package jdk.javadoc.internal.tool;

import java.util.Set;
import javax.lang.model.element.Modifier;

/**
 * The access levels.
 *
 * These constants are ordered by their access limiting power. The bigger the
 * {@link #ordinal() ordinal} of a constant, the more limiting power that
 * constant has.
 *
 * That has a few useful implications. For example, the levels can be compared
 * by {@link #compareTo}. It also means that {@code AccessLevel.values()[0]} and
 * {@code AccessLevel.values()[values.length() - 1] and the constants with the
 * smallest and the biggest limiting powers respectively.
 */
public enum AccessLevel implements Comparable<AccessLevel> {

    /** Does not limit access */
    PRIVATE,
    /** Limits access to entities that are public, protected, or declared with package access */
    PACKAGE,
    /** Limits access to public and protected entities */
    PROTECTED,
    /** Limits access to public entities */
    PUBLIC;

    public static AccessLevel of(Set<Modifier> mods) {
        if (mods.contains(Modifier.PUBLIC))
            return AccessLevel.PUBLIC;
        else if (mods.contains(Modifier.PROTECTED))
            return AccessLevel.PROTECTED;
        else if (mods.contains(Modifier.PRIVATE))
            return AccessLevel.PRIVATE;
        else
            return AccessLevel.PACKAGE;
    }
}
