io.micronaut.core.annotation.AnnotationValueResolver Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-core Show documentation
Show all versions of micronaut-core Show documentation
Core components supporting the Micronaut Framework
/*
* 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 java.util.*;
/**
* Interface for types that resolve annotation values.
*
* @author graemerocher
* @since 1.0.3
*/
public interface AnnotationValueResolver extends ValueResolver {
/**
* 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 The enum type
*/
Optional enumValue(@NonNull String member, @NonNull Class enumType);
/**
* 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 The enum type
*/
default Optional enumValue(@NonNull Class enumType) {
return enumValue(AnnotationMetadata.VALUE_MEMBER, enumType);
}
/**
* 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 The enum type
*/
E[] enumValues(@NonNull String member, @NonNull Class enumType);
/**
* 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 The enum type
*/
default > EnumSet enumValuesSet(@NonNull String member, @NonNull Class enumType) {
E[] values = enumValues(member, enumType);
return values.length == 0 ? EnumSet.noneOf(enumType) : EnumSet.copyOf(Arrays.asList(values));
}
/**
* 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 The enum type
*/
default E[] enumValues(@NonNull Class enumType) {
return enumValues(AnnotationMetadata.VALUE_MEMBER, enumType);
}
/**
* The value of the annotation as a Class.
*
* @return An {@link Optional} class
*/
default Optional> classValue() {
return classValue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The value of the given annotation member as a Class.
*
* @param member The annotation member
* @return An {@link Optional} class
*/
Optional> classValue(@NonNull String member);
/**
* 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.
*
* @param member The annotation member
* @return An array of classes
*/
@NonNull Class[] classValues(@NonNull String member);
/**
* 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 {@link AnnotationClassValue} instance for the given member.
*
* @param member The annotation member
* @return An annotation class value
*/
Optional> annotationClassValue(@NonNull String member);
/**
* The integer value of the given member.
*
* @param member The annotation member
* @return An {@link OptionalInt}
*/
OptionalInt intValue(@NonNull String member);
/**
* The byte value of the given member.
*
* @return An {@link Optional} of {@link Byte}
* @since 3.0.0
*/
default Optional byteValue() {
return byteValue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The byte value of the given member.
*
* @param member The annotation member
* @return An {@link Optional} of {@link Byte}
* @since 3.0.0
*/
Optional byteValue(@NonNull String member);
/**
* The char value of the given member.
*
* @return An {@link Optional} of {@link Character}
* @since 3.0.0
*/
default Optional charValue() {
return charValue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The char value of the given member.
*
* @param member The annotation member
* @return An {@link Optional} of {@link Character}
* @since 3.0.0
*/
Optional charValue(@NonNull String member);
/**
* 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.
*
* @param member The annotation member
* @return An {@link OptionalLong}
*/
OptionalLong longValue(@NonNull String member);
/**
* The long value of the given member.
*
* @return An {@link OptionalLong}
*/
default OptionalLong longValue() {
return longValue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The short value of the given member.
*
* @param member The annotation member
* @return An {@link Optional} of {@link Short}
*/
Optional shortValue(@NonNull String member);
/**
* The integer value of the given member.
*
* @return An {@link Optional} of
*/
default Optional shortValue() {
return shortValue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The double value of the given member.
*
* @param member The annotation member
* @return An {@link OptionalDouble}
*/
OptionalDouble doubleValue(@NonNull String member);
/**
* The float value of the given member.
*
* @return An {@link Optional} of {@link Float}
* @since 3.0.0
*/
default Optional floatValue() {
return floatValue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The double value of the given member.
*
* @param member The annotation member
* @return An {@link OptionalDouble}
* @since 3.0.0
*/
Optional floatValue(@NonNull String member);
/**
* 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.
*
* @param member The annotation member
* @return An {@link OptionalInt}
*/
Optional stringValue(@NonNull String member);
/**
* The string value of the given member.
*
* @return An {@link OptionalInt}
*/
default Optional stringValue() {
return stringValue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The boolean value of the given member.
*
* @param member The annotation member
* @return An {@link Optional} boolean
*/
Optional booleanValue(@NonNull String member);
/**
* The Boolean value of the given member.
*
* @return An {@link Optional} boolean
*/
default Optional booleanValue() {
return booleanValue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The string values for the given member.
*
* @param member The annotation member
* @return An array of {@link String}
*/
@NonNull String[] stringValues(@NonNull String member);
/**
* The string values for the given member.
*
* @return An array of {@link String}
*/
default @NonNull String[] stringValues() {
return stringValues(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The boolean[] value for the given member.
*
* @param member The annotation member
* @return An array of {@code boolean}
* @since 3.0.0
*/
@NonNull boolean[] booleanValues(@NonNull String member);
/**
* The boolean[] value for the given member.
*
* @return An array of {@code boolean}
* @since 3.0.0
*/
default @NonNull boolean[] booleanValues() {
return booleanValues(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The byte[] value for the given member.
*
* @param member The annotation member
* @return An array of {@code byte}
* @since 3.0.0
*/
@NonNull byte[] byteValues(@NonNull String member);
/**
* The byte[] value for the given member.
*
* @return An array of {@code byte}
* @since 3.0.0
*/
default @NonNull byte[] byteValues() {
return byteValues(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The char[] value for the given member.
*
* @param member The annotation member
* @return An array of {@code char}
* @since 3.0.0
*/
@NonNull char[] charValues(@NonNull String member);
/**
* The char[] value for the given member.
*
* @return An array of {@code char}
* @since 3.0.0
*/
default @NonNull char[] charValues() {
return charValues(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The int[] value for the given member.
*
* @param member The annotation member
* @return An array of {@code int}
* @since 3.0.0
*/
@NonNull int[] intValues(@NonNull String member);
/**
* The int[] value for the given member.
*
* @return An array of {@code int}
* @since 3.0.0
*/
default @NonNull int[] intValues() {
return intValues(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The double[] value for the given member.
*
* @param member The annotation member
* @return An array of {@code double}
* @since 3.0.0
*/
@NonNull double[] doubleValues(@NonNull String member);
/**
* The double[] value for the given member.
*
* @return An array of {@code double}
* @since 3.0.0
*/
default @NonNull double[] doubleValues() {
return doubleValues(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The long[] value for the given member.
*
* @param member The annotation member
* @return An array of {@code long}
* @since 3.0.0
*/
@NonNull long[] longValues(@NonNull String member);
/**
* The long[] value for the given member.
*
* @return An array of {@code long}
* @since 3.0.0
*/
default @NonNull long[] longValues() {
return longValues(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The float[] value for the given member.
*
* @param member The annotation member
* @return An array of {@code float}
* @since 3.0.0
*/
@NonNull float[] floatValues(@NonNull String member);
/**
* The float[] value for the given member.
*
* @return An array of {@code float}
* @since 3.0.0
*/
default @NonNull float[] floatValues() {
return floatValues(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The short[] value for the given member.
*
* @param member The annotation member
* @return An array of {@code short}
* @since 3.0.0
*/
@NonNull short[] shortValues(@NonNull String member);
/**
* The short[] value for the given member.
*
* @return An array of {@code short}
* @since 3.0.0
*/
default @NonNull short[] shortValues() {
return shortValues(AnnotationMetadata.VALUE_MEMBER);
}
/**
* Is the given member present.
* @param member The member
* @return True if it is
*/
boolean isPresent(CharSequence member);
/**
* @return Is the value of the annotation true.
*/
default boolean isTrue() {
return isTrue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* @param member The member
*
* @return Is the value of the annotation true.
*/
boolean isTrue(String member);
/**
* @return Is the value of the annotation true.
*/
default boolean isFalse() {
return isFalse(AnnotationMetadata.VALUE_MEMBER);
}
/**
* @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.
*
* @param member The annotation member
* @param requiredType The required type
* @return An {@link Optional} class
* @param The required type
*/
Optional> classValue(@NonNull String member, @NonNull Class requiredType);
/**
* @return The attribute values
*/
@NonNull
Map getValues();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy