com.codelanx.codelanxlib.logging

Class Logging

java.lang.Object

com.codelanx.codelanxlib.logging.Logging

public final class Logging
extends Object

This is a simple proxy to a plugin's Logger class.

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

See Also:

Logger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Logging.LoggingFacade Simplifies logging by providing façade methods similar to Debugger

Method Summary

Modifier and Type	Method and Description
static void	addHandler(Handler handler)
static void	config(String msg)
static void	config(java.util.function.Supplier<String> msgSupplier)
static void	entering(String sourceClass, String sourceMethod)
static void	entering(String sourceClass, String sourceMethod, Object param1)
static void	entering(String sourceClass, String sourceMethod, Object[] params)
static void	exiting(String sourceClass, String sourceMethod)
static void	exiting(String sourceClass, String sourceMethod, Object result)
static void	fine(String msg)
static void	fine(java.util.function.Supplier<String> msgSupplier)
static void	finer(String msg)
static void	finer(java.util.function.Supplier<String> msgSupplier)
static void	finest(String msg)
static void	finest(java.util.function.Supplier<String> msgSupplier)
static Filter	getFilter()
static Handler[]	getHandlers()
static Level	getLevel()
static Logger	getLogger() Returns the current Logger in use by the plugin calling this method
static String	getName()
static Logger	getParent()
static ResourceBundle	getResourceBundle()
static String	getResourceBundleName()
static boolean	getUseParentHandlers()
static void	info(String msg)
static void	info(java.util.function.Supplier<String> msgSupplier)
static boolean	isLoggable(Level level)
static void	log(Level level, String msg)
static void	log(Level level, String msg, Object param1)
static void	log(Level level, String msg, Object[] params)
static void	log(Level level, String msg, Throwable thrown)
static void	log(Level level, java.util.function.Supplier<String> msgSupplier)
static void	log(Level level, Throwable thrown, java.util.function.Supplier<String> msgSupplier)
static void	log(LogRecord record)
static void	logp(Level level, String sourceClass, String sourceMethod, String msg)
static void	logp(Level level, String sourceClass, String sourceMethod, String msg, Object param1)
static void	logp(Level level, String sourceClass, String sourceMethod, String msg, Object[] params)
static void	logp(Level level, String sourceClass, String sourceMethod, String msg, Throwable thrown)
static void	logp(Level level, String sourceClass, String sourceMethod, java.util.function.Supplier<String> msgSupplier)
static void	logp(Level level, String sourceClass, String sourceMethod, Throwable thrown, java.util.function.Supplier<String> msgSupplier)
static void	logrb(Level level, String sourceClass, String sourceMethod, ResourceBundle bundle, String msg, Object... params)
static void	logrb(Level level, String sourceClass, String sourceMethod, ResourceBundle bundle, String msg, Throwable thrown)
static void	logrb(Level level, String sourceClass, String sourceMethod, String bundleName, String msg)
static void	logrb(Level level, String sourceClass, String sourceMethod, String bundleName, String msg, Object param1)
static void	logrb(Level level, String sourceClass, String sourceMethod, String bundleName, String msg, Object[] params)
static void	logrb(Level level, String sourceClass, String sourceMethod, String bundleName, String msg, Throwable thrown)
static void	removeHandler(Handler handler)
static void	setFilter(Filter newFilter)
static void	setLevel(Level newLevel)
static void	setParent(Logger parent)
static void	setResourceBundle(ResourceBundle bundle)
static void	setUseParentHandlers(boolean useParentHandlers)
static void	severe(String msg)
static void	severe(java.util.function.Supplier<String> msgSupplier)
static Logging.LoggingFacade	simple() Returns a Logging.LoggingFacade which allows for simpler methods of printing via Logging
static void	throwing(String sourceClass, String sourceMethod, Throwable thrown)
static void	warning(String msg)
static void	warning(java.util.function.Supplier<String> msgSupplier)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getLogger

public static Logger getLogger()

Returns the current Logger in use by the plugin calling this method

Returns:

See original Logger implementationThe relevant Logger for the plugin that calls this method

Since:

0.1.0

simple

public static Logging.LoggingFacade simple()

Returns a Logging.LoggingFacade which allows for simpler methods of printing via Logging

Returns:

See original Logger implementationA Logging.LoggingFacade with the plugin's logger

Since:

0.1.0

addHandler

public static void addHandler(Handler handler)
                       throws SecurityException

Parameters:

handler - See original Logger implementation

Throws:

SecurityException

See Also:

Logger.addHandler(Handler)

config

public static void config(String msg)

Parameters:

msg - See original Logger implementation

See Also:

Logger.config(String)

config

public static void config(java.util.function.Supplier<String> msgSupplier)

Parameters:

msgSupplier - See original Logger implementation

See Also:

Logger.config(Supplier)

entering

public static void entering(String sourceClass,
                            String sourceMethod)

Parameters:

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

See Also:

Logger.entering(String, String)

entering

public static void entering(String sourceClass,
                            String sourceMethod,
                            Object param1)

Parameters:

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

param1 - See original Logger implementation

See Also:

Logger.entering(String, String, Object)

entering

public static void entering(String sourceClass,
                            String sourceMethod,
                            Object[] params)

Parameters:

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

params - See original Logger implementation

See Also:

Logger.entering(String, String, Object[])

exiting

public static void exiting(String sourceClass,
                           String sourceMethod)

Parameters:

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

See Also:

Logger.exiting(String, String)

exiting

public static void exiting(String sourceClass,
                           String sourceMethod,
                           Object result)

Parameters:

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

result - See original Logger implementation

See Also:

Logger.exiting(String, String, Object)

fine

public static void fine(String msg)

Parameters:

msg - See original Logger implementation

See Also:

Logger.fine(String)

fine

public static void fine(java.util.function.Supplier<String> msgSupplier)

Parameters:

msgSupplier - See original Logger implementation

See Also:

Logger.fine(Supplier)

finer

public static void finer(String msg)

Parameters:

msg - See original Logger implementation

See Also:

Logger.finer(String)

finer

public static void finer(java.util.function.Supplier<String> msgSupplier)

Parameters:

msgSupplier - See original Logger implementation

See Also:

Logger.finer(Supplier)

finest

public static void finest(String msg)

Parameters:

msg - See original Logger implementation

See Also:

Logger.finest(String)

finest

public static void finest(java.util.function.Supplier<String> msgSupplier)

Parameters:

msgSupplier - See original Logger implementation

See Also:

Logger.finest(Supplier)

getFilter

public static Filter getFilter()

Returns:

See original Logger implementation

See Also:

Logger.getFilter()

getHandlers

public static Handler[] getHandlers()

Returns:

See original Logger implementation

See Also:

Logger.getHandlers()

getLevel

public static Level getLevel()

Returns:

See original Logger implementation

See Also:

Logger.getLevel()

getName

public static String getName()

Returns:

See original Logger implementation

See Also:

Logger.getName()

getParent

public static Logger getParent()

Returns:

See original Logger implementation

See Also:

Logger.getParent()

getResourceBundle

public static ResourceBundle getResourceBundle()

Returns:

See original Logger implementation

See Also:

Logger.getResourceBundle()

getResourceBundleName

public static String getResourceBundleName()

Returns:

See original Logger implementation

See Also:

Logger.getResourceBundleName()

getUseParentHandlers

public static boolean getUseParentHandlers()

Returns:

See original Logger implementation

See Also:

Logger.getUseParentHandlers()

info

public static void info(String msg)

Parameters:

msg - See original Logger implementation

See Also:

Logger.info(String)

info

public static void info(java.util.function.Supplier<String> msgSupplier)

Parameters:

msgSupplier - See original Logger implementation

See Also:

Logger.info(Supplier)

isLoggable

public static boolean isLoggable(Level level)

Parameters:

level - See original Logger implementation

Returns:

See original Logger implementation

See Also:

Logger.isLoggable(Level)

log

public static void log(LogRecord record)

Parameters:

record - See original Logger implementation

See Also:

Logger.log(LogRecord)

log

public static void log(Level level,
                       String msg)

Parameters:

level - See original Logger implementation

msg - See original Logger implementation

See Also:

Logger.log(Level, String)

log

public static void log(Level level,
                       java.util.function.Supplier<String> msgSupplier)

Parameters:

level - See original Logger implementation

msgSupplier - See original Logger implementation

See Also:

Logger.log(Level, Supplier)

log

public static void log(Level level,
                       String msg,
                       Object param1)

Parameters:

level - See original Logger implementation

msg - See original Logger implementation

param1 - See original Logger implementation

See Also:

Logger.log(Level, String, Object)

log

public static void log(Level level,
                       String msg,
                       Object[] params)

Parameters:

level - See original Logger implementation

msg - See original Logger implementation

params - See original Logger implementation

See Also:

Logger.log(Level, String, Object[])

log

public static void log(Level level,
                       String msg,
                       Throwable thrown)

Parameters:

level - See original Logger implementation

msg - See original Logger implementation

thrown - See original Logger implementation

See Also:

Logger.log(Level, String, Throwable)

log

public static void log(Level level,
                       Throwable thrown,
                       java.util.function.Supplier<String> msgSupplier)

Parameters:

level - See original Logger implementation

thrown - See original Logger implementation

msgSupplier - See original Logger implementation

See Also:

Logger.log(Level, Throwable, Supplier)

logp

public static void logp(Level level,
                        String sourceClass,
                        String sourceMethod,
                        String msg)

Parameters:

level - See original Logger implementation

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

msg - See original Logger implementation

See Also:

Logger.logp(Level, String, String, String)

logp

public static void logp(Level level,
                        String sourceClass,
                        String sourceMethod,
                        java.util.function.Supplier<String> msgSupplier)

Parameters:

level - See original Logger implementation

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

msgSupplier - See original Logger implementation

See Also:

Logger.logp(Level, String, String, Supplier)

logp

public static void logp(Level level,
                        String sourceClass,
                        String sourceMethod,
                        String msg,
                        Object param1)

Parameters:

level - See original Logger implementation

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

msg - See original Logger implementation

param1 - See original Logger implementation

See Also:

Logger.logp(Level, String, String, String, Object)

logp

public static void logp(Level level,
                        String sourceClass,
                        String sourceMethod,
                        String msg,
                        Object[] params)

Parameters:

level - See original Logger implementation

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

msg - See original Logger implementation

params - See original Logger implementation

See Also:

Logger.logp(Level, String, String, String, Object[])

logp

public static void logp(Level level,
                        String sourceClass,
                        String sourceMethod,
                        String msg,
                        Throwable thrown)

Parameters:

level - See original Logger implementation

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

msg - See original Logger implementation

thrown - See original Logger implementation

See Also:

Logger.logp(Level, String, String, String, Throwable)

logp

public static void logp(Level level,
                        String sourceClass,
                        String sourceMethod,
                        Throwable thrown,
                        java.util.function.Supplier<String> msgSupplier)

Parameters:

level - See original Logger implementation

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

thrown - See original Logger implementation

msgSupplier - See original Logger implementation

See Also:

Logger.logp(Level, String, String, Throwable, Supplier)

logrb

public static void logrb(Level level,
                         String sourceClass,
                         String sourceMethod,
                         String bundleName,
                         String msg)

Parameters:

level - See original Logger implementation

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

bundleName - See original Logger implementation

msg - See original Logger implementation

See Also:

Logger.logrb(Level, String, String, String, String)

logrb

public static void logrb(Level level,
                         String sourceClass,
                         String sourceMethod,
                         ResourceBundle bundle,
                         String msg,
                         Object... params)

Parameters:

level - See original Logger implementation

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

bundle - See original Logger implementation

msg - See original Logger implementation

params - See original Logger implementation

See Also:

Logger.logrb(Level, String, String, ResourceBundle, String, Object...)

logrb

public static void logrb(Level level,
                         String sourceClass,
                         String sourceMethod,
                         ResourceBundle bundle,
                         String msg,
                         Throwable thrown)

Parameters:

level - See original Logger implementation

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

bundle - See original Logger implementation

msg - See original Logger implementation

thrown - See original Logger implementation

See Also:

Logger.logrb(Level, String, String, ResourceBundle, String, Throwable)

logrb

public static void logrb(Level level,
                         String sourceClass,
                         String sourceMethod,
                         String bundleName,
                         String msg,
                         Object param1)

Parameters:

level - See original Logger implementation

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

bundleName - See original Logger implementation

msg - See original Logger implementation

param1 - See original Logger implementation

See Also:

Logger.logrb(Level, String, String, String, String, Object)

logrb

public static void logrb(Level level,
                         String sourceClass,
                         String sourceMethod,
                         String bundleName,
                         String msg,
                         Object[] params)

Parameters:

level - See original Logger implementation

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

bundleName - See original Logger implementation

msg - See original Logger implementation

params - See original Logger implementation

See Also:

Logger.logrb(Level, String, String, String, String, Object[])

logrb

public static void logrb(Level level,
                         String sourceClass,
                         String sourceMethod,
                         String bundleName,
                         String msg,
                         Throwable thrown)

Parameters:

level - See original Logger implementation

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

bundleName - See original Logger implementation

msg - See original Logger implementation

thrown - See original Logger implementation

See Also:

Logger.logrb(Level, String, String, String, String, Throwable)

removeHandler

public static void removeHandler(Handler handler)
                          throws SecurityException

Parameters:

handler - See original Logger implementation

Throws:

SecurityException

See Also:

Logger.removeHandler(Handler)

setFilter

public static void setFilter(Filter newFilter)
                      throws SecurityException

Parameters:

newFilter - See original Logger implementation

Throws:

SecurityException

See Also:

Logger.setFilter(Filter)

setLevel

public static void setLevel(Level newLevel)
                     throws SecurityException

Parameters:

newLevel - See original Logger implementation

Throws:

SecurityException

See Also:

Logger.setLevel(Level)

setParent

public static void setParent(Logger parent)

Parameters:

parent - See original Logger implementation

See Also:

Logger.setParent(Logger)

setResourceBundle

public static void setResourceBundle(ResourceBundle bundle)

Parameters:

bundle - See original Logger implementation

See Also:

Logger.setResourceBundle(ResourceBundle)

setUseParentHandlers

public static void setUseParentHandlers(boolean useParentHandlers)

Parameters:

useParentHandlers - See original Logger implementation

See Also:

Logger.setUseParentHandlers(boolean)

severe

public static void severe(String msg)

Parameters:

msg - See original Logger implementation

See Also:

Logger.severe(String)

severe

public static void severe(java.util.function.Supplier<String> msgSupplier)

Parameters:

msgSupplier - See original Logger implementation

See Also:

Logger.severe(Supplier)

throwing

public static void throwing(String sourceClass,
                            String sourceMethod,
                            Throwable thrown)

Parameters:

sourceClass - See original Logger implementation

sourceMethod - See original Logger implementation

thrown - See original Logger implementation

See Also:

Logger.throwing(String, String, Throwable)

warning

public static void warning(String msg)

Parameters:

msg - See original Logger implementation

See Also:

Logger.warning(String)

warning

public static void warning(java.util.function.Supplier<String> msgSupplier)

Parameters:

msgSupplier - See original Logger implementation

See Also:

Logger.warning(Supplier)