/*
 * 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 java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

The type hint annotation is a general annotation that can be used on interfaces to provide
additional information about types used at runtime. This can aid ahead of time compilation tools like Graal.
Author:
graemerocher
Since:
1.0/**
 * The type hint annotation is a general annotation that can be used on interfaces to provide
 * additional information about types used at runtime. This can aid ahead of time compilation tools like Graal.
 *
 * @author graemerocher
 * @since 1.0
 */
@Target({ElementType.ANNOTATION_TYPE, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Experimental
public @interface TypeHint {
    
Returns:
The types to provide a hint/**
     * @return The types to provide a hint
     */
    Class[] value() default {};

    
Describes the access.
Returns:
The access type/**
     * Describes the access.
     * @return The access type
     */
    AccessType[] accessType() default AccessType.ALL_DECLARED_CONSTRUCTORS;

    
Returns:
The type names/**
     * @return The type names
     */
    String[] typeNames() default {};

    
The access type.
/**
     * The access type.
     */
    enum AccessType {
        
All public members.
/**
         * All public members.
         */
        ALL_PUBLIC,
        
All declared constructors require access.
/**
         * All declared constructors require access.
         */
        ALL_DECLARED_CONSTRUCTORS,
        
All public constructors require access.
/**
         * All public constructors require access.
         */
        ALL_PUBLIC_CONSTRUCTORS,
        
All declared methods require access.
/**
         * All declared methods require access.
         */
        ALL_DECLARED_METHODS,
        
All declared fields require access.
/**
         * All declared fields require access.
         */
        ALL_DECLARED_FIELDS,
        
All public methods require access.
/**
         * All public methods require access.
         */
        ALL_PUBLIC_METHODS,
        
All public fields require access.
/**
         * All public fields require access.
         */
        ALL_PUBLIC_FIELDS
    }
}