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)
void	addAlias(Class<?>... classes) Adds one or more classes to the class lookup.
void	addAlias(Class<?> clazz, @NotNull String names) Adds a class to the class lookup with one or more specified aliases.
CharSequence	applyAlias(CharSequence name) Applies an alias transformation to the given class name if an alias exists.
void	clean() Removes classes from the lookup which are not loaded by the default class loaders.
@NotNull Class<?>	forName(@NotNull CharSequence name) Looks up and returns the Class object associated with the given class name.
String	nameFor(Class<?> clazz) Retrieves the alias for the given class.
void	removePackage(String pkgName)
void	resetResolutionFailures() A method to reset previous resolution failures so they may be reattempted, e.g.
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)

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

Description copied from interface: ClassLookup

Looks up and returns the Class object associated with the given class name.

Specified by:

forName in interface ClassLookup

Parameters:

name - The fully qualified name of the desired class.

Returns:

The Class object representing the specified class.

Throws:

ClassNotFoundRuntimeException - If the class cannot be located.

resetResolutionFailures

public void resetResolutionFailures()

A method to reset previous resolution failures so they may be reattempted, e.g. after significant classpath change.

nameFor

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

Description copied from interface: ClassLookup

Retrieves the alias for the given class. This method is intended for use with non-lambda classes. For lambda classes, this method will throw an IllegalArgumentException.

Specified by:

nameFor in interface ClassLookup

Parameters:

clazz - The class to retrieve the alias for.

Returns:

A String representing the alias for the given class.

Throws:

IllegalArgumentException - If this method is used on a lambda function.

removePackage

public void removePackage(String pkgName)

addAlias

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

Description copied from interface: ClassLookup

Adds one or more classes to the class lookup. For each class, its simple name (excluding package) is automatically added as the alias.

Specified by:

addAlias in interface ClassLookup

Parameters:

classes - The classes to be added to the class lookup.

addAlias

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

Description copied from interface: ClassLookup

Adds a class to the class lookup with one or more specified aliases. The aliases can be provided as a comma-separated string and may include the package name.

Specified by:

addAlias in interface ClassLookup

Parameters:

clazz - The class to be added to the class lookup.

names - A single alias or a comma-separated string of aliases for the class.

applyAlias

public CharSequence applyAlias(CharSequence name)

Description copied from interface: ClassLookup

Applies an alias transformation to the given class name if an alias exists. This method searches for an alias of the specified class name and returns the alias if found. If no alias is found, it returns the original class name. This mechanism allows for the flexible use of aliases in place of fully qualified class names, simplifying the referencing of classes within an application.

This method first looks up the provided class name in the internal alias mappings. If a direct match is found, it returns the corresponding class name as registered in the alias. If no direct match is found, it attempts to find a match using a case-insensitive search. This dual-step lookup ensures that aliases can be effectively used regardless of case sensitivity. If after both steps no alias is found, the method returns the original class name, ensuring that the operation is always safe and will not result in a loss of reference.

Usage of this method can significantly reduce the verbosity of class references in scenarios where short, memorable aliases are preferred over full class names. It is particularly useful in configuration files, dynamic class loading scenarios, or any context where class names are used as strings and brevity or clarity is desired.

Specified by:

applyAlias in interface ClassLookup

Parameters:

name - The CharSequence representing the class name or alias to be transformed.

Returns:

A CharSequence representing the aliased class name if an alias exists, or the original class name if no alias is found. This ensures that the method never returns null or an invalid class name.

See Also:

for how aliases are added to the pool.

a

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