de.skuzzle.stringz.annotation.FamilyLocator Maven / Gradle / Ivy

Go to download
package de.skuzzle.stringz.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import de.skuzzle.stringz.strategy.BundleFamilyLocator;

/**
 * Can be used to apply a custom bundle family lookup for a single message class.
 * You have to implement the family lookup strategy using 
 * {@link BundleFamilyLocator} and supply an instance of that class to 
 * {@link de.skuzzle.stringz.Stringz#registerLocator(BundleFamilyLocator)}. Using this 
 * annotation, you can instruct stringz to use your new custom locator when initializing a 
 * {@code Messages} instance:
 * 
 *  * @ResourceMapping
 * @FamilyLocator(MyCustomFamilyLocator.class)
 * public class MSG {
 *     //...
 * }
 * 
 * @author Simon Taddiken
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface FamilyLocator {
    /**
     * Defines the {@link BundleFamilyLocator} class to use when locating the bundle 
     * family for a {@code ResourceMapping} class. A concrete implementation of the class
     * specified as value has to be registered with 
     * {@link de.skuzzle.stringz.Stringz#registerLocator(BundleFamilyLocator)}.
     * 
     * @return The class of the {@link BundleFamilyLocator} to use with this class.
     */
    Class value();
}