JAXB OSGI 4.0.9 · com.sun.istack.logging.Logger · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final String	componentClassName
private final Logger	logger
private static final Level	METHOD_CALL_LEVEL_VALUE
private static final String	ROOT_WS_PACKAGE
private static final String	WS_LOGGING_SUBSYSTEM_NAME_ROOT

Access	Constructor and Description
protected	Logger(final String system logger name systemLoggerName, final String component name componentName) Prevents creation of a new instance of this Logger unless used by a subclass.

Method Summary

Modifier and Type	Method and Description
public void	config(final String message)
public void	config(final String message, Object[] params)
public void	config(final String message, final Throwable thrown)
public void	entering()
public void	entering(final Object... parameters)
public void	exiting()
public void	exiting(final Object result)
public void	fine(final String message)
public void	fine(final String message, final Throwable thrown)
public void	finer(final String message)
public void	finer(final String message, Object[] params)
public void	finer(final String message, final Throwable thrown)
public void	finest(final String message)
public void	finest(final String message, Object[] params)
public void	finest(final String message, final Throwable thrown)
public static Logger	Returns: logger instance preconfigured for use with the component getLogger(final Class<?> class of the component that will use the logger instance. Must not be `null`. componentClass) The factory method returns preconfigured Logger wrapper for the class.
public static Logger	Returns: logger instance preconfigured for use with the component getLogger(final String custom name of the logger. customLoggerName, final Class<?> class of the component that will use the logger instance. Must not be `null`. componentClass) The factory method returns preconfigured Logger wrapper for the class.
pack-priv static final String	Returns: system logger name for the given `componentClass` instance getSystemLoggerName(Class<?> class of the component that will use the logger instance. Must not be `null`. componentClass) Calculates the subsystem suffix based on the package of the component class
public void	info(final String message)
public void	info(final String message, Object[] params)
public void	info(final String message, final Throwable thrown)
public boolean	isLoggable(final Level level)
public boolean	isMethodCallLoggable()
public void	log(final Level level, final String message)
public void	log(final Level level, final String message, Object param1)
public void	log(final Level level, final String message, Object[] params)
public void	log(final Level level, final String message, final Throwable thrown)
public < type T extends Throwable> T	Returns: the same exception instance that was passed in as the `exception` parameter. logException(final T exception whose message should be logged. Must not be `null`. exception, final Throwable initial cause of the exception that should be logged as well and set as `exception`'s original cause. May be `null`. cause, final Level loging level which should be used for logging level) Method logs `exception`'s message at the logging level specified by the `level` argument.
public < type T extends Throwable> T	Returns: the same exception instance that was passed in as the `exception` parameter. logException(final T exception whose message should be logged. Must not be `null`. exception, final boolean deterimnes whether initial cause of the exception should be logged as well logCause, final Level loging level which should be used for logging level) Method logs `exception`'s message at the logging level specified by the `level` argument.
public < type T extends Throwable> T	Returns: the same exception instance that was passed in as the `exception` parameter. logException(final T exception whose message should be logged. Must not be `null`. exception, final Level loging level which should be used for logging level) Same as `logException(exception, true, level)`.
public < type T extends Throwable> T	Returns: the same exception instance that was passed in as the `exception` parameter. logSevereException(final T exception whose message should be logged. Must not be `null`. exception, final Throwable initial cause of the exception that should be logged as well and set as `exception`'s original cause. May be `null`. cause) Method logs `exception`'s message as a `SEVERE` logging level message.
public < type T extends Throwable> T	Returns: the same exception instance that was passed in as the `exception` parameter. logSevereException(final T exception whose message should be logged. Must not be `null`. exception, final boolean deterimnes whether initial cause of the exception should be logged as well logCause) Method logs `exception`'s message as a `SEVERE` logging level message.
public < type T extends Throwable> T	Returns: the same exception instance that was passed in as the `exception` parameter. logSevereException(final T exception whose message should be logged. Must not be `null`. exception) Same as `logSevereException(exception, true)`.
public void	setLevel(final Level level)
public void	severe(final String message)
public void	severe(final String message, Object[] params)
public void	severe(final String message, final Throwable thrown)
public void	warning(final String message)
public void	warning(final String message, Object[] params)
public void	warning(final String message, final Throwable thrown)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

componentClassName	back to summary
private final String componentClassName

logger	back to summary
private final Logger logger

METHOD_CALL_LEVEL_VALUE	back to summary
private static final Level METHOD_CALL_LEVEL_VALUE

ROOT_WS_PACKAGE	back to summary
private static final String ROOT_WS_PACKAGE

WS_LOGGING_SUBSYSTEM_NAME_ROOT	back to summary
private static final String WS_LOGGING_SUBSYSTEM_NAME_ROOT

Logger	back to summary
protected Logger(final String systemLoggerName, final String componentName) Prevents creation of a new instance of this Logger unless used by a subclass. Parameters systemLoggerName:String system logger name componentName:String component name

Method Detail

config	back to summary
public void config(final String message)

config	back to summary
public void config(final String message, Object[] params)

config	back to summary
public void config(final String message, final Throwable thrown)

entering	back to summary
public void entering()

entering	back to summary
public void entering(final Object... parameters)

exiting	back to summary
public void exiting()

exiting	back to summary
public void exiting(final Object result)

fine	back to summary
public void fine(final String message)

fine	back to summary
public void fine(final String message, final Throwable thrown)

finer	back to summary
public void finer(final String message)

finer	back to summary
public void finer(final String message, Object[] params)

finer	back to summary
public void finer(final String message, final Throwable thrown)

finest	back to summary
public void finest(final String message)

finest	back to summary
public void finest(final String message, Object[] params)

finest	back to summary
public void finest(final String message, final Throwable thrown)

getLogger back to summary

getLogger	back to summary
public static Logger getLogger(final Class<?> componentClass) The factory method returns preconfigured Logger wrapper for the class. Method calls `getSystemLoggerName(java.lang.Class)` to generate default logger name. Since there is no caching implemented, it is advised that the method is called only once per a class in order to initialize a final static logger variable, which is then used through the class to perform actual logging tasks. Parameters componentClass:Class<?> class of the component that will use the logger instance. Must not be `null`. Returns:Logger logger instance preconfigured for use with the component Annotations @NotNull Exceptions NullPointerException: if the componentClass parameter is `null`.

public static Logger getLogger(final Class<?> componentClass)

The factory method returns preconfigured Logger wrapper for the class. Method calls getSystemLoggerName(java.lang.Class) to generate default logger name.

Since there is no caching implemented, it is advised that the method is called only once per a class in order to initialize a final static logger variable, which is then used through the class to perform actual logging tasks.

Parameters

componentClass:Class<?>: class of the component that will use the logger instance. Must not be null.

Returns:Logger

logger instance preconfigured for use with the component

Annotations

@NotNull

Exceptions

NullPointerException:: if the componentClass parameter is null.

getLogger back to summary

getLogger	back to summary
public static Logger getLogger(final String customLoggerName, final Class<?> componentClass) The factory method returns preconfigured Logger wrapper for the class. Since there is no caching implemented, it is advised that the method is called only once per a class in order to initialize a final static logger variable, which is then used through the class to perform actual logging tasks. This method should be only used in a special cases when overriding of a default logger name derived from the package of the component class is needed. For all common use cases please use `getLogger(java.lang.Class)` method. Parameters customLoggerName:String custom name of the logger. componentClass:Class<?> class of the component that will use the logger instance. Must not be `null`. Returns:Logger logger instance preconfigured for use with the component Annotations @NotNull Exceptions NullPointerException: if the componentClass parameter is `null`. See Also `getLogger(java.lang.Class)`

public static Logger getLogger(final String customLoggerName, final Class<?> componentClass)

The factory method returns preconfigured Logger wrapper for the class. Since there is no caching implemented, it is advised that the method is called only once per a class in order to initialize a final static logger variable, which is then used through the class to perform actual logging tasks. This method should be only used in a special cases when overriding of a default logger name derived from the package of the component class is needed. For all common use cases please use getLogger(java.lang.Class) method.

Parameters

customLoggerName:String: custom name of the logger.
componentClass:Class<?>: class of the component that will use the logger instance. Must not be null.

Returns:Logger

logger instance preconfigured for use with the component

Annotations

@NotNull

Exceptions

NullPointerException:: if the componentClass parameter is null.

See Also

getLogger(java.lang.Class)

getSystemLoggerName back to summary

getSystemLoggerName	back to summary
pack-priv static final String getSystemLoggerName(Class<?> componentClass) Calculates the subsystem suffix based on the package of the component class Parameters componentClass:Class<?> class of the component that will use the logger instance. Must not be `null`. Returns:String system logger name for the given `componentClass` instance

pack-priv static final String getSystemLoggerName(Class<?> componentClass)

Calculates the subsystem suffix based on the package of the component class

Parameters

componentClass:Class<?>: class of the component that will use the logger instance. Must not be null.

Returns:String

system logger name for the given componentClass instance

info	back to summary
public void info(final String message)

info	back to summary
public void info(final String message, Object[] params)

info	back to summary
public void info(final String message, final Throwable thrown)

isLoggable	back to summary
public boolean isLoggable(final Level level)

isMethodCallLoggable	back to summary
public boolean isMethodCallLoggable()

log	back to summary
public void log(final Level level, final String message)

log	back to summary
public void log(final Level level, final String message, Object param1)

log	back to summary
public void log(final Level level, final String message, Object[] params)

log	back to summary
public void log(final Level level, final String message, final Throwable thrown)

logException back to summary

logException	back to summary
public <T extends Throwable> T logException(final T exception, final Throwable cause, final Level level) Method logs `exception`'s message at the logging level specified by the `level` argument. If `cause` parameter is not `null`, it is logged as well and `exception` original cause is initialized with instance referenced by `cause` parameter. Parameters <T> type exception:T exception whose message should be logged. Must not be `null`. cause:Throwable initial cause of the exception that should be logged as well and set as `exception`'s original cause. May be `null`. level:Level loging level which should be used for logging Returns:T the same exception instance that was passed in as the `exception` parameter.

public <T extends Throwable> T logException(final T exception, final Throwable cause, final Level level)

Method logs exception's message at the logging level specified by the level argument.

If cause parameter is not null, it is logged as well and exception original cause is initialized with instance referenced by cause parameter.

Parameters

<T>: type
exception:T: exception whose message should be logged. Must not be null.
cause:Throwable: initial cause of the exception that should be logged as well and set as exception's original cause. May be null.
level:Level: loging level which should be used for logging

Returns:T

the same exception instance that was passed in as the exception parameter.

logException back to summary

logException	back to summary
public <T extends Throwable> T logException(final T exception, final boolean logCause, final Level level) Method logs `exception`'s message at the logging level specified by the `level` argument. If `logCause` parameter is `true`, `exception`'s original cause is logged as well (if exists). This may be used in cases when `exception`'s class provides constructor to initialize the original cause. In such case you do not need to use `logException(exception, cause, level)` method version but you might still want to log the original cause as well. Parameters <T> type exception:T exception whose message should be logged. Must not be `null`. logCause:boolean deterimnes whether initial cause of the exception should be logged as well level:Level loging level which should be used for logging Returns:T the same exception instance that was passed in as the `exception` parameter.

public <T extends Throwable> T logException(final T exception, final boolean logCause, final Level level)

Method logs exception's message at the logging level specified by the level argument.

If logCause parameter is true, exception's original cause is logged as well (if exists). This may be used in cases when exception's class provides constructor to initialize the original cause. In such case you do not need to use logException(exception, cause, level) method version but you might still want to log the original cause as well.

Parameters

<T>: type
exception:T: exception whose message should be logged. Must not be null.
logCause:boolean: deterimnes whether initial cause of the exception should be logged as well
level:Level: loging level which should be used for logging

Returns:T

the same exception instance that was passed in as the exception parameter.

logException back to summary

logException	back to summary
public <T extends Throwable> T logException(final T exception, final Level level) Same as `logException(exception, true, level)`. Parameters <T> type exception:T exception whose message should be logged. Must not be `null`. level:Level loging level which should be used for logging Returns:T the same exception instance that was passed in as the `exception` parameter.

public <T extends Throwable> T logException(final T exception, final Level level)

Same as logException(exception, true, level).

Parameters

<T>: type
exception:T: exception whose message should be logged. Must not be null.
level:Level: loging level which should be used for logging

Returns:T

the same exception instance that was passed in as the exception parameter.

logSevereException back to summary

logSevereException	back to summary
public <T extends Throwable> T logSevereException(final T exception, final Throwable cause) Method logs `exception`'s message as a `SEVERE` logging level message. If `cause` parameter is not `null`, it is logged as well and `exception` original cause is initialized with instance referenced by `cause` parameter. Parameters <T> type exception:T exception whose message should be logged. Must not be `null`. cause:Throwable initial cause of the exception that should be logged as well and set as `exception`'s original cause. May be `null`. Returns:T the same exception instance that was passed in as the `exception` parameter.

public <T extends Throwable> T logSevereException(final T exception, final Throwable cause)

Method logs exception's message as a SEVERE logging level message.

If cause parameter is not null, it is logged as well and exception original cause is initialized with instance referenced by cause parameter.

Parameters

<T>: type
exception:T: exception whose message should be logged. Must not be null.
cause:Throwable: initial cause of the exception that should be logged as well and set as exception's original cause. May be null.

Returns:T

the same exception instance that was passed in as the exception parameter.

logSevereException back to summary

logSevereException	back to summary
public <T extends Throwable> T logSevereException(final T exception, final boolean logCause) Method logs `exception`'s message as a `SEVERE` logging level message. If `logCause` parameter is `true`, `exception`'s original cause is logged as well (if exists). This may be used in cases when `exception`'s class provides constructor to initialize the original cause. In such case you do not need to use `logSevereException(Throwable, Throwable)` method version but you might still want to log the original cause as well. Parameters <T> type exception:T exception whose message should be logged. Must not be `null`. logCause:boolean deterimnes whether initial cause of the exception should be logged as well Returns:T the same exception instance that was passed in as the `exception` parameter.

public <T extends Throwable> T logSevereException(final T exception, final boolean logCause)

Method logs exception's message as a SEVERE logging level message.

If logCause parameter is true, exception's original cause is logged as well (if exists). This may be used in cases when exception's class provides constructor to initialize the original cause. In such case you do not need to use logSevereException(Throwable, Throwable) method version but you might still want to log the original cause as well.

Parameters

<T>: type
exception:T: exception whose message should be logged. Must not be null.
logCause:boolean: deterimnes whether initial cause of the exception should be logged as well

Returns:T

the same exception instance that was passed in as the exception parameter.

logSevereException back to summary

logSevereException	back to summary
public <T extends Throwable> T logSevereException(final T exception) Same as `logSevereException(exception, true)`. Parameters <T> type exception:T exception whose message should be logged. Must not be `null`. Returns:T the same exception instance that was passed in as the `exception` parameter.

public <T extends Throwable> T logSevereException(final T exception)

Same as logSevereException(exception, true).

Parameters

<T>: type
exception:T: exception whose message should be logged. Must not be null.

Returns:T

the same exception instance that was passed in as the exception parameter.

setLevel	back to summary
public void setLevel(final Level level)

severe	back to summary
public void severe(final String message)

severe	back to summary
public void severe(final String message, Object[] params)

severe	back to summary
public void severe(final String message, final Throwable thrown)

warning	back to summary
public void warning(final String message)

warning	back to summary
public void warning(final String message, Object[] params)

warning	back to summary
public void warning(final String message, final Throwable thrown)

public Class Logger

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail