net.openhft.chronicle.core.pool

Class ClassAliasPool

java.lang.Object

net.openhft.chronicle.core.pool.ClassAliasPool

All Implemented Interfaces:

ClassLookup

public class ClassAliasPool
extends Object
implements ClassLookup

A class responsible for looking up classes and associating them with aliases for more convenient referencing. ClassAliasPool supports custom class loaders and allows for modification of its lookup data without affecting parent lookups.

Field Summary

Fields

Modifier and Type	Field and Description
static ClassAliasPool	CLASS_ALIASES

Method Summary

Modifier and Type	Method and Description
static void	a(Class<?>... classes)
static void	a(Class<?> clazz) Always throws an AssertionError for the given class.
void	addAlias(Class<?>... classes) Registers the provided classes using their simple names as aliases.
void	addAlias(Class<?> clazz, @NotNull String names) Registers a class with one or more explicit aliases.
CharSequence	applyAlias(CharSequence name) Applies an alias if one has been registered for the given name.
void	clean() Removes classes from the lookup which are not loaded by the default class loaders.
@NotNull Class<?>	forName(@NotNull CharSequence name) Looks up a class using its name or registered alias.
String	nameFor(Class<?> clazz) Returns the primary alias for a given class.
void	removePackage(String pkgName) Removes all aliases from the given package.
void	resetResolutionFailures() Clears any cached lookup failures so a subsequent search can retry.
protected static boolean	testPackage(String pkgName, Class<?> clazz)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.core.pool.ClassLookup

wrap, wrap

Field Detail

CLASS_ALIASES

public static final ClassAliasPool CLASS_ALIASES

Method Detail

a

public static void a(Class<?> clazz)

Always throws an AssertionError for the given class.

Parameters:

clazz - the class used to produce the error

Throws:

AssertionError - always thrown

testPackage

protected static boolean testPackage(String pkgName,
                                     Class<?> clazz)

clean

public void clean()

Removes classes from the lookup which are not loaded by the default class loaders. This is used to clean up the ClassAliasPool.

forName

@NotNull
public @NotNull Class<?> forName(@NotNull
                                          @NotNull CharSequence name)
                                   throws ClassNotFoundRuntimeException

Looks up a class using its name or registered alias.

Specified by:

forName in interface ClassLookup

Parameters:

name - the class name or alias

Returns:

the resolved class

Throws:

ClassNotFoundRuntimeException - if the class cannot be found

resetResolutionFailures

public void resetResolutionFailures()

Clears any cached lookup failures so a subsequent search can retry.

nameFor

public String nameFor(Class<?> clazz)
               throws IllegalArgumentException

Returns the primary alias for a given class.

Specified by:

nameFor in interface ClassLookup

Parameters:

clazz - the class to query

Returns:

the registered alias

Throws:

IllegalArgumentException - if the class represents a lambda

removePackage

public void removePackage(String pkgName)

Removes all aliases from the given package.

Parameters:

pkgName - the package prefix to remove

addAlias

public void addAlias(@NotNull
                     Class<?>... classes)

Registers the provided classes using their simple names as aliases.

Specified by:

addAlias in interface ClassLookup

Parameters:

classes - the classes to register

addAlias

public void addAlias(Class<?> clazz,
                     @NotNull
                     @NotNull String names)

Registers a class with one or more explicit aliases.

Specified by:

addAlias in interface ClassLookup

Parameters:

clazz - the class to register

names - comma separated list of aliases

applyAlias

public CharSequence applyAlias(CharSequence name)

Applies an alias if one has been registered for the given name.

Specified by:

applyAlias in interface ClassLookup

Parameters:

name - the original class name or alias

Returns:

the resolved alias or the input if none exists

See Also:

for how aliases are added to the pool.

a

public static void a(Class<?>... classes)