de.skuzzle.tinyplugz.util

Class ExchangeClassLoader

java.lang.Object

de.skuzzle.tinyplugz.util.ExchangeClassLoader

All Implemented Interfaces:

AutoCloseable

public final class ExchangeClassLoader
extends Object
implements AutoCloseable

Used to define a scoped action during which the context Classloader is exchanged for another one. After the action has been done, the previous Classloader will be restored. Use this in a try-resources block like:

 try (ExchangeClassLoader exchange = ExchangeClassLoader.forTinyPlugz()) {
     // perform scoped actions here
 }
 

Since:

0.2.0

Author:

Simon Taddiken

Method Summary

Modifier and Type	Method and Description
void	close()
static ExchangeClassLoader	forTinyPlugz() If TinyPlugz is deployed, the context ClassLoader is exchanged for TinyPlugz's Classloader.
void	setFailOnChange(boolean failOnChange) Sets whether close() throws an exception if it detects that the context Classloader has been exchanged by a 3rd party.
static ExchangeClassLoader	with(@NonNull ClassLoader classLoader) Exchanges the context ClassLoader with the given one until close() is called.

Methods inherited from class java.lang.Object

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

Method Detail

with

public static ExchangeClassLoader with(@NonNull ClassLoader classLoader)

Exchanges the context ClassLoader with the given one until close() is called.

Parameters:

classLoader - The Classloader to employ.

Returns:

The ExchangeClassLoader object to use in a try-resources block.

forTinyPlugz

public static ExchangeClassLoader forTinyPlugz()

If TinyPlugz is deployed, the context ClassLoader is exchanged for TinyPlugz's Classloader. Otherwise, it will not be changed.

Returns:

The ExchangeClassLoader object to use in a try-resources block.

setFailOnChange

public void setFailOnChange(boolean failOnChange)

Sets whether close() throws an exception if it detects that the context Classloader has been exchanged by a 3rd party.

Parameters:

failOnChange - Whether to fail on unexpected Classloader exchange.

close

public final void close()

Specified by:

close in interface AutoCloseable