org.macroing.cel4j.java.decompiler

Class Decompiler

java.lang.Object

org.macroing.cel4j.java.decompiler.Decompiler

public final class Decompiler
extends java.lang.Object

This Decompiler class is the main class in this Decompiler API.

This class is not thread-safe.

To use this class, consider the following example, that will print the decompiled source code to standard out:

 Decompiler decompiler = new Decompiler();
 decompiler.addClass(Integer.class);
 decompiler.decompile();
 

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors

Constructor and Description
Decompiler() Constructs a new default Decompiler instance.

Method Summary

Modifier and Type	Method and Description
void	addClass(java.lang.Class<?> clazz) Adds the given {@code Class
void	addClass(java.lang.Class<?> clazz, java.util.function.Consumer<java.lang.String> sourceConsumer) Adds the given {@code Class
void	addClass(java.lang.String className) Adds the given {@code Class
void	addClass(java.lang.String className, java.util.function.Consumer<java.lang.String> sourceConsumer) Adds the given {@code Class
void	decompile() Decompiles the class- and interface-types that were added to this Decompiler instance.
DecompilerObserver	getDecompilerObserver() Returns the currently assigned DecompilerObserver instance.
java.util.function.Consumer<java.lang.String>	getDefaultSourceConsumer() Returns the currently assigned default source Consumer<String>.
static Decompiler	newInstance() Returns a new default Decompiler instance.
void	setDecompilerObserver(DecompilerObserver decompilerObserver) Sets a new DecompilerObserver for this Decompiler instance.
void	setDefaultSourceConsumer(java.util.function.Consumer<java.lang.String> defaultSourceConsumer) Sets a new default source Consumer<String> for this Decompiler instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Decompiler

public Decompiler()

Constructs a new default Decompiler instance.

The initial default source Consumer<String> will print the source to standard out via a call to System.out.println(source).

Method Detail

getDefaultSourceConsumer

public java.util.function.Consumer<java.lang.String> getDefaultSourceConsumer()

Returns the currently assigned default source Consumer<String>.

If no default source Consumer<String> has been explicitly set by the user of this API, the initial default source Consumer<String> will print the source to standard out via a call to System.out.println(source).

This method will not return null.

Returns:

the currently assigned default source Consumer<String>

getDecompilerObserver

public DecompilerObserver getDecompilerObserver()

Returns the currently assigned DecompilerObserver instance.

If no DecompilerObserver has been explicitly set by the user of this API, the initial DecompilerObserver will not do anything.

This method will not return null.

Returns:

the currently assigned DecompilerObserver instance

addClass

public void addClass(java.lang.Class<?> clazz)

Adds the given Class<?> to be decompiled.

Calling this method is equivalent to calling decompiler.addClass(clazz, decompiler.getDefaultSourceConsumer()).

If clazz is null, a NullPointerException will be thrown.

Parameters:

clazz - the Class<?> to add

Throws:

java.lang.NullPointerException - thrown if, and only if, clazz is null

addClass

public void addClass(java.lang.Class<?> clazz,
                     java.util.function.Consumer<java.lang.String> sourceConsumer)

Adds the given Class<?> to be decompiled and the source Consumer<String> to hand its decompiled source code.

If either clazz or sourceConsumer are null, a NullPointerException will be thrown.

Parameters:

clazz - the Class<?> to add

sourceConsumer - the source Consumer<String> to hand the decompiled source code to

Throws:

java.lang.NullPointerException - thrown if, and only if, either clazz or sourceConsumer are null

addClass

public void addClass(java.lang.String className)
              throws java.lang.ClassNotFoundException

Adds the given Class<?> to be decompiled, given its fully qualified name.

Calling this method is equivalent to calling decompiler.addClass(className, decompiler.getDefaultSourceConsumer()).

If className is null, a NullPointerException will be thrown.

If no such class- or interface-type can be found, a ClassNotFoundException will be thrown.

Parameters:

className - the fully qualified name of the class- or interface-type to find

Throws:

java.lang.ClassNotFoundException - thrown if, and only if, no such class- or interface-type can be found

java.lang.NullPointerException - thrown if, and only if, className is null

addClass

public void addClass(java.lang.String className,
                     java.util.function.Consumer<java.lang.String> sourceConsumer)
              throws java.lang.ClassNotFoundException

Adds the given Class<?> to be decompiled, given its fully qualified name and the source Consumer<String> to hand its decompiled source code.

Calling this method is equivalent to calling decompiler.addClass(Class.forName(className), sourceConsumer).

If either className or sourceConsumer are null, a NullPointerException will be thrown.

If no such class- or interface-type can be found, a ClassNotFoundException will be thrown.

Parameters:

className - the fully qualified name of the class- or interface-type to find

sourceConsumer - the source Consumer<String> to hand the decompiled source code to

Throws:

java.lang.ClassNotFoundException - thrown if, and only if, no such class- or interface-type can be found

java.lang.NullPointerException - thrown if, and only if, either className or sourceConsumer are null

decompile

public void decompile()

Decompiles the class- and interface-types that were added to this Decompiler instance.

The methods to add the class- and interface-types are the following:

• addClass(Class<?>)
• addClass(Class<?>, Consumer<String>)
• addClass(String)
• addClass(String, Consumer<String>)

When the decompilation process is finished, the source code of the decompiled class- and interface-types will be handed to the source Consumer<String> instances that were given to each individual class- and interface-type, respectively.

If the decompilation process fails, a DecompilationException will be thrown.

Throws:

DecompilationException - thrown if, and only if, the decompilation process fails

setDecompilerObserver

public void setDecompilerObserver(DecompilerObserver decompilerObserver)

Sets a new DecompilerObserver for this Decompiler instance.

If no DecompilerObserver has been explicitly set by the user of this API, the initial DecompilerObserver will not do anything.

If decompilerObserver is null, a NullPointerException will be thrown.

Parameters:

decompilerObserver - the new DecompilerObserver

Throws:

java.lang.NullPointerException - thrown if, and only if, decompilerObserver is null

setDefaultSourceConsumer

public void setDefaultSourceConsumer(java.util.function.Consumer<java.lang.String> defaultSourceConsumer)

Sets a new default source Consumer<String> for this Decompiler instance.

If no default source Consumer<String> has been explicitly set by the user of this API, the initial default source Consumer<String> will print the source to standard out via a call to System.out.println(source).

If defaultSourceConsumer is null, a NullPointerException will be thrown.

Parameters:

defaultSourceConsumer - the new default source Consumer<String>

Throws:

java.lang.NullPointerException - thrown if, and only if, defaultSourceConsumer is null

newInstance

public static Decompiler newInstance()

Returns a new default Decompiler instance.

The initial default source Consumer<String> will print the source to standard out via a call to System.out.println(source).

Returns:

a new default Decompiler instance