org.jboss.logging.annotations.Message Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
*
* Copyright 2023 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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 org.jboss.logging.annotations;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.CLASS;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
* Assigns a message string to a resource method. The method arguments are used to supply the positional parameter
* values for the method.
*
* @author David M. Lloyd
*/
@Target(METHOD)
@Retention(CLASS)
@Documented
public @interface Message {
/**
* Indicates that this message has no ID.
*/
int NONE = 0;
/**
* Indicates that this message should inherit the ID from another message with the same name.
*/
int INHERIT = -1;
/**
* The message ID number. Only one message with a given name may specify an ID other than {@link #INHERIT}.
*
* @return the message ID number
*/
int id() default INHERIT;
/**
* The default format string of this message.
*
* Expressions in the form of {@code ${property.key:default-value}} can be used for the value. If the property key is
* prefixed with {@code sys.} a {@linkplain System#getProperty(String) system property} will be used. If the key is
* prefixed with {@code env.} an {@linkplain System#getenv(String) environment variable} will be used. In all other cases
* the {@code org.jboss.logging.tools.expressionProperties} processor argument is used to specify the path the properties
* file which contains the values for the expressions.
*
*
* @return the format string
*/
String value();
/**
* The format type of this method (defaults to {@link Format#PRINTF}).
*
* @return the format type
*/
Format format() default Format.PRINTF;
/**
* The possible format types.
*/
enum Format {
/**
* A {@link java.util.Formatter}-type format string.
*/
PRINTF,
/**
* A {@link java.text.MessageFormat}-type format string.
*/
MESSAGE_FORMAT,
/**
* Indicates the message should not be formatted.
*/
NO_FORMAT,
}
}