io.micronaut.inject.annotation.EnvironmentAnnotationMetadata Maven / Gradle / Ivy
/*
* 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.inject.annotation;
import io.micronaut.core.annotation.AnnotationMetadata;
import io.micronaut.core.annotation.Internal;
import io.micronaut.core.type.Argument;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import java.lang.annotation.Annotation;
import java.util.*;
import java.util.function.Function;
/**
* Internal interface representing environment aware annotation metadata.
*
* @author graemerocher
* @since 1.3.0
*/
@Internal
interface EnvironmentAnnotationMetadata extends AnnotationMetadata {
/**
* @return Environment metadata always has property expressions.
*/
@Override
default boolean hasPropertyExpressions() {
return true;
}
/**
* Retrieve the enum value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param enumType The enum type
* @param valueMapper The value mapper
* @param The enum type
* @return The enum value
*/
@Internal
Optional enumValue(@NonNull Class annotation, @NonNull String member, Class enumType, @Nullable Function valueMapper);
/**
* Retrieve the enum value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param enumType The enum type
* @param valueMapper The value mapper
* @param The enum type
* @return The enum value
*/
@Internal
Optional enumValue(@NonNull String annotation, @NonNull String member, Class enumType, @Nullable Function valueMapper);
/**
* Retrieve the enum values and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param enumType The enum type
* @param valueMapper The value mapper
* @param The enum type
* @return The enum value
*/
@Internal
E[] enumValues(@NonNull Class annotation, @NonNull String member, Class enumType, @Nullable Function valueMapper);
/**
* Retrieve the enum values and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param enumType The enum type
* @param valueMapper The value mapper
* @param The enum type
* @return The enum value
*/
@Internal
E[] enumValues(@NonNull String annotation, @NonNull String member, Class enumType, @Nullable Function valueMapper);
/**
* Retrieve the class value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param valueMapper The value mapper
* @return The class value
*/
Optional classValue(@NonNull Class annotation, @NonNull String member, Function valueMapper);
/**
* Retrieve the class value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param valueMapper The value mapper
* @return The class value
*/
@Internal
Optional classValue(@NonNull String annotation, @NonNull String member, @Nullable Function valueMapper);
/**
* Retrieve the int value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param valueMapper The value mapper
* @return The int value
*/
@Internal
OptionalInt intValue(@NonNull Class annotation, @NonNull String member, @Nullable Function valueMapper);
/**
* Retrieve the boolean value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param valueMapper The value mapper
* @return The boolean value
*/
Optional booleanValue(@NonNull Class annotation, @NonNull String member, Function valueMapper);
/**
* Retrieve the boolean value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param valueMapper The value mapper
* @return The boolean value
*/
@NonNull
Optional booleanValue(@NonNull String annotation, @NonNull String member, @Nullable Function valueMapper);
/**
* Retrieve the long value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param valueMapper The value mapper
* @return The long value
*/
@Internal
OptionalLong longValue(@NonNull Class annotation, @NonNull String member, @Nullable Function valueMapper);
/**
* Retrieve the long value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param valueMapper The value mapper
* @return The long value
*/
@NonNull
OptionalLong longValue(@NonNull String annotation, @NonNull String member, @Nullable Function valueMapper);
/**
* Retrieve the int value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param valueMapper The value mapper
* @return The int value
*/
@NonNull
OptionalInt intValue(@NonNull String annotation, @NonNull String member, @Nullable Function valueMapper);
/**
* Retrieve the string value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param valueMapper The value mapper
* @return The int value
*/
Optional stringValue(@NonNull Class annotation, @NonNull String member, Function valueMapper);
/**
* Retrieve the string value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param valueMapper The value mapper
* @return The int value
*/
@NonNull
String[] stringValues(@NonNull Class annotation, @NonNull String member, Function valueMapper);
/**
* Retrieve the string value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param valueMapper The value mapper
* @return The string value
*/
@NonNull
Optional stringValue(@NonNull String annotation, @NonNull String member, @Nullable Function valueMapper);
/**
* Retrieve the boolean value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param valueMapper The value mapper
* @return The boolean value
*/
boolean isTrue(@NonNull Class annotation, @NonNull String member, Function valueMapper);
/**
* Retrieve the boolean value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param valueMapper The value mapper
* @return The boolean value
*/
boolean isTrue(@NonNull String annotation, @NonNull String member, @Nullable Function valueMapper);
/**
* Retrieve the double value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param valueMapper The value mapper
* @return The double value
*/
@Internal
OptionalDouble doubleValue(@NonNull Class annotation, @NonNull String member, @Nullable Function valueMapper);
/**
* Retrieve the double value and optionally map its value.
* @param annotation The annotation
* @param member The member
* @param valueMapper The value mapper
* @return The double value
*/
@NonNull
@Internal
OptionalDouble doubleValue(@NonNull String annotation, @NonNull String member, Function valueMapper);
/**
* Resolves the given value performing type conversion as necessary.
* @param annotation The annotation
* @param member The member
* @param requiredType The required type
* @param valueMapper The value mapper
* @param The generic type
* @return The resolved value
*/
@NonNull
Optional getValue(@NonNull String annotation, @NonNull String member, @NonNull Argument requiredType, @Nullable Function valueMapper);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy