org.rvpf.base

Interface ClassDef

All Known Implementing Classes:

ClassDefEntity, ClassDefEntity.Undefined, ClassDefImpl

public interface ClassDef

Class definition.

Class definitions wrap the handling of run time references to classes.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ClassDef.Loader Loader.

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.

Method Detail

createInstance

@Nullable
 @CheckReturnValue
<T> T createInstance(@Nonnull
                                                    Class<T> expectedClass)

Creates an instance of the class.

Uses the class returned by 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.

Type Parameters:

T - The type of the returned value.

Parameters:

expectedClass - The expected class.

Returns:

The instance (null on failure).

getClassName

@Nonnull
 @CheckReturnValue
String getClassName()

Gets the referenced class name.

Returns:

The referenced class name.

getInstanceClass

@Nullable
 @CheckReturnValue
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.

Returns:

The requested class (null on failure).

getInstanceClass

@Nullable
 @CheckReturnValue
Class<?> getInstanceClass(@Nonnull
                                                         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.

Parameters:

classLoader - The optional class loader to use.

Returns:

The requested class (null on failure).

getMember

@Nonnull
 @CheckReturnValue
String getMember()

Gets the package member name for the class.

Returns:

The class name without the package specification.

getPackageName

@Nonnull
 @CheckReturnValue
String getPackageName()

Gets the package name for the class.

Returns:

The name of the package containing the class.

isLoaded

@CheckReturnValue
boolean isLoaded()

Asks if the class has been loaded.

Returns:

True if the class has been loaded.