org.osgl.inject.annotation.MapKey Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of genie Show documentation

A JSR330 style dependency injection solution

There is a newer version: 1.13.2

package org.osgl.inject.annotation;

import org.osgl.inject.KeyExtractor;

import java.lang.annotation.*;

/**
 * Used to specify how to extract {@link java.util.Map} key
 * from a value
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.PARAMETER})
public @interface MapKey {

    /**
     * Specify the `hint` to be passed into {@link KeyExtractor#keyOf(String, Object)}
     * function call
     *
     * @return the `hint` used to extract the key. Default value is ""
     */
    String value() default "";

    /**
     * Specify a {@link KeyExtractor key extractor}. Default value is
     * {@link org.osgl.inject.KeyExtractor.PropertyExtractor}
     */
    Class extractor() default KeyExtractor.PropertyExtractor.class;
}