com.google.gwt.i18n.client.LocalizableResource Maven / Gradle / Ivy
/*
* Copyright 2008 Google Inc.
*
* 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
*
* http://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 com.google.gwt.i18n.client;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* This is the common superinterface to Messages and Constants.
*
* Each (and the Constants subinterface ConstantsWithLookup) provide
* compile-time localization of various forms of data. Messages is
* used for MessageFormat-style strings which can have
* parameters (including support for plural forms), while Constants
* can be other types, have simplified quoting requirements, and do
* not take any parameters.
*
* The annotations defined here are common to both -- see the individual
* subinterfaces for additional annotations which apply only to each
* one.
*/
public interface LocalizableResource extends Localizable {
/**
* Specifies the default locale for messages in this file. If not
* specified, the default is DEFAULT_LOCALE.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface DefaultLocale {
String DEFAULT_LOCALE = "en";
String value() default DEFAULT_LOCALE;
}
/**
* Specifies a description of the string to be translated, such as a note
* about the context.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Description {
String value();
}
/**
* Requests that a translation source file be generated from the annotated
* interface. The file type is determined by the format argument, and the
* file name by the optional fileName argument. Some file formats support
* aggregating messages from multiple interfaces into one file, while others
* do not; also, additional parameters may be specified via format-specific
* annotations -- see the documentation of the MessageCatalogFormat implementation
* for details.
*
* Examples:
*
* - @Generate(format = "com.google.gwt.i18n.server.PropertyCatalogFactory")
*
generates properties files for all locales, and the names will be
* of the form MyMessages_locale.properties
* - @Generate(format = {"com.example.ProprietaryFormat1",
* "com.example.ProprietaryFormat2"},
* fileName = "myapp_translate_source", locales = {"default"})
*
generates default files in two proprietary formats, with filenames like
* myapp_translate_source.p1 and myapp_translate_source.p2
*
The value is either the name of an inner class of {@code KeyGenerator} or the
* fully-qualified class name of some implementation of {@code KeyGenerator}.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface GenerateKeys {
String value() default "com.google.gwt.i18n.server.keygen.MD5KeyGenerator";
}
/**
* The key used for lookup of translated strings. If not present, the
* key will be generated based on the {@code @GenerateKeys} annotation,
* or the unqualified method name if it is not present.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Key {
String value();
}
/**
* Specifies the meaning of the translated string. For example, to
* distinguish between multiple meanings of a word or phrase.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface Meaning {
String value();
}
}