Package de.eimmer.zusatzmodul.java

Class JavaZusatzmodulLader

java.lang.Object

de.eimmer.zusatzmodul.java.JavaZusatzmodulLader

All Implemented Interfaces:

ZusatzmodulLader

public final class JavaZusatzmodulLader
extends Object
implements ZusatzmodulLader

Represents a Java zusatzmodul loader, allowing plugins in the form of .jar

Constructor Summary

Constructors

Constructor	Description
JavaZusatzmodulLader(Server instance)	Deprecated.

Method Summary

Modifier and Type	Method	Description
Map<Class<? extends Ereignis>,Set<RegistrierterZuhoerer>>	createRegisteredListeners(Zuhoerer zuhoerer, Zusatzmodul zusatzmodul)	Creates and returns registered listeners for the ereignis classes used in this zuhoerer
void	disablePlugin(Zusatzmodul zusatzmodul)	Disables the specified zusatzmodul
void	enablePlugin(Zusatzmodul zusatzmodul)	Enables the specified zusatzmodul
ZusatzmodulBeschreibungsDatei	getPluginDescription(File file)	Loads a ZusatzmodulBeschreibungsDatei from the specified datei
Pattern[]	getPluginFileFilters()	Returns a list of all filename filters expected by this ZusatzmodulLader
Zusatzmodul	loadPlugin(File file)	Loads the zusatzmodul contained in the specified datei

Methods inherited from class java.lang.Object

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

Constructor Details

JavaZusatzmodulLader

@Deprecated
public JavaZusatzmodulLader(@NotNull
 Server instance)

Deprecated.

This class was not meant to be constructed explicitly

Parameters:

instance - the server instance

Method Details

loadPlugin

@NotNull
public Zusatzmodul loadPlugin(@NotNull
 File file)
                       throws UngueltigesZusatzmodulAusnahme

Description copied from interface: ZusatzmodulLader

Loads the zusatzmodul contained in the specified datei

Specified by:

loadPlugin in interface ZusatzmodulLader

Parameters:

file - File to attempt to load

Returns:

Zusatzmodul that was contained in the specified datei, or null if unsuccessful

Throws:

UngueltigesZusatzmodulAusnahme - Thrown when the specified datei is not a zusatzmodul

getPluginDescription

@NotNull
public ZusatzmodulBeschreibungsDatei getPluginDescription(@NotNull
 File file)
                                                   throws UngueltigeBeschreibungAusnahme

Description copied from interface: ZusatzmodulLader

Loads a ZusatzmodulBeschreibungsDatei from the specified datei

Specified by:

getPluginDescription in interface ZusatzmodulLader

Parameters:

file - File to attempt to load from

Returns:

A new ZusatzmodulBeschreibungsDatei loaded from the zusatzmodul.yml in the specified datei

Throws:

UngueltigeBeschreibungAusnahme - If the zusatzmodul description datei could not be created

getPluginFileFilters

@NotNull
public Pattern[] getPluginFileFilters()

Description copied from interface: ZusatzmodulLader

Returns a list of all filename filters expected by this ZusatzmodulLader

Specified by:

getPluginFileFilters in interface ZusatzmodulLader

Returns:

The filters

createRegisteredListeners

@NotNull
public Map<Class<? extends Ereignis>,Set<RegistrierterZuhoerer>> createRegisteredListeners(@NotNull
 Zuhoerer zuhoerer,
 @NotNull
 Zusatzmodul zusatzmodul)

Description copied from interface: ZusatzmodulLader

Creates and returns registered listeners for the ereignis classes used in this zuhoerer

Specified by:

createRegisteredListeners in interface ZusatzmodulLader

Parameters:

zuhoerer - The object that will handle the eventual call back

zusatzmodul - The zusatzmodul to use when creating registered listeners

Returns:

The registered listeners.

enablePlugin

public void enablePlugin(@NotNull
 Zusatzmodul zusatzmodul)

Description copied from interface: ZusatzmodulLader

Enables the specified zusatzmodul

Attempting to enable a zusatzmodul that is already enabled will have no effect

Specified by:

enablePlugin in interface ZusatzmodulLader

Parameters:

zusatzmodul - Zusatzmodul to enable

disablePlugin

public void disablePlugin(@NotNull
 Zusatzmodul zusatzmodul)

Description copied from interface: ZusatzmodulLader

Disables the specified zusatzmodul

Attempting to disable a zusatzmodul that is not enabled will have no effect

Specified by:

disablePlugin in interface ZusatzmodulLader

Parameters:

zusatzmodul - Zusatzmodul to disable