org.rvpf.base

Class ClassDefImpl

Object

ClassDefImpl

All Implemented Interfaces:

ClassDef

@ThreadSafe
public final class ClassDefImpl
extends Object
implements ClassDef

Provides a class definition implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface ClassDef

ClassDef.Loader

Constructor Summary

Constructors

Constructor and Description
ClassDefImpl(Class<?> aClass) Constructs an instance.
ClassDefImpl(String className) Constructs an instance.
ClassDefImpl(String packageName, String member) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
<T> T	createInstance(Class<T> expectedClass) Creates an instance of the class.
String	getClassName() Gets the referenced class name.
Class<?>	getInstanceClass() Gets the class of instances created by this class definition.
Class<?>	getInstanceClass(Optional<ClassLoader> classLoader) Gets the class of instances created by this class definition.
String	getMember() Gets the package member name for the class.
String	getPackageName() Gets the package name for the class.
boolean	isLoaded() Asks if the class has been loaded.
String	toString() Returns a String representation of itself.

Methods inherited from class Object

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

Constructor Detail

ClassDefImpl

public ClassDefImpl(@Nonnull
                    Class<?> aClass)

Constructs an instance.

Used to create default class definitions.

Parameters:

aClass - A class object.

ClassDefImpl

public ClassDefImpl(@Nonnull
                    String className)

Constructs an instance.

Creates a class definition from a string.

Parameters:

className - The complete class name.

ClassDefImpl

public ClassDefImpl(@Nonnull
                    String packageName,
                    @Nonnull
                    String member)

Constructs an instance.

Parameters:

packageName - The name of the package containing the class.

member - The class name without the package specification.

Method Detail

createInstance

public <T> T createInstance(Class<T> expectedClass)

Creates an instance of the class.

Uses the class returned by ClassDef.getInstanceClass(), thus triggering the class loading if needed. If either the class loading or the instance creation fails, an error message is logged and a null value is returned.

Specified by:

createInstance in interface ClassDef

Type Parameters:

T - The type of the returned value.

Parameters:

expectedClass - The expected class.

Returns:

The instance (null on failure).

getClassName

public String getClassName()

Gets the referenced class name.

Specified by:

getClassName in interface ClassDef

Returns:

The referenced class name.

getInstanceClass

public Class<?> getInstanceClass()

Gets the class of instances created by this class definition.

If the class loading fails, an error message is logged and a null value is returned.

Specified by:

getInstanceClass in interface ClassDef

Returns:

The requested class (null on failure).

getInstanceClass

public Class<?> getInstanceClass(Optional<ClassLoader> classLoader)

Gets the class of instances created by this class definition.

If the class loading fails, an error message is logged and a null value is returned.

Specified by:

getInstanceClass in interface ClassDef

Parameters:

classLoader - The optional class loader to use.

Returns:

The requested class (null on failure).

getMember

public String getMember()

Gets the package member name for the class.

Specified by:

getMember in interface ClassDef

Returns:

The class name without the package specification.

getPackageName

public String getPackageName()

Gets the package name for the class.

Specified by:

getPackageName in interface ClassDef

Returns:

The name of the package containing the class.

isLoaded

public boolean isLoaded()

Asks if the class has been loaded.

Specified by:

isLoaded in interface ClassDef

Returns:

True if the class has been loaded.

toString

public String toString()

Returns a String representation of itself.

Overrides:

toString in class Object

Returns:

The name of its referenced Class.