diff -Nru jboss-logging-tools-2.0.2/annotations/pom.xml jboss-logging-tools-2.1.0/annotations/pom.xml
--- jboss-logging-tools-2.0.2/annotations/pom.xml 2016-11-19 04:13:37.000000000 +0000
+++ jboss-logging-tools-2.1.0/annotations/pom.xml 2017-08-09 18:02:31.000000000 +0000
@@ -25,7 +25,7 @@
org.jboss.loggingjboss-logging-tools-parent
- 2.0.2.Final
+ 2.1.0.Final../pom.xml
@@ -50,4 +50,4 @@
provided
-
\ No newline at end of file
+
diff -Nru jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/BaseUrl.java jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/BaseUrl.java
--- jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/BaseUrl.java 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/BaseUrl.java 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,55 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2017 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.TYPE;
+import static java.lang.annotation.RetentionPolicy.CLASS;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * Messages on reports can have a link to a {@linkplain ResolutionDoc resolution document}. This annotation can be used
+ * to provide a base URL for these documents.
+ *
+ * Expressions in the form of {@code ${property.key:default-value}} can be used for the values. 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.
+ *
+ *
+ * @author James R. Perkins
+ * @since 1.2
+ */
+@Target(TYPE)
+@Retention(CLASS)
+@Documented
+public @interface BaseUrl {
+
+ /**
+ * The base URL used for links to resolution documentation on reports. This can be a fully qualified URL or a
+ * relative URL.
+ *
+ * @return the base URL
+ */
+ String value();
+}
diff -Nru jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Field.java jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Field.java
--- jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Field.java 2016-11-19 04:13:37.000000000 +0000
+++ jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Field.java 2017-08-09 18:02:31.000000000 +0000
@@ -19,27 +19,109 @@
package org.jboss.logging.annotations;
+import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.CLASS;
import java.lang.annotation.Documented;
+import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
* Indicate that a method parameter value should be applied to a field on the resultant exception object.
+ *
+ * If this annotation is placed on a method the {@linkplain #name() name} attribute becomes a required parameter and one
+ * default attribute needs to be set. The value of the default attribute is used to set the filed on the resultant
+ * exception object.
+ *
*
* @author David M. Lloyd
+ * @author James R. Perkins
*/
@Retention(CLASS)
-@Target(PARAMETER)
+@Target({PARAMETER, METHOD})
+@Repeatable(Fields.class)
@Documented
public @interface Field {
/**
* The field name. If not specified, the parameter name is assumed to be the field name.
+ *
+ * This becomes a required attrubyte if this annotation is present on a method.
+ *
*
* @return the field name
*/
String name() default "";
+
+ /**
+ * The default {@code boolean} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ boolean booleanValue() default false;
+
+ /**
+ * The default boolean value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ byte byteValue() default 0x00;
+
+ /**
+ * The default {@code byte} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ char charValue() default 0x00;
+
+ /**
+ * The default {@link Class} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ Class classValue() default Object.class;
+
+ /**
+ * The default {@code double} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ double doubleValue() default 0.0d;
+
+ /**
+ * The default {@code float} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ float floatValue() default 0.0f;
+
+ /**
+ * The default {@code int} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ int intValue() default 0;
+
+ /**
+ * The default {@code long} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ long longValue() default 0L;
+
+ /**
+ * The default {@code short} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ short shortValue() default 0;
+
+ /**
+ * The default {@link String} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ String stringValue() default "";
}
diff -Nru jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Fields.java jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Fields.java
--- jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Fields.java 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Fields.java 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,47 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2016 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;
+
+/**
+ * Defines the default field properties to use on the resultant exception object.
+ *
+ * @author James R. Perkins
+ */
+@Retention(CLASS)
+@Target(METHOD)
+@Documented
+public @interface Fields {
+
+ /**
+ * The fields to use on the resultant exception object. Note that the {@link Field#name() name} attribute is
+ * required for these annotations.
+ *
+ * @return the fields
+ */
+ Field[] value();
+}
diff -Nru jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Message.java jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Message.java
--- jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Message.java 2016-11-19 04:13:37.000000000 +0000
+++ jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Message.java 2017-08-09 18:02:31.000000000 +0000
@@ -55,6 +55,13 @@
/**
* 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
*/
diff -Nru jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Producer.java jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Producer.java
--- jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Producer.java 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Producer.java 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,76 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2017 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.PARAMETER;
+import static java.lang.annotation.RetentionPolicy.CLASS;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * Identifies a parameter has the ability to produce a {@link Throwable} or a super type of a {@code Throwable}. The
+ * parameter type must be a {@link java.util.function.Function} or a {@link java.util.function.BiFunction}.
+ *
+ * For a {@link java.util.function.Function} the input parameter must be a {@link String} which will be the message
+ * associated with the method. The result type must {@link Throwable} or a super type of a {@code Throwable}.
+ *
+ *
+ *
+ * For a {@link java.util.function.BiFunction} one of the input parameters must be a {@link String} which will be the
+ * message associated with the method. The other input parameter must be a {@link Throwable} or a super type of a
+ * {@code Throwable} and must be assignable from the parameter annotated with {@link Cause}. The result type must
+ * {@link Throwable} or a super type of a {@code Throwable}.
+ *
+ *
+ *
+ * Example
+ *
+ *
+ * @Message("The operation failed due to %s")
+ * T operationFailed(@Producer Function function, String op);
+ *
+ * @Message("The operation failed due to %s")
+ * T operationFailed(@Producer BiFunction function, @Cause Throwable cause, String op);
+ *
+ *
+ *
+ * @author James R. Perkins
+ */
+@Target(PARAMETER)
+@Retention(CLASS)
+@Documented
+public @interface Producer {
+}
diff -Nru jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Properties.java jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Properties.java
--- jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Properties.java 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Properties.java 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,47 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2016 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;
+
+/**
+ * Defines the default properties to use on the resultant exception object.
+ *
+ * @author James R. Perkins
+ */
+@Retention(CLASS)
+@Target(METHOD)
+@Documented
+public @interface Properties {
+
+ /**
+ * The properties to use on the resultant exception object. Note that the {@link Property#name() name} attribute is
+ * required for these annotations.
+ *
+ * @return the properties
+ */
+ Property[] value();
+}
diff -Nru jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Property.java jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Property.java
--- jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Property.java 2016-11-19 04:13:37.000000000 +0000
+++ jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Property.java 2017-08-09 18:02:31.000000000 +0000
@@ -20,27 +20,110 @@
package org.jboss.logging.annotations;
+import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.CLASS;
import java.lang.annotation.Documented;
+import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
- * Indicate that a method parameter value should be applied to a property (with a setter method) on the resultant exception object.
+ * Indicate that a method parameter value should be applied to a property (with a setter method) on the resultant
+ * exception object.
+ *
+ * If this annotation is placed on a method the {@linkplain #name() name} attribute becomes a required parameter and one
+ * default attribute needs to be set. The value of the default attribute is used to set the property on the resultant
+ * exception object.
+ *
*
* @author David M. Lloyd
+ * @author James R. Perkins
*/
@Retention(CLASS)
-@Target(PARAMETER)
+@Target({PARAMETER, METHOD})
+@Repeatable(Properties.class)
@Documented
public @interface Property {
/**
* The property name. If not specified, the parameter name is assumed to be the property name.
+ *
+ * This becomes a required attribute if this annotation is present on a method.
+ *
*
* @return the property name
*/
String name() default "";
+
+ /**
+ * The default {@code boolean} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ boolean booleanValue() default false;
+
+ /**
+ * The default boolean value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ byte byteValue() default 0x00;
+
+ /**
+ * The default {@code byte} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ char charValue() default 0x00;
+
+ /**
+ * The default {@link Class} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ Class classValue() default Object.class;
+
+ /**
+ * The default {@code double} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ double doubleValue() default 0.0d;
+
+ /**
+ * The default {@code float} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ float floatValue() default 0.0f;
+
+ /**
+ * The default {@code int} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ int intValue() default 0;
+
+ /**
+ * The default {@code long} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ long longValue() default 0L;
+
+ /**
+ * The default {@code short} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ short shortValue() default 0;
+
+ /**
+ * The default {@link String} value if this annotation is used on a method.
+ *
+ * @return the default value to use
+ */
+ String stringValue() default "";
}
diff -Nru jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/ResolutionDoc.java jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/ResolutionDoc.java
--- jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/ResolutionDoc.java 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/ResolutionDoc.java 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,104 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2017 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.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.CLASS;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * Allows a link to be created for messages on a report which contain a possible resolution to the issue reported . If
+ * the method does not include an {@linkplain Message#id() id} no link will be created for the report unless a
+ * {@link #path()} is defined.
+ *
+ *
+ * The rules for building the URL are as follows:
+ *
+ *
{@link #url() url}: If left empty and the type is annotated with a {@link BaseUrl} the value for the
+ * {@code @BaseUrl} will be used. If defined this will override the value of the {@link BaseUrl}. If neither are
+ * defined the rules for the {@link #path()} will be followed.
+ *
{@link #path() path}: If defined this will be the path appended to the {@link #url()} or the value of the
+ * {@link BaseUrl}. Note that neither {@link #url()} nor {@link BaseUrl} are required. If the value is left
+ * undefined the id (project code plus the {@linkplain Message#id() message id}) will be used for the path.
+ *
{@link #suffix() suffix}: The suffix to append to the {@link #path()}. This is mostly useful if the path
+ * is left undefined and a suffix should be appended to the messages id. If left undefined and the {@link #path()}
+ * is not defined, the suffix will be determined based on the report type.
+ *
+ *
+ *
+ *
+ * If placed on a type links will be created for all methods on the type.
+ *
+ *
+ *
+ * Do note that the processor does not validate the resolution document exists. It simply attempts to create links to
+ * the resolution document.
+ *
+ *
+ * Expressions in the form of {@code ${property.key:default-value}} can be used for the values with the exception of the
+ * {@link #skip() skip} attribute. 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.
+ *
+ *
+ * @author James R. Perkins
+ * @since 1.2
+ */
+@Target({METHOD, TYPE})
+@Retention(CLASS)
+@Documented
+public @interface ResolutionDoc {
+
+ /**
+ * The URL, fully qualified or relative, to use for the resolution document. If defined this will override the value
+ * of the {@link BaseUrl} if the annotation is used.
+ *
+ * @return the URL or an empty string
+ */
+ String url() default "";
+
+ /**
+ * The path to the resolution document. If left undefined this will default to the message id.
+ *
+ * @return the path to the resolution document
+ */
+ String path() default "";
+
+ /**
+ * The suffix to append to the path. If left undefined this will default to the extension for the report type. For
+ * example if the report type is {@code xml} the default suffix would be {@code .xml}.
+ *
+ * @return the suffix for the resolution document
+ */
+ String suffix() default "";
+
+ /**
+ * Allows the creation of a link to be skipped.
+ *
+ * @return {@code true} if creating the link should be skipped
+ */
+ boolean skip() default false;
+}
diff -Nru jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Signature.java jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Signature.java
--- jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Signature.java 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Signature.java 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,100 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2016 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;
+
+/**
+ * Specifies the exact signature to use when creating a {@link Throwable} return type.
+ *
+ *
+ * Given the following exception and message bundle interface method the {@code InvalidIntValueException(final RuntimeException cause, final String msg, final int value)}
+ * constructor would be used.
+ *
+ *
+ *
+ * public class InvalidIntValueException extends RuntimeException {
+ * private final RuntimeException causeAsRuntime;
+ * private final int value;
+ * public InvalidIntValueException(final Throwable cause, final String msg, final int value) {
+ * super(msg, cause);
+ * causeAsRuntime = new RuntimeException(cause);
+ * this.value = value;
+ * }
+ *
+ * public InvalidIntValueException(final RuntimeException cause, final String msg, final int value) {
+ * super(msg, cause);
+ * causeAsRuntime = cause;
+ * this.value = value;
+ * }
+ * public InvalidIntValueException(final RuntimeException cause, final String msg, final Integer value) {
+ * super(msg, cause);
+ * causeAsRuntime = cause;
+ * this.value = value;
+ * }
+ * }
+ *
+ *
+ *
+ *
+ *
+ * @Message("Invalid value %d")
+ * @Signature(causeIndex = 0, messageIndex = 1, value = {RuntimeException.class, String.class, int.class}
+ * InvalidIntValueException invalidValue(@Cause RuntimeException cause, @Param int value);
+ *
+ *
+ *
+ *
+ * @author James R. Perkins
+ */
+@Retention(CLASS)
+@Target(METHOD)
+@Documented
+public @interface Signature {
+
+ /**
+ * An array of types matching the exact signature to use for the exception being created.
+ *
+ * @return an array of types used to find the signature
+ */
+ Class[] value();
+
+ /**
+ * The index for the {@linkplain Cause cause} of the exception being created. A value of less than zero assumes
+ * there is no cause parameter in the constructor. A {@link Cause} annotation can still be used and the
+ * {@link Throwable#initCause(Throwable)} will be used to initialize the cause of the exception.
+ *
+ * @return the index for the cause parameter
+ */
+ int causeIndex() default -1;
+
+ /**
+ * The index for the message. This is the formatted messaged from the {@link Message#value()}. This is a required
+ * value defaulting to 0 which would be the first parameter.
+ *
+ * @return the index for the message parameter
+ */
+ int messageIndex() default 0;
+}
diff -Nru jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Suppressed.java jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Suppressed.java
--- jboss-logging-tools-2.0.2/annotations/src/main/java/org/jboss/logging/annotations/Suppressed.java 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/annotations/src/main/java/org/jboss/logging/annotations/Suppressed.java 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,45 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2016 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.PARAMETER;
+import static java.lang.annotation.RetentionPolicy.CLASS;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * Indicates the parameter should be added as a {@linkplain Throwable#addSuppressed(Throwable) suppressed} exception to
+ * the returned exception.
+ *
+ * The annotated parameter can be a single {@linkplain Throwable throwable type}, an array of
+ * {@linkplain Throwable throwable types} or a {@linkplain java.util.Collection collection} of
+ * {@linkplain Throwable throwable types}. Note this is only allowed on message bundle methods that return a
+ * {@linkplain Throwable throwable type}.
+ *
+ *
+ * @author James R. Perkins
+ */
+@Retention(CLASS)
+@Target(PARAMETER)
+@Documented
+public @interface Suppressed {
+}
diff -Nru jboss-logging-tools-2.0.2/annotations/src/main/resources/META-INF/LICENSE.txt jboss-logging-tools-2.1.0/annotations/src/main/resources/META-INF/LICENSE.txt
--- jboss-logging-tools-2.0.2/annotations/src/main/resources/META-INF/LICENSE.txt 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/annotations/src/main/resources/META-INF/LICENSE.txt 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ 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.
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/debian/changelog jboss-logging-tools-2.1.0/debian/changelog
--- jboss-logging-tools-2.0.2/debian/changelog 2016-11-21 08:07:40.000000000 +0000
+++ jboss-logging-tools-2.1.0/debian/changelog 2017-08-19 20:14:23.000000000 +0000
@@ -1,3 +1,13 @@
+jboss-logging-tools (2.1.0-1) unstable; urgency=medium
+
+ * New upstream version 2.1.0.
+ * Declare compliance with Debian Policy 4.0.1.
+ * Use https for Format field.
+ * Build-Depend on junit to work around a Maven tool chain issue.
+ * Use maven compile source and target 1.8.
+
+ -- Markus Koschany Sat, 19 Aug 2017 22:14:23 +0200
+
jboss-logging-tools (2.0.2-1) unstable; urgency=medium
* Team upload.
diff -Nru jboss-logging-tools-2.0.2/debian/control jboss-logging-tools-2.1.0/debian/control
--- jboss-logging-tools-2.0.2/debian/control 2016-11-21 08:00:45.000000000 +0000
+++ jboss-logging-tools-2.1.0/debian/control 2017-08-19 20:14:23.000000000 +0000
@@ -8,6 +8,7 @@
debhelper (>= 10),
default-jdk,
default-jdk-doc,
+ junit4,
libjboss-jdeparser2-java,
libjboss-logging-java,
libjboss-logmanager-java,
@@ -15,7 +16,7 @@
libmaven-javadoc-plugin-java,
maven-debian-helper (>= 1.5),
testng
-Standards-Version: 3.9.8
+Standards-Version: 4.0.1
Vcs-Git: https://anonscm.debian.org/git/pkg-java/jboss-logging-tools.git
Vcs-Browser: https://anonscm.debian.org/cgit/pkg-java/jboss-logging-tools.git
Homepage: https://github.com/jboss-logging/jboss-logging-tools
diff -Nru jboss-logging-tools-2.0.2/debian/copyright jboss-logging-tools-2.1.0/debian/copyright
--- jboss-logging-tools-2.0.2/debian/copyright 2016-11-21 08:00:45.000000000 +0000
+++ jboss-logging-tools-2.1.0/debian/copyright 2017-08-19 20:14:23.000000000 +0000
@@ -1,4 +1,4 @@
-Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: JBoss Logging Tools
Source: https://github.com/jboss-logging/jboss-logging-tools
@@ -11,7 +11,7 @@
License: Apache-2.0
Files: debian/*
-Copyright: 2015-2016, Markus Koschany
+Copyright: 2015-2017, Markus Koschany
License: Apache-2.0 or LGPL-2.1+
License: Apache-2.0
diff -Nru jboss-logging-tools-2.0.2/debian/maven.properties jboss-logging-tools-2.1.0/debian/maven.properties
--- jboss-logging-tools-2.0.2/debian/maven.properties 2016-11-21 08:00:45.000000000 +0000
+++ jboss-logging-tools-2.1.0/debian/maven.properties 2017-08-19 20:14:23.000000000 +0000
@@ -1,6 +1,6 @@
# Include here properties to pass to Maven during the build.
# For example:
maven.test.skip=true
-maven.compiler.source=1.7
-maven.compiler.target=1.7
+maven.compiler.source=1.8
+maven.compiler.target=1.8
diff -Nru jboss-logging-tools-2.0.2/debian/maven.rules jboss-logging-tools-2.1.0/debian/maven.rules
--- jboss-logging-tools-2.0.2/debian/maven.rules 2016-11-21 08:00:45.000000000 +0000
+++ jboss-logging-tools-2.1.0/debian/maven.rules 2017-08-19 20:14:23.000000000 +0000
@@ -6,3 +6,4 @@
org.jboss.logging jboss-logging jar s/.*/debian/ * *
org.jboss.logmanager jboss-logmanager jar s/.*/debian/ * *
org.testng testng jar s/6\..*/6.x/ * *
+junit junit jar s/4\..*/4.x/ * *
diff -Nru jboss-logging-tools-2.0.2/docs/apidocs/allclasses-frame.html jboss-logging-tools-2.1.0/docs/apidocs/allclasses-frame.html
--- jboss-logging-tools-2.0.2/docs/apidocs/allclasses-frame.html 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/apidocs/allclasses-frame.html 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+All Classes (JBoss Logging I18n Documentation 2.1.0.Final API)
+
+
+
+
+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
+
+
Package
+
Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+
+
Interfaces (italic)
+
Classes
+
Enums
+
Exceptions
+
Errors
+
Annotation Types
+
+
+
+
Class/Interface
+
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+
+
Class inheritance diagram
+
Direct Subclasses
+
All Known Subinterfaces
+
All Known Implementing Classes
+
Class/interface declaration
+
Class/interface description
+
+
+
Nested Class Summary
+
Field Summary
+
Constructor Summary
+
Method Summary
+
+
+
Field Detail
+
Constructor Detail
+
Method Detail
+
+
Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
+
Annotation Type
+
Each annotation type has its own separate page with the following sections:
+
+
Annotation Type declaration
+
Annotation Type description
+
Required Element Summary
+
Optional Element Summary
+
Element Detail
+
+
+
+
Enum
+
Each enum has its own separate page with the following sections:
+
+
Enum declaration
+
Enum description
+
Enum Constant Summary
+
Enum Constant Detail
+
+
+
+
Use
+
Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+
+
+
Tree (Class Hierarchy)
+
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
+
+
When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
+
When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+
+
+
+
Deprecated API
+
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+
+
+
Index
+
The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+
+
+
Prev/Next
+
These links take you to the next or previous class, interface, package, or related page.
+
+
+
Frames/No Frames
+
These links show and hide the HTML frames. All pages are available with or without frames.
+
+
+
All Classes
+
The All Classes link shows all classes and interfaces except non-static nested types.
+
+
+
Serialized Form
+
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
Messages on reports can have a link to a resolution document. This annotation can be used
+ to provide a base URL for these documents.
+
+ Expressions in the form of ${property.key:default-value} can be used for the values. If the property key is
+ prefixed with sys. a system property will be used. If the key is
+ prefixed with env. an environment variable will be used. In all other cases
+ the org.jboss.logging.tools.expressionProperties processor argument is used to specify the path the properties
+ file which contains the values for the expressions.
+
Indicate that a method parameter value should be applied to a field on the resultant exception object.
+
+ If this annotation is placed on a method the name attribute becomes a required parameter and one
+ default attribute needs to be set. The value of the default attribute is used to set the filed on the resultant
+ exception object.
+
Indicate that the given parameter should be wrapped with a formatting object of the given class. The class
+ must have a one-argument constructor which unambiguously accepts a value of this parameter's type. The resultant
+ object will be passed in as a parameter to the underlying format type; thus its toString()
+ method will be invoked (or, if the format style is PRINTF, the object may implement
+ Formattable to get extra functionality).
The length of the padding used for each id in the message bundle. For example given the default padding length
+ of 6 and a message with an id of 100 would result would be "000100".
+
+ Valid values a range of 3 to 8. Any value less than 0 turns off padding. Any other value will result in an error
+ being produced.
Specifies the locale for formatting bundle messages. This is only used in the super
+ implementation. Subclasses will define their own locale to use based on the name of the resource bundle at
+ compile time.
+
Returns an array containing the constants of this enum type, in
+the order they are declared. This method may be used to iterate
+over the constants as follows:
+
+for (Message.Format c : Message.Format.values())
+ System.out.println(c);
+
+
+
Returns:
+
an array containing the constants of this enum type, in the order they are declared
Returns the enum constant of this type with the specified name.
+The string must match exactly an identifier used to declare an
+enum constant in this type. (Extraneous whitespace characters are
+not permitted.)
+
+
Parameters:
+
name - the name of the enum constant to be returned.
+ Expressions in the form of ${property.key:default-value} can be used for the value. If the property key is
+ prefixed with sys. a system property will be used. If the key is
+ prefixed with env. an environment variable will be used. In all other cases
+ the org.jboss.logging.tools.expressionProperties processor argument is used to specify the path the properties
+ file which contains the values for the expressions.
+
Signify that an interface is a typed logger interface. A message logger interface may optionally extend other
+ message logger interfaces and message bundle interfaces (see MessageBundle, as
+ well as the BasicLogger interface.
The length of the padding used for each id in the message bundle. For example given the default padding length
+ of 6 and a message with an id of 100 would result would be "000100".
+
+ Valid values a range of 3 to 8. Any value less than 0 turns off padding. Any other value will result in an error
+ being produced.
Specifies the locale for formatting bundle messages. This is only used in the super
+ implementation. Subclasses will define their own locale to use based on the name of the resource bundle at
+ compile time.
+
+ Methods that use this annotation must be logger methods. Overloaded
+ methods also annotated with @Once will inherit the same check only logging the message from the first
+ overloaded method invoked.
+
Identifies a parameter is to be used for constructing an exception and excluded from the formatting of the message.
+
+ Parameters will be order-matched first, then type-matched to resolve ambiguity. If a match fails an error should
+ occur.
+
+ The value() option will allow an optional class to be specified which will have to match the exact type of
+ the parameter in question, to enable unambiguous resolution. The value must be the fully qualified class name.
Identifies a parameter has the ability to produce a Throwable or a super type of a Throwable. The
+ parameter type must be a Function or a BiFunction.
+
+ For a Function the input parameter must be a String which will be the message
+ associated with the method. The result type must Throwable or a super type of a Throwable.
+
+
+
+ For a BiFunction one of the input parameters must be a String which will be the
+ message associated with the method. The other input parameter must be a Throwable or a super type of a
+ Throwable and must be assignable from the parameter annotated with Cause. The result type must
+ Throwable or a super type of a Throwable.
+
+
+
+ Example
+
+
+ @Message("The operation failed due to %s")
+ T operationFailed(@Producer Function function, String op);
+
+ @Message("The operation failed due to %s")
+ T operationFailed(@Producer BiFunction function, @Cause Throwable cause, String op);
+
+
Indicate that a method parameter value should be applied to a property (with a setter method) on the resultant
+ exception object.
+
+ If this annotation is placed on a method the name attribute becomes a required parameter and one
+ default attribute needs to be set. The value of the default attribute is used to set the property on the resultant
+ exception object.
+
Allows a link to be created for messages on a report which contain a possible resolution to the issue reported . If
+ the method does not include an id no link will be created for the report unless a
+ path() is defined.
+
+
+ The rules for building the URL are as follows:
+
+
url: If left empty and the type is annotated with a BaseUrl the value for the
+ @BaseUrl will be used. If defined this will override the value of the BaseUrl. If neither are
+ defined the rules for the path() will be followed.
+
path: If defined this will be the path appended to the url() or the value of the
+ BaseUrl. Note that neither url() nor BaseUrl are required. If the value is left
+ undefined the id (project code plus the message id) will be used for the path.
+
suffix: The suffix to append to the path(). This is mostly useful if the path
+ is left undefined and a suffix should be appended to the messages id. If left undefined and the path()
+ is not defined, the suffix will be determined based on the report type.
+
+
+
+
+ If placed on a type links will be created for all methods on the type.
+
+
+
+ Do note that the processor does not validate the resolution document exists. It simply attempts to create links to
+ the resolution document.
+
+
+ Expressions in the form of ${property.key:default-value} can be used for the values with the exception of the
+ skip attribute. If the property key is prefixed with sys. a
+ system property will be used. If the key is prefixed with env. an
+ environment variable will be used. In all other cases the
+ org.jboss.logging.tools.expressionProperties processor argument is used to specify the path the properties
+ file which contains the values for the expressions.
+
The URL, fully qualified or relative, to use for the resolution document. If defined this will override the value
+ of the BaseUrl if the annotation is used.
The suffix to append to the path. If left undefined this will default to the extension for the report type. For
+ example if the report type is xml the default suffix would be .xml.
Specifies the exact signature to use when creating a Throwable return type.
+
+
+ Given the following exception and message bundle interface method the InvalidIntValueException(final RuntimeException cause, final String msg, final int value)
+ constructor would be used.
+
+
+
+ public class InvalidIntValueException extends RuntimeException {
+ private final RuntimeException causeAsRuntime;
+ private final int value;
+ public InvalidIntValueException(final Throwable cause, final String msg, final int value) {
+ super(msg, cause);
+ causeAsRuntime = new RuntimeException(cause);
+ this.value = value;
+ }
+
+ public InvalidIntValueException(final RuntimeException cause, final String msg, final int value) {
+ super(msg, cause);
+ causeAsRuntime = cause;
+ this.value = value;
+ }
+ public InvalidIntValueException(final RuntimeException cause, final String msg, final Integer value) {
+ super(msg, cause);
+ causeAsRuntime = cause;
+ this.value = value;
+ }
+ }
+
+
+
+
+
+ @Message("Invalid value %d")
+ @Signature(causeIndex = 0, messageIndex = 1, value = {RuntimeException.class, String.class, int.class}
+ InvalidIntValueException invalidValue(@Cause RuntimeException cause, @Param int value);
+
The index for the cause of the exception being created. A value of less than zero assumes
+ there is no cause parameter in the constructor. A Cause annotation can still be used and the
+ Throwable.initCause(Throwable) will be used to initialize the cause of the exception.
The index for the message. This is the formatted messaged from the Message.value(). This is a required
+ value defaulting to 0 which would be the first parameter.
Returns an array containing the constants of this enum type, in
+the order they are declared. This method may be used to iterate
+over the constants as follows:
+
+for (Transform.TransformType c : Transform.TransformType.values())
+ System.out.println(c);
+
+
+
Returns:
+
an array containing the constants of this enum type, in the order they are declared
Returns the enum constant of this type with the specified name.
+The string must match exactly an identifier used to declare an
+enum constant in this type. (Extraneous whitespace characters are
+not permitted.)
+
+
Parameters:
+
name - the name of the enum constant to be returned.
Sets a range of valid id's allowed on the message id. Both Message.INHERIT and Message.NONE are ignored when validating.
+
+ Note: Message id's from inherited interfaces are not validated within the range provided. Super interfaces
+ would need their own annotation for range validation.
+
+
+
This error indicates an invalid encoding is attempting to be used and a default encoding of UTF-8 will be used. You can
+fix this by setting a valid encoding value.
+
+
+
+
+
+
+
+
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/examples.html jboss-logging-tools-2.1.0/docs/examples.html
--- jboss-logging-tools-2.0.2/docs/examples.html 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/examples.html 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,622 @@
+
+
+
+
+
+
+
+Example Use Cases
+
+
+
+
+
+
+
+
+
+
+
Example Use Cases
+
+
+
Below are some example use case snippets from the examples.
+
+
+
+
/**
+ * Writes the value of the object to the file.
+ *
+ * @param value the value to write, cannot be {@code null}
+ *
+ * @throws UncheckedIOException if an error occurs writing the data
+ */
+publicvoid write(finalObject value) {
+ AppLogger.LOGGER.appVersion("ContentWriter", 1, 0, 0, "Beta1"); (1)
+ Objects.requireNonNull(value, ErrorMessages.MESSAGES.nullParam("value")); (2)
+ write(Objects.requireNonNull(value, ErrorMessages.MESSAGES.nullParam("value")).toString());
+}
+
+/**
+ * Writes the value to the file.
+ *
+ * @param value the value to write, cannot be {@code null} or an {@linkplain String#isEmpty() empty string}.
+ *
+ * @throws UncheckedIOException if an error occurs writing the data
+ */
+publicvoid write(finalString value) {
+ AppLogger.LOGGER.appVersion("ContentWriter", 1, 0, 0, "Beta1");
+ if (Objects.requireNonNull(value, ErrorMessages.MESSAGES.nullParam("value")).isEmpty()) {
+ throw ErrorMessages.MESSAGES.invalidValue(value); (3)
+ }
+ try {
+ synchronized (outputLock) {
+ writer.write(value);
+ writer.newLine();
+ if (autoFlush) {
+ flush();
+ }
+ }
+ } catch (IOException e) {
+ throw ErrorMessages.MESSAGES.operationFailed(UncheckedIOException::new, e, "write"); (4)
+ }
+}
+
+@Override
+publicvoid close() {
+ try {
+ synchronized (outputLock) {
+ writer.close();
+ }
+ AppLogger.LOGGER.tracef("ContentWriter %s was successfully closed.", this);
+ } catch (Exception e) {
+ throw ErrorMessages.MESSAGES.closeFailure(e, this);
+ }
+}
+
+/**
+ * Safely close this writer logging any errors that occur during closing.
+ */
+publicvoid safeClose() {
+ try {
+ synchronized (outputLock) {
+ writer.close();
+ }
+ AppLogger.LOGGER.tracef("ContentWriter %s was successfully closed.", this);
+ } catch (Exception e) {
+ AppLogger.LOGGER.closeFailure(e, this); (5)
+ }
+}
+
+
+
+
+
+
1
+
Logs the application version. Note this uses the @Once annotation to indicate this should only be logged once regardless of which write method is used.
+
+
+
2
+
The ErrorMessages.nullParam() returns a java.lang.function.Supplier. This allows the message to be lazily formatted only if the value is null.
+
+
+
3
+
Throws a message if the value is an empty string.
+
+
+
4
+
Uses a java.lang.function.BiFunction to create a new UncheckedIOException with the caught exception set as the cause.
+
+
+
5
+
Logs the caught exception instead of throwing a new exception.
+Expressions are in the form of ${key:defaultValue}. If the key is prefixed with sys. a system property is
+used. If the key is prefixed with env. an environment variable is used. In all other cases the properties are resolved
+from the org.jboss.logging.tools.expressionProperties path. If the key is not found in the properties the default
+value will be used.
+
+
+
+
+
+
+
+
+
+
+
+Expressions are processed at compile time. The values will be hard-coded in the generated source files.
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/getting-started.html jboss-logging-tools-2.1.0/docs/getting-started.html
--- jboss-logging-tools-2.0.2/docs/getting-started.html 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/getting-started.html 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,588 @@
+
+
+
+
+
+
+
+Getting Started
+
+
+
+
+
+
+
+
+
+
+
Getting Started
+
+
+
To get started you need to include three dependencies in your project.
If you’re using maven here is an example pom.xml snippet:
+
+
+
+
<dependencies>
+ <!-- Required by the annotation processor and will be used at runtime -->
+ <dependency>
+ <groupId>org.jboss.logging</groupId>
+ <artifactId>jboss-logging</artifactId>
+ </dependency>
+
+ <dependency>
+ <groupId>org.jboss.logging</groupId>
+ <artifactId>jboss-logging-annotations</artifactId>
+ <version>2.1.0.Final</version>
+ <!-- This is a compile-time dependency of this project, but is not needed at compile or runtime by other
+ projects that depend on this project.-->
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+
+ <dependency>
+ <groupId>org.jboss.logging</groupId>
+ <artifactId>jboss-logging-processor</artifactId>
+ <version>2.1.0.Final</version>
+ <!-- This is a compile-time dependency of this project, but is not needed at compile or runtime by other
+ projects that depend on this project.-->
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+</dependencies>
If you’re using maven here is an example pom.xml snippet:
+
+
+
+
<dependencies>
+ <!-- Required by the annotation processor and will be used at runtime -->
+ <dependency>
+ <groupId>org.jboss.logging</groupId>
+ <artifactId>jboss-logging</artifactId>
+ </dependency>
+
+ <dependency>
+ <groupId>org.jboss.logging</groupId>
+ <artifactId>jboss-logging-annotations</artifactId>
+ <version>2.1.0.Final</version>
+ <!-- This is a compile-time dependency of this project, but is not needed at compile or runtime by other
+ projects that depend on this project.-->
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+
+ <dependency>
+ <groupId>org.jboss.logging</groupId>
+ <artifactId>jboss-logging-processor</artifactId>
+ <version>2.1.0.Final</version>
+ <!-- This is a compile-time dependency of this project, but is not needed at compile or runtime by other
+ projects that depend on this project.-->
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+</dependencies>
Message bundle interfaces provide a way to internationalize exceptions or strings. A message bundle interface is
+annotated with @MessageBundle. Each method in must be annotated with @Message
+which will be used to determine the String used for either the return type or the message for the exception being
+returned.
+
+
+
The value for a @Message may contain an expression.
+
+
+
+
+
+
+
+
+Expressions are in the form of ${key:defaultValue}. If the key is prefixed with sys. a system property is
+used. If the key is prefixed with env. an environment variable is used. In all other cases the properties are resolved
+from the org.jboss.logging.tools.expressionProperties path. If the key is not found in the properties the default
+value will be used.
+
+
+
+
+
+
+
+
+
+
+
+Expressions are processed at compile time. The values will be hard-coded in the generated source files.
+
+
+
+
+
+
The following constraints are placed on methods in a message bundle:
+
+
+
+
+
The return type must be one of the follow
+
+
+
+
A java.lang.String
+
+
+
A java.lang.Throwable or a subtype of java.lang.Throwable
+
+
+
A java.lang.function.Supplier who’s return type fits one of the other two constraints above.
+
+
+
+
+
+
The method must be annotated with @Message or a message must be inheritable.
The projectCode will be prepended to messages which have an id specified. For example with id = 1 the message will be prepended with CW000001. You can control the number padding with the length property on the annotation.
+
+
+
2
+
No id is specified for this message which means no id will be prepended on this message.
+
+
+
3
+
The @Param annotation tells the generator that the parameter should be used to construct the CloseException. The @Pos(1) annotation indicates the parameter should also be used when formatting the message.
+
+
+
4
+
The @Producer annotation indicates that the Function should be used to create the exception being returned.
Logger interfaces provide a way to internationalize log messages. A logger interface is an interface annotated with
+@MessageLogger. Each method in must be annotated with @Message which will
+be used to determine the message to be logged.
+
+
+
The value for a @Message may contain an expression.
+
+
+
+
+
+
+
+
+Expressions are in the form of ${key:defaultValue}. If the key is prefixed with sys. a system property is
+used. If the key is prefixed with env. an environment variable is used. In all other cases the properties are resolved
+from the org.jboss.logging.tools.expressionProperties path. If the key is not found in the properties the default
+value will be used.
+
+
+
+
+
+
+
+
+
+
+
+Expressions are processed at compile time. The values will be hard-coded in the generated source files.
+
+
+
+
+
+
The following constraints are placed on methods in a message logger:
+A message is inheritable if the two methods have the same name and same number of format parameters.
+
+
+
+
+
+
+
+
+
+
+
+A format parameter is a parameter that has no annotations or is annotated with one of the following annotations; @FormatWith, @Pos or @Transform.
+
+
+
+
+
+
A message logger interface may also extend the org.jboss.logging.BasicLogger. This allows the logging interface to be usable for standard logging. For example AppLogger.LOGGER.debugf("Initializing %s", this);
+
+
+
Example Message Logger
+
+
+
@MessageLogger(projectCode = "CW") (1)
+publicinterfaceAppLoggerextends BasicLogger {
+
+ AppLogger LOGGER = Logger.getMessageLogger(AppLogger.class, AppLogger.class.getPackage().getName());
+
+ @LogMessage
+ @Once(2)
+ @Message("%s version %d.%d.%d.%s") (3)
+ void appVersion(CharSequence name, int major, int minor, int macro, String rel);
+
+ @LogMessage(level = Logger.Level.ERROR) (4)
+ @Message(id = 100, value = "Failure while closing %s")
+ void closeFailure(@CauseThrowable cause, Object obj);
+
+ @LogMessage(level = Logger.Level.WARN)
+ @Message(id = 101, value = "Encoding %s could not be found. Defaulting to %s.")
+ void encodingNotFound(String encoding, Charset dft);
+
+ @LogMessage
+ @Message(id = 102, value = "Cache size changed to '%d'")
+ void cacheSizeChanged(@Transform(Transform.TransformType.SIZE) Collection<String> c);
+
+ @LogMessage
+ void cacheSizeChanged(@Transform(Transform.TransformType.SIZE) String... array);
+
+ @LogMessage
+ void cacheSizeChanged(@Transform(Transform.TransformType.SIZE) Map<String, Object> map);
+}
+
+
+
+
+
+
1
+
The projectCode will be prepended to messages which have an id specified. For example with id = 100 the message will be prepended with CW000100. You can control the number padding with the length property on the annotation.
+
+
+
2
+
Ensures the log message is only written once.
+
+
+
3
+
No id is specified for this message which means no id will be prepended on this message.
+
+
+
4
+
Overrides the default level to ERROR to indicate an error message should be logged.
+
+
+
+
+
+
+
+
Reports
+
+
+
There are currently two types of reports that can be generated. The options are adoc or asciidoc for asciidoc and xml for XML.
+
+
+
The reports contain the following data:
+
+
+
+
+
The formatted message id.
+
+
+
A possible link to a resolution document for the error.
+
+
+
The unformatted message.
+
+
+
The log level, if applicable.
+
+
+
The return type, if applicable.
+
+
+
+
+
Annotations
+
+
Two annotations can be used to assist withing linking resolution documents for messages.
This annotation can be used on a type to define the base URL for linking resolution documents. This annotation is
+not required for links to be created on reports.
This annotation is used to define information about the resolution document for creating links. If placed on an
+interface all methods that have a defined id will have a link generated. This can also be placed individually on
+the method to only generate links for specific id’s.
+
+
+
+
+
+
+
+
+
+
+
Example Use Cases
+
+
+
Below are some example use case snippets from the examples.
+
+
+
+
/**
+ * Writes the value of the object to the file.
+ *
+ * @param value the value to write, cannot be {@code null}
+ *
+ * @throws UncheckedIOException if an error occurs writing the data
+ */
+publicvoid write(finalObject value) {
+ AppLogger.LOGGER.appVersion("ContentWriter", 1, 0, 0, "Beta1"); (1)
+ Objects.requireNonNull(value, ErrorMessages.MESSAGES.nullParam("value")); (2)
+ write(Objects.requireNonNull(value, ErrorMessages.MESSAGES.nullParam("value")).toString());
+}
+
+/**
+ * Writes the value to the file.
+ *
+ * @param value the value to write, cannot be {@code null} or an {@linkplain String#isEmpty() empty string}.
+ *
+ * @throws UncheckedIOException if an error occurs writing the data
+ */
+publicvoid write(finalString value) {
+ AppLogger.LOGGER.appVersion("ContentWriter", 1, 0, 0, "Beta1");
+ if (Objects.requireNonNull(value, ErrorMessages.MESSAGES.nullParam("value")).isEmpty()) {
+ throw ErrorMessages.MESSAGES.invalidValue(value); (3)
+ }
+ try {
+ synchronized (outputLock) {
+ writer.write(value);
+ writer.newLine();
+ if (autoFlush) {
+ flush();
+ }
+ }
+ } catch (IOException e) {
+ throw ErrorMessages.MESSAGES.operationFailed(UncheckedIOException::new, e, "write"); (4)
+ }
+}
+
+@Override
+publicvoid close() {
+ try {
+ synchronized (outputLock) {
+ writer.close();
+ }
+ AppLogger.LOGGER.tracef("ContentWriter %s was successfully closed.", this);
+ } catch (Exception e) {
+ throw ErrorMessages.MESSAGES.closeFailure(e, this);
+ }
+}
+
+/**
+ * Safely close this writer logging any errors that occur during closing.
+ */
+publicvoid safeClose() {
+ try {
+ synchronized (outputLock) {
+ writer.close();
+ }
+ AppLogger.LOGGER.tracef("ContentWriter %s was successfully closed.", this);
+ } catch (Exception e) {
+ AppLogger.LOGGER.closeFailure(e, this); (5)
+ }
+}
+
+
+
+
+
+
1
+
Logs the application version. Note this uses the @Once annotation to indicate this should only be logged once regardless of which write method is used.
+
+
+
2
+
The ErrorMessages.nullParam() returns a java.lang.function.Supplier. This allows the message to be lazily formatted only if the value is null.
+
+
+
3
+
Throws a message if the value is an empty string.
+
+
+
4
+
Uses a java.lang.function.BiFunction to create a new UncheckedIOException with the caught exception set as the cause.
+
+
+
5
+
Logs the caught exception instead of throwing a new exception.
+
+
+
+
+
+
+
Translation Property Files
+
+
+
The translation properties files must exist in the same directory structure as the interface. The name of the properties file InterfaceName.i18n_language_country_variant.properties. For example if you have a class named org.jboss.logging.tools.examples.ErrorMessages and you want to translate this into French you create a properties file called ErrorMessages.i18n_fr.properties in a directory org/jboss/logging/tools/examples.
+
+
+
+
+
Annotation Processor Options
+
+
+
You can pass options to an annotation processor with the -A compiler option. For example to disable generating the @Generated annotation from being placed on the generated source files you would pass -Aorg.jboss.logging.tools.addGeneratedAnnotation=false to the compiler command.
+
+
+
General
+
+
+
+
+
+
+
+
Option
+
Description
+
+
+
+
+
debug
+
This option turns on debug logging for the processor
+
+
+
org.jboss.logging.tools.expressionProperties
+
This option allows you to define a path where, at compile-time, expressions in messages can be resolved.
+
+
+
org.jboss.logging.tools.addGeneratedAnnotation
+
If set to false the @Generated annotation will not be placed on the generated source files. The default is true.
+
+
+
+
+
+
+
+
+
+
+In Java 9 the @javax.annotation.Generated was moved to @javax.annotation.processor.Generated. The processor attempts to determine which annotation to use by attempting to find the @javax.annotation.Generated first. If it fails the @javax.annotation.processor.Generated is attempted. If neither can be found no annotation will be placed on the generated implementations.
+
+
+
+
+
+
+
+
+
+
+
+Expressions are in the form of ${key:defaultValue}. If the key is prefixed with sys. a system property is
+used. If the key is prefixed with env. an environment variable is used. In all other cases the properties are resolved
+from the org.jboss.logging.tools.expressionProperties path. If the key is not found in the properties the default
+value will be used.
+
+
+
+
+
+
+
+
+
+
+
+Expressions are processed at compile time. The values will be hard-coded in the generated source files.
+
+
+
+
+
+
+
Translation Options
+
+
+
+
+
+
+
+
Option
+
Description
+
+
+
+
+
translationsFilesPath
+
The base path for the translated properties files. This defaults to the location where new class files are placed.
+
+
+
skipTranslations
+
If set to true source files with the translated tet will not be generated. The default is false.
+
+
+
generatedTranslationFilesPath
+
If defined this indicates the path a skeleton file should be generated for the interface. The generated skeleton file will be placed in a directory that matches the package with a name that matches the interface with a .i18n_locale_COUNTRY_VARIANT.properties suffix.
+
+
+
org.jboss.logging.tools.level
+
Sets the maximum level to include in the generated skeleton files. For example if set to INFO the skeleton files will not contain any properties where the log level was set to DEBUG or TRACE.
+
+
+
+
+
+
Report Options
+
+
+
+
+
+
+
+
Option
+
Description
+
+
+
+
+
org.jboss.logging.tools.report.type
+
Indicates the type of report that should be generated. The current report types are adoc for asciidoc or xml for XML.
+
+
+
org.jboss.logging.tools.report.path
+
The path where the generated reports should be placed. This defaults to the location where new class files are placed.
+
+
+
org.jboss.logging.tools.report.title
+
An optional title for the report. For asciidoc this defaults to Messages. For XML the <title> element is left off.
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/js/links.js jboss-logging-tools-2.1.0/docs/js/links.js
--- jboss-logging-tools-2.0.2/docs/js/links.js 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/js/links.js 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,9 @@
+function annotationLinks() {
+ var links = document.getElementsByTagName("a");
+ for(var i = 0, max = links.length; i < max; i++) {
+ var l = links[i];
+ if (l.text.startsWith("@")) {
+ l.href = l.href + "/org/jboss/logging/annotations/" + l.text.substring(1) + ".html";
+ }
+ }
+}
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/message-bundle.html jboss-logging-tools-2.1.0/docs/message-bundle.html
--- jboss-logging-tools-2.0.2/docs/message-bundle.html 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/message-bundle.html 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,682 @@
+
+
+
+
+
+
+
+Message Bundle Interfaces
+
+
+
+
+
+
+
+
+
+
+
Message Bundle Interfaces
+
+
+
Message bundle interfaces provide a way to internationalize exceptions or strings. A message bundle interface is
+annotated with @MessageBundle. Each method in must be annotated with @Message
+which will be used to determine the String used for either the return type or the message for the exception being
+returned.
+
+
+
The value for a @Message may contain an expression.
+
+
+
+
+
+
+
+
+Expressions are in the form of ${key:defaultValue}. If the key is prefixed with sys. a system property is
+used. If the key is prefixed with env. an environment variable is used. In all other cases the properties are resolved
+from the org.jboss.logging.tools.expressionProperties path. If the key is not found in the properties the default
+value will be used.
+
+
+
+
+
+
+
+
+
+
+
+Expressions are processed at compile time. The values will be hard-coded in the generated source files.
+
+
+
+
+
+
The following constraints are placed on methods in a message bundle:
+
+
+
+
+
The return type must be one of the follow
+
+
+
+
A java.lang.String
+
+
+
A java.lang.Throwable or a subtype of java.lang.Throwable
+
+
+
A java.lang.function.Supplier who’s return type fits one of the other two constraints above.
+
+
+
+
+
+
The method must be annotated with @Message or a message must be inheritable.
The projectCode will be prepended to messages which have an id specified. For example with id = 1 the message will be prepended with CW000001. You can control the number padding with the length property on the annotation.
+
+
+
2
+
No id is specified for this message which means no id will be prepended on this message.
+
+
+
3
+
The @Param annotation tells the generator that the parameter should be used to construct the CloseException. The @Pos(1) annotation indicates the parameter should also be used when formatting the message.
+
+
+
4
+
The @Producer annotation indicates that the Function should be used to create the exception being returned.
Logger interfaces provide a way to internationalize log messages. A logger interface is an interface annotated with
+@MessageLogger. Each method in must be annotated with @Message which will
+be used to determine the message to be logged.
+
+
+
The value for a @Message may contain an expression.
+
+
+
+
+
+
+
+
+Expressions are in the form of ${key:defaultValue}. If the key is prefixed with sys. a system property is
+used. If the key is prefixed with env. an environment variable is used. In all other cases the properties are resolved
+from the org.jboss.logging.tools.expressionProperties path. If the key is not found in the properties the default
+value will be used.
+
+
+
+
+
+
+
+
+
+
+
+Expressions are processed at compile time. The values will be hard-coded in the generated source files.
+
+
+
+
+
+
The following constraints are placed on methods in a message logger:
+A message is inheritable if the two methods have the same name and same number of format parameters.
+
+
+
+
+
+
+
+
+
+
+
+A format parameter is a parameter that has no annotations or is annotated with one of the following annotations; @FormatWith, @Pos or @Transform.
+
+
+
+
+
+
A message logger interface may also extend the org.jboss.logging.BasicLogger. This allows the logging interface to be usable for standard logging. For example AppLogger.LOGGER.debugf("Initializing %s", this);
+
+
+
Example Message Logger
+
+
+
@MessageLogger(projectCode = "CW") (1)
+publicinterfaceAppLoggerextends BasicLogger {
+
+ AppLogger LOGGER = Logger.getMessageLogger(AppLogger.class, AppLogger.class.getPackage().getName());
+
+ @LogMessage
+ @Once(2)
+ @Message("%s version %d.%d.%d.%s") (3)
+ void appVersion(CharSequence name, int major, int minor, int macro, String rel);
+
+ @LogMessage(level = Logger.Level.ERROR) (4)
+ @Message(id = 100, value = "Failure while closing %s")
+ void closeFailure(@CauseThrowable cause, Object obj);
+
+ @LogMessage(level = Logger.Level.WARN)
+ @Message(id = 101, value = "Encoding %s could not be found. Defaulting to %s.")
+ void encodingNotFound(String encoding, Charset dft);
+
+ @LogMessage
+ @Message(id = 102, value = "Cache size changed to '%d'")
+ void cacheSizeChanged(@Transform(Transform.TransformType.SIZE) Collection<String> c);
+
+ @LogMessage
+ void cacheSizeChanged(@Transform(Transform.TransformType.SIZE) String... array);
+
+ @LogMessage
+ void cacheSizeChanged(@Transform(Transform.TransformType.SIZE) Map<String, Object> map);
+}
+
+
+
+
+
+
1
+
The projectCode will be prepended to messages which have an id specified. For example with id = 100 the message will be prepended with CW000100. You can control the number padding with the length property on the annotation.
+
+
+
2
+
Ensures the log message is only written once.
+
+
+
3
+
No id is specified for this message which means no id will be prepended on this message.
+
+
+
4
+
Overrides the default level to ERROR to indicate an error message should be logged.
You can pass options to an annotation processor with the -A compiler option. For example to disable generating the @Generated annotation from being placed on the generated source files you would pass -Aorg.jboss.logging.tools.addGeneratedAnnotation=false to the compiler command.
+
+
+
General
+
+
+
+
+
+
+
+
Option
+
Description
+
+
+
+
+
debug
+
This option turns on debug logging for the processor
+
+
+
org.jboss.logging.tools.expressionProperties
+
This option allows you to define a path where, at compile-time, expressions in messages can be resolved.
+
+
+
org.jboss.logging.tools.addGeneratedAnnotation
+
If set to false the @Generated annotation will not be placed on the generated source files. The default is true.
+
+
+
+
+
+
+
+
+
+
+In Java 9 the @javax.annotation.Generated was moved to @javax.annotation.processor.Generated. The processor attempts to determine which annotation to use by attempting to find the @javax.annotation.Generated first. If it fails the @javax.annotation.processor.Generated is attempted. If neither can be found no annotation will be placed on the generated implementations.
+
+
+
+
+
+
+
+
+
+
+
+Expressions are in the form of ${key:defaultValue}. If the key is prefixed with sys. a system property is
+used. If the key is prefixed with env. an environment variable is used. In all other cases the properties are resolved
+from the org.jboss.logging.tools.expressionProperties path. If the key is not found in the properties the default
+value will be used.
+
+
+
+
+
+
+
+
+
+
+
+Expressions are processed at compile time. The values will be hard-coded in the generated source files.
+
+
+
+
+
+
+
Translation Options
+
+
+
+
+
+
+
+
Option
+
Description
+
+
+
+
+
translationsFilesPath
+
The base path for the translated properties files. This defaults to the location where new class files are placed.
+
+
+
skipTranslations
+
If set to true source files with the translated tet will not be generated. The default is false.
+
+
+
generatedTranslationFilesPath
+
If defined this indicates the path a skeleton file should be generated for the interface. The generated skeleton file will be placed in a directory that matches the package with a name that matches the interface with a .i18n_locale_COUNTRY_VARIANT.properties suffix.
+
+
+
org.jboss.logging.tools.level
+
Sets the maximum level to include in the generated skeleton files. For example if set to INFO the skeleton files will not contain any properties where the log level was set to DEBUG or TRACE.
+
+
+
+
+
+
Report Options
+
+
+
+
+
+
+
+
Option
+
Description
+
+
+
+
+
org.jboss.logging.tools.report.type
+
Indicates the type of report that should be generated. The current report types are adoc for asciidoc or xml for XML.
+
+
+
org.jboss.logging.tools.report.path
+
The path where the generated reports should be placed. This defaults to the location where new class files are placed.
+
+
+
org.jboss.logging.tools.report.title
+
An optional title for the report. For asciidoc this defaults to Messages. For XML the <title> element is left off.
This annotation can be used on a type to define the base URL for linking resolution documents. This annotation is
+not required for links to be created on reports.
This annotation is used to define information about the resolution document for creating links. If placed on an
+interface all methods that have a defined id will have a link generated. This can also be placed individually on
+the method to only generate links for specific id’s.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/asciidoc/default-notes.adoc jboss-logging-tools-2.1.0/docs/src/main/asciidoc/default-notes.adoc
--- jboss-logging-tools-2.0.2/docs/src/main/asciidoc/default-notes.adoc 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/asciidoc/default-notes.adoc 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,3 @@
+NOTE: A message is inheritable if the two methods have the same name and same number of format parameters.
+
+NOTE: A format parameter is a parameter that has no annotations or is annotated with one of the following annotations; link:{javadocsdir}[`@FormatWith`], link:{javadocsdir}[`@Pos`] or link:{javadocsdir}[`@Transform`].
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/asciidoc/docinfo-footer.html jboss-logging-tools-2.1.0/docs/src/main/asciidoc/docinfo-footer.html
--- jboss-logging-tools-2.0.2/docs/src/main/asciidoc/docinfo-footer.html 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/asciidoc/docinfo-footer.html 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,4 @@
+
+
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/asciidoc/examples/errors/CW000003.adoc jboss-logging-tools-2.1.0/docs/src/main/asciidoc/examples/errors/CW000003.adoc
--- jboss-logging-tools-2.0.2/docs/src/main/asciidoc/examples/errors/CW000003.adoc 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/asciidoc/examples/errors/CW000003.adoc 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,4 @@
+== CW000003: Null Parameter
+
+This error indicates you've passed a `null` parameter where a `non-null` value
+is required.
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/asciidoc/examples/errors/CW000100.adoc jboss-logging-tools-2.1.0/docs/src/main/asciidoc/examples/errors/CW000100.adoc
--- jboss-logging-tools-2.0.2/docs/src/main/asciidoc/examples/errors/CW000100.adoc 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/asciidoc/examples/errors/CW000100.adoc 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,4 @@
+== CW000100: Close Failure
+
+This error indicates there was a failure closing a resource. Please see previous error messages and contact support if
+required.
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/asciidoc/examples/errors/CW000101.adoc jboss-logging-tools-2.1.0/docs/src/main/asciidoc/examples/errors/CW000101.adoc
--- jboss-logging-tools-2.0.2/docs/src/main/asciidoc/examples/errors/CW000101.adoc 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/asciidoc/examples/errors/CW000101.adoc 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,4 @@
+== CW000101: Encoding Error
+
+This error indicates an invalid encoding is attempting to be used and a default encoding of UTF-8 will be used. You can
+fix this by setting a valid encoding value.
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/asciidoc/examples.adoc jboss-logging-tools-2.1.0/docs/src/main/asciidoc/examples.adoc
--- jboss-logging-tools-2.0.2/docs/src/main/asciidoc/examples.adoc 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/asciidoc/examples.adoc 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,17 @@
+
+:sourcedir: java/org/jboss/logging/tools/examples
+:projecturl: https://github.com/jboss-logging/jboss-logging-tools/docs/src/main
+
+== Example Use Cases
+
+Below are some example use case snippets from the link:{projecturl}/{sourcedir}[examples].
+
+[source,java,indent=0]
+----
+include::../{sourcedir}/ContentWriter.java[tags=write;close]
+----
+<1> Logs the application version. Note this uses the link:{javadocsdir}[@Once] annotation to indicate this should only be logged once regardless of which `write` method is used.
+<2> The `ErrorMessages.nullParam()` returns a `java.lang.function.Supplier`. This allows the message to be lazily formatted only if the `value` is `null`.
+<3> Throws a message if the `value` is an empty string.
+<4> Uses a `java.lang.function.BiFunction` to create a new `UncheckedIOException` with the caught exception set as the cause.
+<5> Logs the caught exception instead of throwing a new exception.
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/asciidoc/expressions.adoc jboss-logging-tools-2.1.0/docs/src/main/asciidoc/expressions.adoc
--- jboss-logging-tools-2.0.2/docs/src/main/asciidoc/expressions.adoc 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/asciidoc/expressions.adoc 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,7 @@
+
+NOTE: Expressions are in the form of `${key:defaultValue}`. If the key is prefixed with `sys.` a system property is
+used. If the key is prefixed with `env.` an environment variable is used. In all other cases the properties are resolved
+from the `org.jboss.logging.tools.expressionProperties` path. If the key is not found in the properties the default
+value will be used.
+
+IMPORTANT: Expressions are processed at compile time. The values will be hard-coded in the generated source files.
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/asciidoc/getting-started.adoc jboss-logging-tools-2.1.0/docs/src/main/asciidoc/getting-started.adoc
--- jboss-logging-tools-2.0.2/docs/src/main/asciidoc/getting-started.adoc 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/asciidoc/getting-started.adoc 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,47 @@
+:repourl: https://repository.jboss.org/org/jboss/logging
+
+== Getting Started
+
+To get started you need to include three dependencies in your project.
+
+[frame=none,grid=none,options="noheader"]
+|===
+| link:{repourl}/jboss-logging/[JBoss Logging] | Required at compile time and runtime.
+| link:{repourl}/jboss-logging-annotations/[JBoss Logging Annotations] | Required at compile time only.
+| link:{repourl}/jboss-logging-processor/[JBoss Logging Processor] | Required at compile time only.
+|===
+
+If you're using maven here is an example `pom.xml` snippet:
+
+[source,xml,subs="attributes+"]
+----
+
+
+
+ org.jboss.logging
+ jboss-logging
+
+
+
+ org.jboss.logging
+ jboss-logging-annotations
+ {version}
+
+ provided
+ true
+
+
+
+ org.jboss.logging
+ jboss-logging-processor
+ {version}
+
+ provided
+ true
+
+
+----
+
+Once your project is configured you can create either a <> or a <>. For detailed information see the link:{javadocsdir}/index.html[JavaDocs] for the annotations.
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/asciidoc/index.adoc jboss-logging-tools-2.1.0/docs/src/main/asciidoc/index.adoc
--- jboss-logging-tools-2.0.2/docs/src/main/asciidoc/index.adoc 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/asciidoc/index.adoc 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,24 @@
+= JBoss Logging Tools
+:Author: James R. Perkins
+:Email:
+:docinfo: shared
+:toc: left
+:scriptsdir: ./js
+
+== Introduction
+
+The JBoss logging tools are used to create internationalized log statements and exceptions.
+
+include::getting-started.adoc[]
+
+include::message-bundle.adoc[]
+
+include::message-logger.adoc[]
+
+include::reports.adoc[]
+
+include::examples.adoc[]
+
+include::translation-property-files.adoc[]
+
+include::processor-options.adoc[]
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/asciidoc/js/links.js jboss-logging-tools-2.1.0/docs/src/main/asciidoc/js/links.js
--- jboss-logging-tools-2.0.2/docs/src/main/asciidoc/js/links.js 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/asciidoc/js/links.js 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,9 @@
+function annotationLinks() {
+ var links = document.getElementsByTagName("a");
+ for(var i = 0, max = links.length; i < max; i++) {
+ var l = links[i];
+ if (l.text.startsWith("@")) {
+ l.href = l.href + "/org/jboss/logging/annotations/" + l.text.substring(1) + ".html";
+ }
+ }
+}
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/asciidoc/message-bundle.adoc jboss-logging-tools-2.1.0/docs/src/main/asciidoc/message-bundle.adoc
--- jboss-logging-tools-2.0.2/docs/src/main/asciidoc/message-bundle.adoc 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/asciidoc/message-bundle.adoc 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,58 @@
+
+== Message Bundle Interfaces
+
+Message bundle interfaces provide a way to internationalize exceptions or strings. A message bundle interface is
+annotated with link:{javadocsdir}[`@MessageBundle`]. Each method in must be annotated with link:{javadocsdir}[`@Message`]
+which will be used to determine the String used for either the return type or the message for the exception being
+returned.
+
+The value for a link:{javadocsdir}[`@Message`] may contain an expression.
+
+include::expressions.adoc[]
+
+The following constraints are placed on methods in a message bundle:
+
+- The return type must be one of the follow
+ * A `java.lang.String`
+ * A `java.lang.Throwable` or a subtype of `java.lang.Throwable`
+ * A `java.lang.function.Supplier` who's return type fits one of the other two constraints above.
+- The method must be annotated with link:{javadocsdir}[`@Message`] or a message must be inheritable.
+- A method can have only one link:{javadocsdir}[`@Cause`] parameter.
+- A method can only have one link:{javadocsdir}[`@Producer`] parameter.
+
+include::default-notes.adoc[]
+
+=== Example Message Bundle
+
+[source,java]
+----
+@MessageBundle(projectCode = "CW") <1>
+public interface ErrorMessages {
+ ErrorMessages MESSAGES = Messages.getBundle(ErrorMessages.class);
+
+ @Message("Version %d.%d.%d.%s") <2>
+ String version(int major, int minor, int macro, String rel);
+
+ @Message(id = 1, value = "Value '%s' is invalid")
+ IllegalArgumentException invalidValue(Object value);
+
+ @Message(id = 2, value = "Failure closing %s") <3>
+ CloseException closeFailure(@Cause Throwable cause, @Param @Pos(1) Closeable c);
+
+ CloseException closeFailure(@Cause Throwable cause, @Param @Pos(1) Closeable c, @Suppressed Throwable... errors);
+
+ @Message(id = 3, value = "Parameter %s cannot be null")
+ Supplier nullParam(String name);
+
+ @Message(id = 4, value = "Operation %s failed.")
+ T operationFailed(@Producer Function fn, String name); <4>
+
+ T operationFailed(@Producer BiFunction fn, @Cause IOException cause, String name);
+}
+----
+<1> The `projectCode` will be prepended to messages which have an `id` specified. For example with `id = 1` the message will be prepended with `CW000001`. You can control the number padding with the `length` property on the annotation.
+<2> No `id` is specified for this message which means no id will be prepended on this message.
+<3> The `@Param` annotation tells the generator that the parameter should be used to construct the `CloseException`. The `@Pos(1)` annotation indicates the parameter should also be used when formatting the message.
+<4> The `@Producer` annotation indicates that the `Function` should be used to create the exception being returned.
+
+TIP: Message bundle interfaces can also contain valid <>.
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/asciidoc/message-logger.adoc jboss-logging-tools-2.1.0/docs/src/main/asciidoc/message-logger.adoc
--- jboss-logging-tools-2.0.2/docs/src/main/asciidoc/message-logger.adoc 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/asciidoc/message-logger.adoc 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,59 @@
+
+== Message Logger Interfaces
+
+Logger interfaces provide a way to internationalize log messages. A logger interface is an interface annotated with
+link:{javadocsdir}[`@MessageLogger`]. Each method in must be annotated with link:{javadocsdir}[`@Message`] which will
+be used to determine the message to be logged.
+
+The value for a link:{javadocsdir}[`@Message`] may contain an expression.
+
+include::expressions.adoc[]
+
+The following constraints are placed on methods in a message logger:
+
+- The method must have a `void` return type
+- The method must be annotated with link:{javadocsdir}[`@LogMessage`]
+- The method must be annotated with link:{javadocsdir}[`@Message`] or a message must be inheritable.
+- A method can have only one link:{javadocsdir}[`@Cause`] parameter.
+
+include::default-notes.adoc[]
+
+A message logger interface may also extend the `org.jboss.logging.BasicLogger`. This allows the logging interface to be usable for standard logging. For example `AppLogger.LOGGER.debugf("Initializing %s", this);`
+
+=== Example Message Logger
+
+[source,java]
+----
+@MessageLogger(projectCode = "CW") <1>
+public interface AppLogger extends BasicLogger {
+
+ AppLogger LOGGER = Logger.getMessageLogger(AppLogger.class, AppLogger.class.getPackage().getName());
+
+ @LogMessage
+ @Once <2>
+ @Message("%s version %d.%d.%d.%s") <3>
+ void appVersion(CharSequence name, int major, int minor, int macro, String rel);
+
+ @LogMessage(level = Logger.Level.ERROR) <4>
+ @Message(id = 100, value = "Failure while closing %s")
+ void closeFailure(@Cause Throwable cause, Object obj);
+
+ @LogMessage(level = Logger.Level.WARN)
+ @Message(id = 101, value = "Encoding %s could not be found. Defaulting to %s.")
+ void encodingNotFound(String encoding, Charset dft);
+
+ @LogMessage
+ @Message(id = 102, value = "Cache size changed to '%d'")
+ void cacheSizeChanged(@Transform(Transform.TransformType.SIZE) Collection c);
+
+ @LogMessage
+ void cacheSizeChanged(@Transform(Transform.TransformType.SIZE) String... array);
+
+ @LogMessage
+ void cacheSizeChanged(@Transform(Transform.TransformType.SIZE) Map map);
+}
+----
+<1> The `projectCode` will be prepended to messages which have an `id` specified. For example with `id = 100` the message will be prepended with `CW000100`. You can control the number padding with the `length` property on the annotation.
+<2> Ensures the log message is only written once.
+<3> No `id` is specified for this message which means no id will be prepended on this message.
+<4> Overrides the default level to `ERROR` to indicate an error message should be logged.
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/asciidoc/processor-options.adoc jboss-logging-tools-2.1.0/docs/src/main/asciidoc/processor-options.adoc
--- jboss-logging-tools-2.0.2/docs/src/main/asciidoc/processor-options.adoc 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/asciidoc/processor-options.adoc 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,44 @@
+
+== Annotation Processor Options
+
+You can pass options to an annotation processor with the `-A` compiler option. For example to disable generating the `@Generated` annotation from being placed on the generated source files you would pass `-Aorg.jboss.logging.tools.addGeneratedAnnotation=false` to the compiler command.
+
+=== General
+
+[frame=none,grid=none]
+|===
+| Option | Description
+
+| `debug` | This option turns on debug logging for the processor
+| `org.jboss.logging.tools.expressionProperties` | This option allows you to define a path where, at compile-time, expressions in messages can be resolved.
+| `org.jboss.logging.tools.addGeneratedAnnotation` | If set to `false` the `@Generated` annotation will not be placed on the generated source files. The default is `true`.
+|===
+
+NOTE: In Java 9 the `@javax.annotation.Generated` was moved to `@javax.annotation.processor.Generated`. The processor attempts to determine which annotation to use by attempting to find the `@javax.annotation.Generated` first. If it fails the `@javax.annotation.processor.Generated` is attempted. If neither can be found no annotation will be placed on the generated implementations.
+
+include::expressions.adoc[]
+
+=== Translation Options
+
+[frame=none,grid=none]
+|===
+| Option | Description
+
+| `translationsFilesPath` | The base path for the translated properties files. This defaults to the location where new class files are placed.
+| `skipTranslations` | If set to `true` source files with the translated tet will not be generated. The default is `false`.
+| `generatedTranslationFilesPath` | If defined this indicates the path a skeleton file should be generated for the interface. The generated skeleton file will be placed in a directory that matches the package with a name that matches the interface with a `.i18n_locale_COUNTRY_VARIANT.properties` suffix.
+| `org.jboss.logging.tools.level` | Sets the maximum level to include in the generated skeleton files. For example if set to `INFO` the skeleton files will not contain any properties where the log level was set to `DEBUG` or `TRACE`.
+
+|===
+
+=== Report Options
+
+[frame=none,grid=none]
+|===
+| Option | Description
+
+| `org.jboss.logging.tools.report.type` | Indicates the type of report that should be generated. The current report types are `adoc` for asciidoc or `xml` for XML.
+| `org.jboss.logging.tools.report.path` | The path where the generated reports should be placed. This defaults to the location where new class files are placed.
+| `org.jboss.logging.tools.report.title` | An optional title for the report. For asciidoc this defaults to `Messages`. For XML the `` element is left off.
+
+|===
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/asciidoc/reports.adoc jboss-logging-tools-2.1.0/docs/src/main/asciidoc/reports.adoc
--- jboss-logging-tools-2.0.2/docs/src/main/asciidoc/reports.adoc 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/asciidoc/reports.adoc 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,24 @@
+
+== Reports
+
+There are currently two types of reports that can be generated. The options are `adoc` or `asciidoc` for asciidoc and `xml` for XML.
+
+The reports contain the following data:
+
+* The formatted message id.
+* A possible link to a resolution document for the error.
+* The unformatted message.
+* The log level, if applicable.
+* The return type, if applicable.
+
+=== Annotations
+
+Two annotations can be used to assist withing linking resolution documents for messages.
+
+* link:{javadocsdir}[`@BaseUrl`]
+ - This annotation can be used on a type to define the base URL for linking resolution documents. This annotation is
+ not required for links to be created on reports.
+* link:{javadocsdir}[`@ResolutionDoc`]
+ - This annotation is used to define information about the resolution document for creating links. If placed on an
+ interface all methods that have a defined id will have a link generated. This can also be placed individually on
+ the method to only generate links for specific id's.
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/asciidoc/translation-property-files.adoc jboss-logging-tools-2.1.0/docs/src/main/asciidoc/translation-property-files.adoc
--- jboss-logging-tools-2.0.2/docs/src/main/asciidoc/translation-property-files.adoc 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/asciidoc/translation-property-files.adoc 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,4 @@
+
+== Translation Property Files
+
+The translation properties files must exist in the same directory structure as the interface. The name of the properties file `InterfaceName.i18n_language_country_variant.properties`. For example if you have a class named `org.jboss.logging.tools.examples.ErrorMessages` and you want to translate this into French you create a properties file called `ErrorMessages.i18n_fr.properties` in a directory `org/jboss/logging/tools/examples`.
\ No newline at end of file
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/java/org/jboss/logging/tools/examples/AppLogger.java jboss-logging-tools-2.1.0/docs/src/main/java/org/jboss/logging/tools/examples/AppLogger.java
--- jboss-logging-tools-2.0.2/docs/src/main/java/org/jboss/logging/tools/examples/AppLogger.java 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/java/org/jboss/logging/tools/examples/AppLogger.java 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,109 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2017 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.tools.examples;
+
+import java.nio.charset.Charset;
+import java.util.Collection;
+import java.util.Map;
+
+import org.jboss.logging.BasicLogger;
+import org.jboss.logging.Logger;
+import org.jboss.logging.annotations.Cause;
+import org.jboss.logging.annotations.LogMessage;
+import org.jboss.logging.annotations.Message;
+import org.jboss.logging.annotations.MessageLogger;
+import org.jboss.logging.annotations.Once;
+import org.jboss.logging.annotations.ResolutionDoc;
+import org.jboss.logging.annotations.Transform;
+
+/**
+ * A common logger for the application.
+ *
+ * @author <a href="mailto:jperkins@redhat.com">James R. Perkins</a>
+ */
+@SuppressWarnings({"unused", "SameParameterValue"})
+@MessageLogger(projectCode = "CW")
+@ResolutionDoc(url = "errors", suffix = ".html")
+public interface AppLogger extends BasicLogger {
+
+ AppLogger LOGGER = Logger.getMessageLogger(AppLogger.class, AppLogger.class.getPackage().getName());
+
+ /**
+ * Logs an informational message, once, indicating the applications version.
+ *
+ * @param name the name of the application
+ * @param major the major version
+ * @param minor the minor version
+ * @param macro the macro version
+ * @param rel the release suffix, e.g. {@code Beta1}, {@code Final}
+ */
+ @LogMessage
+ @Once
+ @Message("%s version %d.%d.%d.%s")
+ void appVersion(CharSequence name, int major, int minor, int macro, String rel);
+
+ /**
+ * Logs an error message indicating a failure to close the object.
+ *
+ * @param cause the cause of the error
+ * @param obj the object that failed closing
+ */
+ @LogMessage(level = Logger.Level.ERROR)
+ @Message(id = 100, value = "Failure while closing %s")
+ void closeFailure(@Cause Throwable cause, Object obj);
+
+ /**
+ * Logs a warning message indicating the encoding is invalid and a default encoding will be used.
+ *
+ * @param encoding the invalid encoding
+ * @param dft the default encoding
+ */
+ @LogMessage(level = Logger.Level.WARN)
+ @Message(id = 101, value = "Encoding %s could not be found. Defaulting to %s.")
+ void encodingNotFound(String encoding, Charset dft);
+
+ /**
+ * Logs an informational message indicating the cache size has changed and the size the cache is now.
+ *
+ * @param c the collection holding the cache
+ */
+ @LogMessage
+ @Message(id = 102, value = "Cache size changed to '%d'")
+ @ResolutionDoc(skip = true)
+ void cacheSizeChanged(@Transform(Transform.TransformType.SIZE) Collection<String> c);
+
+ /**
+ * Logs an informational message indicating the cache size has changed and the size the cache is now.
+ *
+ * @param array the cache arracy
+ */
+ @LogMessage
+ @ResolutionDoc(skip = true)
+ void cacheSizeChanged(@Transform(Transform.TransformType.SIZE) String... array);
+
+ /**
+ * Logs an informational message indicating the cache size has changed and the size the cache is now.
+ *
+ * @param map the map holding the cache
+ */
+ @LogMessage
+ @ResolutionDoc(skip = true)
+ void cacheSizeChanged(@Transform(Transform.TransformType.SIZE) Map<String, Object> map);
+}
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/java/org/jboss/logging/tools/examples/CloseException.java jboss-logging-tools-2.1.0/docs/src/main/java/org/jboss/logging/tools/examples/CloseException.java
--- jboss-logging-tools-2.0.2/docs/src/main/java/org/jboss/logging/tools/examples/CloseException.java 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/java/org/jboss/logging/tools/examples/CloseException.java 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,64 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2017 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.tools.examples;
+
+import java.io.Closeable;
+
+/**
+ * An error with access to the failing {@link Closeable}.
+ *
+ * @author <a href="mailto:jperkins@redhat.com">James R. Perkins</a>
+ */
+@SuppressWarnings("unused")
+public class CloseException extends RuntimeException {
+ private final Closeable closeable;
+
+ /**
+ * Creates a new error.
+ *
+ * @param msg the message for the error
+ * @param closeable the failed closeable
+ */
+ public CloseException(final String msg, final Closeable closeable) {
+ super(msg);
+ this.closeable = closeable;
+ }
+
+ /**
+ * Creates a new error.
+ *
+ * @param msg the message for the error
+ * @param cause the cause of the error
+ * @param closeable the failed closeable
+ */
+ public CloseException(final String msg, final Throwable cause, final Closeable closeable) {
+ super(msg, cause);
+ this.closeable = closeable;
+ }
+
+ /**
+ * Returns the failed closeable.
+ *
+ * @return the failed closeable
+ */
+ public Closeable getCloseable() {
+ return closeable;
+ }
+}
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/java/org/jboss/logging/tools/examples/ContentWriterBuilder.java jboss-logging-tools-2.1.0/docs/src/main/java/org/jboss/logging/tools/examples/ContentWriterBuilder.java
--- jboss-logging-tools-2.0.2/docs/src/main/java/org/jboss/logging/tools/examples/ContentWriterBuilder.java 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/java/org/jboss/logging/tools/examples/ContentWriterBuilder.java 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,113 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2017 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.tools.examples;
+
+import java.io.BufferedWriter;
+import java.io.IOException;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
+import java.nio.charset.UnsupportedCharsetException;
+import java.nio.file.Files;
+import java.nio.file.OpenOption;
+import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
+import java.util.Objects;
+
+/**
+ * Builds a {@link ContentWriter}.
+ *
+ * @author <a href="mailto:jperkins@redhat.com">James R. Perkins</a>
+ */
+@SuppressWarnings("unused")
+public class ContentWriterBuilder {
+ private final Path path;
+ private boolean append = true;
+ private String encoding = null;
+
+
+ private ContentWriterBuilder(final Path path) {
+ this.path = path;
+ }
+
+ /**
+ * Creates a new builder.
+ *
+ * @param path the path where the content should be written to, cannot be {@code null}
+ *
+ * @return the new content writer
+ */
+ public static ContentWriterBuilder of(final Path path) {
+ Objects.requireNonNull(path, ErrorMessages.MESSAGES.nullParam("path"));
+ return new ContentWriterBuilder(path);
+ }
+
+ /**
+ * Set the encoding of for the content. If the encoding is not a valid {@link Charset} a default encoding of
+ * {@link StandardCharsets#UTF_8} will be used.
+ *
+ * @param encoding the encoding to use
+ *
+ * @return this builder
+ */
+ public ContentWriterBuilder setEncoding(final String encoding) {
+ this.encoding = encoding;
+ return this;
+ }
+
+ /**
+ * Indicates whether or not the content should be appended to any previous content already written. The default
+ * value is {@link true}.
+ *
+ * @param append {@code false} if the created writer should overwrite previously written content, otherwise
+ * {@code true}
+ *
+ * @return this builder
+ */
+ public ContentWriterBuilder setAppend(final boolean append) {
+ this.append = append;
+ return this;
+ }
+
+ /**
+ * Creates the {@link ContentWriter}.
+ *
+ * @return the created writer
+ *
+ * @throws IOException if a failure creating the writer occurs
+ */
+ public ContentWriter build() throws IOException {
+ final OpenOption[] options;
+ if (append) {
+ options = new OpenOption[] {StandardOpenOption.CREATE, StandardOpenOption.APPEND};
+ } else {
+ options = new OpenOption[] {StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING};
+ }
+ Charset charset = StandardCharsets.UTF_8;
+ if (encoding != null) {
+ try {
+ charset = Charset.forName(encoding);
+ } catch (UnsupportedCharsetException e) {
+ AppLogger.LOGGER.encodingNotFound(encoding, charset);
+ }
+ }
+ final BufferedWriter writer = Files.newBufferedWriter(path, charset, options);
+ return new ContentWriter(path, writer);
+ }
+}
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/java/org/jboss/logging/tools/examples/ContentWriter.java jboss-logging-tools-2.1.0/docs/src/main/java/org/jboss/logging/tools/examples/ContentWriter.java
--- jboss-logging-tools-2.0.2/docs/src/main/java/org/jboss/logging/tools/examples/ContentWriter.java 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/java/org/jboss/logging/tools/examples/ContentWriter.java 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,164 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2017 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.tools.examples;
+
+import java.io.BufferedWriter;
+import java.io.Closeable;
+import java.io.Flushable;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.nio.file.Path;
+import java.util.Objects;
+
+/**
+ * A writer for writing content to a file.
+ *
+ * @author <a href="mailto:jperkins@redhat.com">James R. Perkins</a>
+ */
+@SuppressWarnings({"unused", "WeakerAccess"})
+public class ContentWriter implements Closeable, Flushable {
+
+ private final Object outputLock = new Object();
+
+ private final Path contentPath;
+ private final BufferedWriter writer;
+ private volatile boolean autoFlush = true;
+
+ ContentWriter(final Path contentPath, final BufferedWriter writer) {
+ this.contentPath = Objects.requireNonNull(contentPath, ErrorMessages.MESSAGES.nullParam("contentPath"));
+ this.writer = Objects.requireNonNull(writer, ErrorMessages.MESSAGES.nullParam("writer"));
+ }
+
+ // tag::write[]
+
+ /**
+ * Writes the value of the object to the file.
+ *
+ * @param value the value to write, cannot be {@code null}
+ *
+ * @throws UncheckedIOException if an error occurs writing the data
+ */
+ public void write(final Object value) {
+ AppLogger.LOGGER.appVersion("ContentWriter", 1, 0, 0, "Beta1"); // <1>
+ Objects.requireNonNull(value, ErrorMessages.MESSAGES.nullParam("value")); // <2>
+ write(Objects.requireNonNull(value, ErrorMessages.MESSAGES.nullParam("value")).toString());
+ }
+
+ /**
+ * Writes the value to the file.
+ *
+ * @param value the value to write, cannot be {@code null} or an {@linkplain String#isEmpty() empty string}.
+ *
+ * @throws UncheckedIOException if an error occurs writing the data
+ */
+ public void write(final String value) {
+ AppLogger.LOGGER.appVersion("ContentWriter", 1, 0, 0, "Beta1");
+ if (Objects.requireNonNull(value, ErrorMessages.MESSAGES.nullParam("value")).isEmpty()) {
+ throw ErrorMessages.MESSAGES.invalidValue(value); // <3>
+ }
+ try {
+ synchronized (outputLock) {
+ writer.write(value);
+ writer.newLine();
+ if (autoFlush) {
+ flush();
+ }
+ }
+ } catch (IOException e) {
+ throw ErrorMessages.MESSAGES.operationFailed(UncheckedIOException::new, e, "write"); // <4>
+ }
+ }
+ // end::write[]
+
+ /**
+ * Set the value to {@code false} if the buffer should not automatically {@linkplain #flush() flush} on each write.
+ * <p>
+ * Defaults to {@code true}.
+ * </p>
+ *
+ * @param autoFlush {@code true} to {@linkplain #flush() flush} on each write, otherwise {@code false} to flush
+ * when the buffer determines it should be flushed
+ */
+ public void setAutoFlush(final boolean autoFlush) {
+ this.autoFlush = autoFlush;
+ }
+
+ // tag::close[]
+
+ @Override
+ public void close() {
+ try {
+ synchronized (outputLock) {
+ writer.close();
+ }
+ AppLogger.LOGGER.tracef("ContentWriter %s was successfully closed.", this);
+ } catch (Exception e) {
+ throw ErrorMessages.MESSAGES.closeFailure(e, this);
+ }
+ }
+
+ /**
+ * Safely close this writer logging any errors that occur during closing.
+ */
+ public void safeClose() {
+ try {
+ synchronized (outputLock) {
+ writer.close();
+ }
+ AppLogger.LOGGER.tracef("ContentWriter %s was successfully closed.", this);
+ } catch (Exception e) {
+ AppLogger.LOGGER.closeFailure(e, this); // <5>
+ }
+ }
+ // end::close[]
+
+ @Override
+ public void flush() {
+ try {
+ synchronized (outputLock) {
+ writer.flush();
+ }
+ } catch (IOException e) {
+ throw ErrorMessages.MESSAGES.operationFailed(UncheckedIOException::new, e, "flush");
+ }
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(contentPath);
+ }
+
+ @Override
+ public boolean equals(final Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (!(obj instanceof ContentWriter)) {
+ return false;
+ }
+ final ContentWriter other = (ContentWriter) obj;
+ return Objects.equals(contentPath, other.contentPath);
+ }
+
+ @Override
+ public String toString() {
+ return "ContentWriter[" + contentPath.toAbsolutePath() + "]";
+ }
+}
diff -Nru jboss-logging-tools-2.0.2/docs/src/main/java/org/jboss/logging/tools/examples/ErrorMessages.java jboss-logging-tools-2.1.0/docs/src/main/java/org/jboss/logging/tools/examples/ErrorMessages.java
--- jboss-logging-tools-2.0.2/docs/src/main/java/org/jboss/logging/tools/examples/ErrorMessages.java 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/src/main/java/org/jboss/logging/tools/examples/ErrorMessages.java 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,145 @@
+
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2017 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.tools.examples;
+
+import java.io.Closeable;
+import java.io.IOException;
+import java.util.function.BiFunction;
+import java.util.function.Function;
+import java.util.function.Supplier;
+
+import org.jboss.logging.Messages;
+import org.jboss.logging.annotations.BaseUrl;
+import org.jboss.logging.annotations.Cause;
+import org.jboss.logging.annotations.Message;
+import org.jboss.logging.annotations.MessageBundle;
+import org.jboss.logging.annotations.Param;
+import org.jboss.logging.annotations.Pos;
+import org.jboss.logging.annotations.Producer;
+import org.jboss.logging.annotations.ResolutionDoc;
+import org.jboss.logging.annotations.Suppressed;
+
+/**
+ * Common error messages for the application.
+ *
+ * @author <a href="mailto:jperkins@redhat.com">James R. Perkins</a>
+ */
+@SuppressWarnings("unused")
+@MessageBundle(projectCode = "CW")
+@BaseUrl("errors/")
+public interface ErrorMessages {
+ /**
+ * The static message instance.
+ */
+ ErrorMessages MESSAGES = Messages.getBundle(ErrorMessages.class);
+
+ /**
+ * Returns the internationalized version message.
+ *
+ * @param major the major version
+ * @param minor the minor version
+ * @param macro the macro version
+ * @param rel the release suffix, e.g. {@code Beta1}, {@code Final}
+ *
+ * @return the formatted version
+ */
+ @Message("Version %d.%d.%d.%s")
+ String version(int major, int minor, int macro, String rel);
+
+ /**
+ * Creates an exception indicating the value is invalid.
+ *
+ * @param value the invalid value
+ *
+ * @return an {@link IllegalStateException} for the error
+ */
+ @Message(id = 1, value = "Value '%s' is invalid")
+ IllegalArgumentException invalidValue(Object value);
+
+ /**
+ * Creates an exception indicating a failure to close the {@link Closeable}
+ *
+ * @param cause the cause of the error
+ * @param c the closeable that failed
+ *
+ * @return a {@link CloseException} for the error
+ */
+ @Message(id = 2, value = "Failure closing %s")
+ CloseException closeFailure(@Cause Throwable cause, @Param @Pos(1) Closeable c);
+
+ /**
+ * Creates an exception indicating a failure to close the {@link Closeable}
+ *
+ * @param cause the cause of the error
+ * @param c the closeable that failed
+ * @param errors errors that should be added as {@linkplain Throwable#getSuppressed() suppressed exceptions}.
+ *
+ * @return a {@link CloseException} for the error
+ */
+ CloseException closeFailure(@Cause Throwable cause, @Param @Pos(1) Closeable c, @Suppressed Throwable... errors);
+
+ /**
+ * Creates a message indicating the parameter is {@code null}.
+ * <p>
+ * This can be used to lazily format the message for {@code null} checks like
+ * {@link java.util.Objects#requireNonNull(Object, Supplier)}.
+ * </p>
+ *
+ * @param name the name of the parameter
+ *
+ * @return a supplier for the message
+ */
+ @Message(id = 3, value = "Parameter %s cannot be null")
+ @ResolutionDoc(suffix = ".html")
+ Supplier<String> nullParam(String name);
+
+ /**
+ * Uses the producer function to create the returned exception indicating the operation has failed.
+ * <p>
+ * The formatted value of the message will be the parameter for the functions
+ * {@linkplain Function#apply(Object) apply} method.
+ * </p>
+ *
+ * @param fn the function to produce the returned exception
+ * @param name the name of the operation that failed
+ * @param <T> the type of the exception to return, must be assignable to a {@link RuntimeException}
+ *
+ * @return the produced exception for the error
+ */
+ @Message(id = 4, value = "Operation %s failed.")
+ <T extends RuntimeException> T operationFailed(@Producer Function<String, T> fn, String name);
+
+ /**
+ * Uses the producer function to create the returned exception indicating the operation has failed.
+ * <p>
+ * The formatted value of the message will be the first parameter for the functions
+ * {@linkplain BiFunction#apply(Object, Object)} apply} method. The second parameter will be the cause.
+ * </p>
+ *
+ * @param fn the function to produce the returned exception
+ * @param cause the cause of the exception to pass to the function
+ * @param name the name of the operation that failed
+ * @param <T> the type of the exception to return, must be assignable to a {@link RuntimeException}
+ *
+ * @return the produced exception for the error
+ */
+ <T extends RuntimeException> T operationFailed(@Producer BiFunction<String, IOException, T> fn, @Cause IOException cause, String name);
+}
diff -Nru jboss-logging-tools-2.0.2/docs/translation-property-files.html jboss-logging-tools-2.1.0/docs/translation-property-files.html
--- jboss-logging-tools-2.0.2/docs/translation-property-files.html 1970-01-01 00:00:00.000000000 +0000
+++ jboss-logging-tools-2.1.0/docs/translation-property-files.html 2017-08-09 18:02:31.000000000 +0000
@@ -0,0 +1,531 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta name="generator" content="Asciidoctor 1.5.5">
+<title>Translation Property Files
+
+
+
+
+
+
+
+
+
+
+
Translation Property Files
+
+
+
The translation properties files must exist in the same directory structure as the interface. The name of the properties file InterfaceName.i18n_language_country_variant.properties. For example if you have a class named org.jboss.logging.tools.examples.ErrorMessages and you want to translate this into French you create a properties file called ErrorMessages.i18n_fr.properties in a directory org/jboss/logging/tools/examples.