org.meeuw.i18n.languages.validation.Language Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of i18n-iso-639 Show documentation

Provides a class with one instance of every of the ISO 639 languages

There is a newer version: 3.8

package org.meeuw.i18n.languages.validation;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import org.meeuw.i18n.languages.Scope;
import org.meeuw.i18n.languages.Type;
import org.meeuw.i18n.languages.validation.impl.LanguageValidator;

/**
 * A validator for language codes (or {@link java.util.Locale}s (which also is a container for language codes)
 *   
 * @author Michiel Meeuwissen
 * @since 2.2
 */

@Target({FIELD, METHOD, TYPE_PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Constraint(validatedBy = LanguageValidator.class)
@Documented
public @interface Language {

    String message() default "{org.meeuw.i18n.languages.validation.language.message}";

    Class[] groups() default {};

    Class[] payload() default {};
    
    /***
     * If the language is  not directly recognized, we'll check if the JVM can produce a display language for it.
     */
    boolean lenient() default false;


    Type[] type() default {};

    Scope[] scope() default { };

    /**
     * The default is to accept both ISO-639-1 and ISO-639-3 codes. If you want to restrict to ISO-639-1 only, set this to false.
     */
    boolean iso639_3() default true;

    boolean iso639_3_retired() default true;

    /**
     * The default is to accept also part 2 codes.
     */
    boolean iso639_2() default true;
    
    
     /**
     * The default is not to accept also part 5 codes (language families)
     */
    boolean iso639_5() default false;

    
    boolean requireLowerCase() default true;
    
    /**
     * xml:lang uses '-' between language and country. In XML language codes are case-insensitive, so
     * you may want to set {@link #requireLowerCase()} to false too.
     */
    boolean forXml() default true;
    
    
     /**
     * Whether the locale may contain a country.
     * 
     * the country itself is not validated. Use {@link @Country} for that.
     */
    boolean mayContainCountry() default true;
    
    /**
     * Whether the locale may contain a variant
     */
    boolean mayContainVariant() default false;

}