TypePathKind.java

/*
 *  Copyright (c) 2001-2024, Jean Tessier
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *      * Redistributions of source code must retain the above copyright
 *        notice, this list of conditions and the following disclaimer.
 *
 *      * Redistributions in binary form must reproduce the above copyright
 *        notice, this list of conditions and the following disclaimer in the
 *        documentation and/or other materials provided with the distribution.
 *
 *      * Neither the name of Jean Tessier nor the names of his contributors
 *        may be used to endorse or promote products derived from this software
 *        without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR
 *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.jeantessier.classreader;

import java.util.Arrays;

public enum TypePathKind {
    DEEPER_IN_ARRAY_TYPE(0, "Annotation is deeper in an array type"),
    DEEPER_IN_NESTED_TYPE(1, "Annotation is deeper in a nested type"),
    BOUND_OF_A_WILDCARD_TYPE_ARGUMENT(2, "Annotation is on the bound of a wildcard type argument of a parameterized type"),
    TYPE_ARGUMENT(3, "Annotation is on a type argument of a parameterized type");

    private final int typePathKind;
    private final String description;

    TypePathKind(int typePathKind, String description) {
        this.typePathKind = typePathKind;
        this.description = description;
    }

    public int getTypePathKind() {
        return typePathKind;
    }

    public String getDescription() {
        return description;
    }

    public static TypePathKind forTypePathKind(int typePathKind) {
        return Arrays.stream(values())
                .filter(value -> value.getTypePathKind() == typePathKind)
                .findFirst()
                .orElse(null);
    }
}