uk.co.strangeskies.reflection

Class Imports

java.lang.Object

uk.co.strangeskies.reflection.Imports

public class Imports
extends java.lang.Object

An immutable set of imports of java classes.

Method Summary

Modifier and Type	Method and Description
static Imports	empty()
static Imports	empty(java.lang.ClassLoader classLoader)
boolean	equals(java.lang.Object that)
java.lang.String	getClassName(java.lang.Class<?> clazz) Resolve the name of a class object, allowing full package qualification to be omitted for included classes.
java.util.Set<java.lang.Class<?>>	getImportedClasses() Get all classes directly imported by this set of imports.
java.util.Set<java.lang.Package>	getImportedPackages() Get all packages imported by this set of imports.
java.lang.Class<?>	getNamedClass(java.lang.String name) Resolve the class object of the given name, allowing full package qualification to be omitted for included classes.
java.lang.Class<?>	getNamedClass(java.lang.String name, java.lang.ClassLoader classLoader) Resolve the class object of the given name, allowing full package qualification to be omitted for included classes.
int	hashCode()
boolean	isImported(java.lang.Class<?> clazz) Determine whether a class is imported by this Imports instance.
java.lang.String	toString()
Imports	withImport(java.lang.Class<?> classImport) Derive a new set of imports, including the given class import.
Imports	withImports(java.lang.Class<?>... classes) Derive a new set of imports, including the given class imports.
Imports	withImports(java.util.Collection<? extends java.lang.Class<?>> classes) Derive a new set of imports, including the given class imports.
Imports	withPackageImport(java.lang.Package packageImport) Derive a new set of imports, including the given package import.
Imports	withPackageImports(java.util.Collection<? extends java.lang.Package> packages) Derive a new set of imports, including the given package imports.
Imports	withPackageImports(java.lang.Package... packages) Derive a new set of imports, including the given package imports.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

equals

public boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

withImport

public Imports withImport(java.lang.Class<?> classImport)

Derive a new set of imports, including the given class import.

Parameters:

classImport - A class import with which to derive a new set of imports.

Returns:

A new set of imports including all those on the receiver, along with the given class import.

withImports

public Imports withImports(java.lang.Class<?>... classes)

Derive a new set of imports, including the given class imports.

Parameters:

classes - Class imports with which to derive a new set of imports.

Returns:

A new set of imports including all those on the receiver, along with the given class imports.

withImports

public Imports withImports(java.util.Collection<? extends java.lang.Class<?>> classes)

Derive a new set of imports, including the given class imports.

Parameters:

classes - Class imports with which to derive a new set of imports.

Returns:

A new set of imports including all those on the receiver, along with the given class imports.

getImportedClasses

public java.util.Set<java.lang.Class<?>> getImportedClasses()

Get all classes directly imported by this set of imports.

Returns:

A set of all direct class imports.

getNamedClass

public java.lang.Class<?> getNamedClass(java.lang.String name)

Resolve the class object of the given name, allowing full package qualification to be omitted for included classes.

Parameters:

name - The name for which we wish to find the class object.

Returns:

A class object satisfying the given name according to this set of imports.

getNamedClass

public java.lang.Class<?> getNamedClass(java.lang.String name,
                                        java.lang.ClassLoader classLoader)

Resolve the class object of the given name, allowing full package qualification to be omitted for included classes.

Parameters:

name - The name for which we wish to find the class object.

classLoader - The class loader with which to attempt to load the class of the given name. If null, the class loader of the calling class will be used.

Returns:

A class object satisfying the given name according to this set of imports.

getClassName

public java.lang.String getClassName(java.lang.Class<?> clazz)

Resolve the name of a class object, allowing full package qualification to be omitted for included classes.

Parameters:

clazz - The class of which we wish to find the name.

Returns:

A name for the given class object according to this set of imports.

withPackageImport

public Imports withPackageImport(java.lang.Package packageImport)

Derive a new set of imports, including the given package import.

Parameters:

packageImport - A package import with which to derive a new set of imports.

Returns:

A new set of imports including all those on the receiver, along with the given package import.

withPackageImports

public Imports withPackageImports(java.lang.Package... packages)

Derive a new set of imports, including the given package imports.

Parameters:

packages - Package imports with which to derive a new set of imports.

Returns:

A new set of imports including all those on the receiver, along with the given package imports.

withPackageImports

public Imports withPackageImports(java.util.Collection<? extends java.lang.Package> packages)

Derive a new set of imports, including the given package imports.

Parameters:

packages - Package imports with which to derive a new set of imports.

Returns:

A new set of imports including all those on the receiver, along with the given package imports.

getImportedPackages

public java.util.Set<java.lang.Package> getImportedPackages()

Get all packages imported by this set of imports.

Returns:

A set of all package imports.

empty

public static Imports empty()

Returns:

An empty Imports instance.

empty

public static Imports empty(java.lang.ClassLoader classLoader)

Parameters:

classLoader - the class loader to find classes with

Returns:

An empty Imports instance.

isImported

public boolean isImported(java.lang.Class<?> clazz)

Determine whether a class is imported by this Imports instance.

Parameters:

clazz - The class whose status we wish to determine.

Returns:

True if the class is imported by this Imports instance, either directly, or indirectly through a package import, and false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object