/*
 * Copyright 2017-2020 original authors
 *
 * 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
 *
 * https://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.micronaut.core.annotation;

import io.micronaut.core.value.ValueResolver;

import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.*;

Interface for types that resolve annotation values.
Author:
graemerocher
Since:
1.0.3/**
 * Interface for types that resolve annotation values.
 *
 * @author graemerocher
 * @since 1.0.3
 */
public interface AnnotationValueResolver extends ValueResolver<CharSequence> {
    
Return the enum value of the given member of the given enum type.
Params:
member – The annotation member
enumType – The required type
Type parameters:
<E> – The enum type
Returns:
An Optional of the enum value/**
     * Return the enum value of the given member of the given enum type.
     *
     * @param member The annotation member
     * @param enumType The required type
     * @return An {@link Optional} of the enum value
     * @param <E> The enum type
     */
    <E extends Enum> Optional<E> enumValue(@NonNull String member, @NonNull Class<E> enumType);

    
Return the enum value of the given member of the given enum type.
Params:
enumType – The required type
Type parameters:
<E> – The enum type
Returns:
An Optional of the enum value/**
     * Return the enum value of the given member of the given enum type.
     *
     * @param enumType The required type
     * @return An {@link Optional} of the enum value
     * @param <E> The enum type
     */
    default <E extends Enum> Optional<E> enumValue(@NonNull Class<E> enumType) {
        return enumValue(AnnotationMetadata.VALUE_MEMBER, enumType);
    }

    
Return the enum value of the given member of the given enum type.
Params:
member – The annotation member
enumType – The required type
Type parameters:
<E> – The enum type
Returns:
An Optional of the enum value/**
     * Return the enum value of the given member of the given enum type.
     *
     * @param member The annotation member
     * @param enumType The required type
     * @return An {@link Optional} of the enum value
     * @param <E> The enum type
     */
    <E extends Enum> E[] enumValues(@NonNull String member, @NonNull Class<E> enumType);

    
Return the enum value of the given member of the given enum type.
Params:
enumType – The required type
Type parameters:
<E> – The enum type
Returns:
An Optional of the enum value/**
     * Return the enum value of the given member of the given enum type.
     *
     * @param enumType The required type
     * @return An {@link Optional} of the enum value
     * @param <E> The enum type
     */
    default <E extends Enum> E[] enumValues(@NonNull Class<E> enumType) {
        return enumValues(AnnotationMetadata.VALUE_MEMBER, enumType);
    }

    
The value of the annotation as a Class.
Returns:
An Optional class/**
     * The value of the annotation as a Class.
     *
     * @return An {@link Optional} class
     */
    default Optional<Class<?>> classValue() {
        return classValue(AnnotationMetadata.VALUE_MEMBER);
    }

    
The value of the given annotation member as a Class.
Params:
member – The annotation member
Returns:
An Optional class/**
     * The value of the given annotation member as a Class.
     *
     * @param member The annotation member
     * @return An {@link Optional} class
     */
    Optional<Class<?>> classValue(@NonNull String member);

    
The value of the annotation as a Class.
Returns:
An array of classes/**
     * The value of the annotation as a Class.
     *
     * @return An array of classes
     */
    @NonNull
    default Class<?>[] classValues() {
        return classValues(AnnotationMetadata.VALUE_MEMBER);
    }

    
The value of the given annotation member as a Class.
Params:
member – The annotation member
Returns:
An array of classes/**
     * The value of the given annotation member as a Class.
     *
     * @param member The annotation member
     * @return An array of classes
     */
    @NonNull Class<?>[] classValues(@NonNull String member);


    
The AnnotationClassValue instances for the given member. Unlike classValues(String) this may include classes that are no the classpath. 
Params:
member – The annotation member
Returns:
An array of class values/**
     * The {@link AnnotationClassValue} instances for the given member. Unlike {@link #classValues(String)} this may
     * include classes that are no the classpath.
     *
     * @param member The annotation member
     * @return An array of class values
     */
    @NonNull AnnotationClassValue<?>[] annotationClassValues(@NonNull String member);

    
The AnnotationClassValue instance for the given member. 
Params:
member – The annotation member
Returns:
An annotation class value/**
     * The {@link AnnotationClassValue} instance for the given member.
     *
     * @param member The annotation member
     * @return An annotation class value
     */
    Optional<AnnotationClassValue<?>> annotationClassValue(@NonNull String member);

    
The integer value of the given member.
Params:
member – The annotation member
Returns:
An OptionalInt/**
     * The integer value of the given member.
     *
     * @param member The annotation member
     * @return An {@link OptionalInt}
     */
    OptionalInt intValue(@NonNull String member);

    
The integer value of the given member.
Returns:
An OptionalInt/**
     * The integer value of the given member.
     *
     * @return An {@link OptionalInt}
     */
    default OptionalInt intValue() {
        return intValue(AnnotationMetadata.VALUE_MEMBER);
    }

    
The long value of the given member.
Params:
member – The annotation member
Returns:
An OptionalLong/**
     * The long value of the given member.
     *
     * @param member The annotation member
     * @return An {@link OptionalLong}
     */
    OptionalLong longValue(@NonNull String member);

    
The integer value of the given member.
Returns:
An OptionalLong/**
     * The integer value of the given member.
     *
     * @return An {@link OptionalLong}
     */
    default OptionalLong longValue() {
        return longValue(AnnotationMetadata.VALUE_MEMBER);
    }

    
The double value of the given member.
Params:
member – The annotation member
Returns:
An OptionalDouble/**
     * The double value of the given member.
     *
     * @param member The annotation member
     * @return An {@link OptionalDouble}
     */
    OptionalDouble doubleValue(@NonNull String member);

    
The double value of the given member.
Returns:
An OptionalDouble/**
     * The double value of the given member.
     *
     * @return An {@link OptionalDouble}
     */
    default OptionalDouble doubleValue() {
        return doubleValue(AnnotationMetadata.VALUE_MEMBER);
    }

    
The string value of the given member.
Params:
member – The annotation member
Returns:
An OptionalInt/**
     * The string value of the given member.
     *
     * @param member The annotation member
     * @return An {@link OptionalInt}
     */
    Optional<String> stringValue(@NonNull String member);

    
The string value of the given member.
Returns:
An OptionalInt/**
     * The string value of the given member.
     *
     * @return An {@link OptionalInt}
     */
    default Optional<String> stringValue() {
        return stringValue(AnnotationMetadata.VALUE_MEMBER);
    }

    
The boolean value of the given member.
Params:
member – The annotation member
Returns:
An Optional boolean/**
     * The boolean value of the given member.
     *
     * @param member The annotation member
     * @return An {@link Optional} boolean
     */
    Optional<Boolean> booleanValue(@NonNull String member);

    
The Boolean value of the given member.
Returns:
An Optional boolean/**
     * The Boolean value of the given member.
     *
     * @return An {@link Optional} boolean
     */
    default Optional<Boolean> booleanValue() {
        return booleanValue(AnnotationMetadata.VALUE_MEMBER);
    }


    
The string value of the given member.
Params:
member – The annotation member
Returns:
An OptionalInt/**
     * The string value of the given member.
     *
     * @param member The annotation member
     * @return An {@link OptionalInt}
     */
    @NonNull String[] stringValues(@NonNull String member);

    
The double value of the given member.
Returns:
An OptionalInt/**
     * The double value of the given member.
     *
     * @return An {@link OptionalInt}
     */
    default @NonNull String[] stringValues() {
        return stringValues(AnnotationMetadata.VALUE_MEMBER);
    }

    
Is the given member present.
Params:
member – The member
Returns:
True if it is/**
     * Is the given member present.
     * @param member The member
     * @return True if it is
     */
    boolean isPresent(CharSequence member);

    
Returns:
Is the value of the annotation true./**
     * @return Is the value of the annotation true.
     */
    default boolean isTrue() {
        return isTrue(AnnotationMetadata.VALUE_MEMBER);
    }

    
Params:
member – The member
Returns:
Is the value of the annotation true./**
     * @param member The member
     *
     * @return Is the value of the annotation true.
     */
    boolean isTrue(String member);

    
Returns:
Is the value of the annotation true./**
     * @return Is the value of the annotation true.
     */
    default boolean isFalse() {
        return isFalse(AnnotationMetadata.VALUE_MEMBER);
    }

    
Params:
member – The member
Returns:
Is the value of the annotation true./**
     * @param member The member
     *
     * @return Is the value of the annotation true.
     */
    boolean isFalse(String member);

    
The value of the given annotation member as a Class.
Params:
member – The annotation member
requiredType – The required type
Type parameters:
<T> – The required type
Returns:
An Optional class/**
     * The value of the given annotation member as a Class.
     *
     * @param member The annotation member
     * @param requiredType The required type
     * @return An {@link Optional} class
     * @param <T> The required type
     */
    <T> Optional<Class<? extends T>> classValue(@NonNull String member, @NonNull Class<T> requiredType);

    
Returns:
The attribute values/**
     * @return The attribute values
     */
    @NonNull
    Map<CharSequence, Object> getValues();
}