org.osgi.service.log.FormatterLogger Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of aspectjtools Show documentation

AspectJ tools most notably contains the AspectJ compiler (AJC). AJC applies aspects to Java classes during compilation, fully replacing Javac for plain Java classes and also compiling native AspectJ or annotation-based @AspectJ syntax. Furthermore, AJC can weave aspects into existing class files in a post-compile binary weaving step. This library is a superset of AspectJ weaver and hence also of AspectJ runtime.

There is a newer version: 1.9.22.1

Show newest version

/*
 * Copyright (c) OSGi Alliance (2016, 2017). All Rights Reserved.
 * 
 * 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.osgi.service.log;

import org.osgi.annotation.versioning.ProviderType;

/**
 * Provides methods for bundles to write messages to the log using printf-style
 * format strings.
 * 
 * Messages can be formatted by the Logger once the Logger determines the log
 * level is enabled. Uses printf-style format strings as described in
 * {@link java.util.Formatter}.
 * 

 * You can also add a {@code Throwable} and/or {@code ServiceReference} to the
 * generated {@link LogEntry} by passing them to the logging methods as
 * additional arguments. If the last argument is a {@code Throwable} or
 * {@code ServiceReference}, it is added to the generated {@link LogEntry} and
 * then if the next to last argument is a {@code ServiceReference} or
 * {@code Throwable} and not the same type as the last argument, it is also
 * added to the generated {@link LogEntry}. These arguments will not be used as
 * message arguments. For example:
 * 
 * 
 * logger.info("Found service %s.", serviceReference, serviceReference);
 * logger.warn("Something named %s happened.", name, serviceReference,
 * 		throwable);
 * logger.error("Failed.", exception);
 * 
 * 
 * If an exception occurs formatting the message, the logged message will
 * indicate the formatting failure including the format string and the
 * arguments.
 * 
 * @ThreadSafe
 * @author $Id: 5fe22978aa7d391073fcc97aad7ebbbd9cbd8aee $
 * @since 1.4
 */
@ProviderType
public interface FormatterLogger extends Logger {
	// no additional methods
}