javax.portlet.annotations.LocaleString Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portlet-api Show documentation
Show all versions of portlet-api Show documentation
The Java Portlet API version 3.0 developed by the Java Community Process JSR-362 Expert Group.
/* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
/*
* This source code implements specifications defined by the Java
* Community Process. In order to remain compliant with the specification
* DO NOT add / change / or delete method signatures!
*/
package javax.portlet.annotations;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;
/**
*
* This annotation represents locale-specific strings used within composite portlet configuration annotations to
* represent information describing the portlet.
* It cannot be used as a stand-alone portlet annotation.
*
*/
@Retention(RUNTIME) @Target({ANNOTATION_TYPE})
public @interface LocaleString {
/**
*
* The locale for the locale-specific string.
*
* The locale is specified as a language tag as defined in
* IETF BCP 47, "Tags for Identifying Languages".
*
*
* @see java.util.Locale
* @see java.util.Locale#forLanguageTag forLanguageTag
* @see IETF BCP 47
*
* @return The locale
*/
String locale() default "en";
/**
* The parameter value
*
* @return The parameter value
*/
String value();
}