Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
SOLDER-85 repackage typed message bundle and logger
- split the typed message bundle and logger annotations into their own packages - update annotation processor to reflect repackaging - split type producers for the native logger, typed message bundle and typed message logger - split extensions for typed message bundle and logger - update javadoc and reference guide
- Loading branch information
1 parent
bfb90e7
commit 7fc1098
Showing
52 changed files
with
673 additions
and
436 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
155 changes: 0 additions & 155 deletions
155
api/src/main/java/org/jboss/seam/solder/log/package-info.java
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
106 changes: 106 additions & 0 deletions
106
api/src/main/java/org/jboss/seam/solder/logging/package-info.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| /* | ||
| * JBoss, Home of Professional Open Source | ||
| * Copyright 2010, Red Hat, Inc., and individual contributors | ||
| * by the @authors tag. See the copyright.txt in the distribution for a | ||
| * full listing of individual contributors. | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| /** | ||
| * Seam Solder integrates with JBoss Logging 3 to provide injectable native | ||
| * loggers or typed message loggers (suitable for internationalization and | ||
| * localization) while still offering a choice of logging backend | ||
| * | ||
| * <p>Solder builds on its typed message bundles support combined with JBoss | ||
| * Logging 3 to provide the following feature set:</p> | ||
| * | ||
| * <ul> | ||
| * <li>An abstraction over common logging backends and frameworks (such as JDK Logging, log4j and slf4j)</li> | ||
| * <li>An innovative, typed message logger (and bundle) defined using an interface (see below for examples)</li> | ||
| * <li>Full support for internationalization and localization</li> | ||
| * <li>Build time tooling to generate typed loggers for production, and runtime generation of typed loggers for development</li> | ||
| * <li>Access to MDC and NDC (if underlying logger supports it)</li> | ||
| * <li>Serializable loggers</li> | ||
| * </ul> | ||
| * | ||
| * <p>To define a typed message logger, first create an annotated interface | ||
| * with methods configured as log commands. The log messages to use | ||
| * printf-style interpolations of parameters (%s).</p> | ||
| * | ||
| * <pre> | ||
| * @MessageLogger | ||
| * public interface TrainSpotterLog { | ||
| * | ||
| * @Log @Message("Spotted %s diesel trains") | ||
| * void dieselTrainsSpotted(int number); | ||
| * | ||
| * } | ||
| * </pre> | ||
| * | ||
| * <p>You can then inject the typed logger with no further configuration | ||
| * necessary. You use another annotation to set the category of the logger to | ||
| * "trains" at the injection point:</p> | ||
| * | ||
| * <pre> | ||
| * @Inject @Category("trains") TrainSpotterLog log; | ||
| * </pre> | ||
| * | ||
| * <p>You log a message by simply invoking a method of the message logger | ||
| * interface:</p> | ||
| * | ||
| * <pre> | ||
| * log.dieselTrainsSpotted(7); | ||
| * </pre> | ||
| * | ||
| * <p>The default locale will be used unless overridden. Here we configure the | ||
| * logger to use the UK locale.</p> | ||
| * | ||
| * <pre> | ||
| * @Inject @Category("trains") @Locale("en_GB") TrainSpotterLog log; | ||
| * </pre> | ||
| * | ||
| * <p>You can also log exceptions:</p> | ||
| * | ||
| * <pre> | ||
| * @MessageLogger | ||
| * public interface TrainSpotterLog { | ||
| * | ||
| * @Log @Message("Failed to spot train %s") | ||
| * void missedTrain(String trainNumber, @Cause Exception exception); | ||
| * | ||
| * } | ||
| * </pre> | ||
| * | ||
| * <p>You can then log a message with exception:</p> | ||
| * | ||
| * <pre> | ||
| * log.missedTrain("RH1", cause); | ||
| * </pre> | ||
| * | ||
| * <p> | ||
| * You can also inject a native Logger from the JBoss Logging 3 API: | ||
| * </p> | ||
| * | ||
| * <pre> | ||
| * @Inject Logger log; | ||
| * </pre> | ||
| * | ||
| * @see org.jboss.seam.solder.logging.Log | ||
| * @see org.jboss.seam.solder.logging.Category | ||
| * @see org.jboss.seam.solder.logging.TypedCategory | ||
| * @see org.jboss.seam.solder.logging.Suffix | ||
| * @see org.jboss.seam.solder.messages.Cause | ||
| * @see org.jboss.seam.solder.messages.Message | ||
| * @see org.jboss.seam.solder.messages.Locale | ||
| * @see org.jboss.seam.solder.messages.Formatter | ||
| */ | ||
| package org.jboss.seam.solder.logging; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.