org.intellimate.izou.util

Class IzouModule

java.lang.Object

org.intellimate.izou.util.IzouModule

All Implemented Interfaces:

Identifiable, MainProvider

Direct Known Subclasses:

ActivatorManager, AddOnManager, EventDistributor, FileManager, FilePublisher, FileSystemManager, InternalIdentificationManager, IzouSoundLineBaseClass, LocalEventManager, OutputManager, PermissionManager, PermissionModule, ResourceManager, SecureStorage, SoundManager, SystemInitializer, ThreadPoolManager

public abstract class IzouModule
extends Object
implements MainProvider, Identifiable

The base class for each IzouModule FIXME: What is an izou module exactly?

Version:

1.0

Author:

Leander Kurscheidt

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.logging.log4j.spi.AbstractLogger	log
protected Main	main

Constructor Summary

Constructors

Constructor and Description
IzouModule(Main main)
IzouModule(Main main, boolean register)

Method Summary

Modifier and Type	Method and Description
void	debug(String msg) Used to log messages at debug level
void	debug(String msg, Throwable e) Used to log messages at debug level
void	error(String msg) Used to log messages at error level
void	error(String msg, Throwable e) Used to log messages at error level
void	fatal(String msg) Used to log messages at fatal level
void	fatal(String msg, Throwable e) Used to log messages at fatal level
String	getID() An ID must always be unique.
Main	getMain() returns the instance of Main

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.intellimate.izou.identification.Identifiable

isOwner

Field Detail

main

protected Main main

log

protected final org.apache.logging.log4j.spi.AbstractLogger log

Constructor Detail

IzouModule

public IzouModule(Main main)

IzouModule

public IzouModule(Main main,
                  boolean register)

Method Detail

getMain

public Main getMain()

returns the instance of Main

Specified by:

getMain in interface MainProvider

Returns:

Main

debug

public void debug(String msg,
                  Throwable e)

Used to log messages at debug level

Specified by:

debug in interface MainProvider

Parameters:

msg - the message

e - the Throwable

debug

public void debug(String msg)

Used to log messages at debug level

Specified by:

debug in interface MainProvider

Parameters:

msg - the message

error

public void error(String msg,
                  Throwable e)

Used to log messages at error level

Specified by:

error in interface MainProvider

Parameters:

msg - the message

e - the Throwable

error

public void error(String msg)

Used to log messages at error level

Specified by:

error in interface MainProvider

Parameters:

msg - the message

fatal

public void fatal(String msg)

Used to log messages at fatal level

Specified by:

fatal in interface MainProvider

Parameters:

msg - the message

fatal

public void fatal(String msg,
                  Throwable e)

Used to log messages at fatal level

Specified by:

fatal in interface MainProvider

Parameters:

msg - the message

e - the Throwable

getID

public String getID()

An ID must always be unique. A Class like Activator or OutputPlugin can just provide their .class.getCanonicalName() If you have to implement this interface multiple times, just concatenate unique Strings to .class.getCanonicalName()

Specified by:

getID in interface Identifiable

Returns:

A String containing an ID