net.bytebuddy.utility

Class JavaModule

java.lang.Object

net.bytebuddy.utility.JavaModule

All Implemented Interfaces:

AnnotationSource, NamedElement, NamedElement.WithOptionalName

public class JavaModule
extends Object
implements NamedElement.WithOptionalName, AnnotationSource

Type-safe representation of a java.lang.Module. On platforms that do not support the module API, modules are represented by null.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	JavaModule.Dispatcher A dispatcher for accessing the java.lang.Module API if it is available on the current VM.

Nested classes/interfaces inherited from interface net.bytebuddy.description.NamedElement

NamedElement.WithDescriptor, NamedElement.WithGenericName, NamedElement.WithOptionalName, NamedElement.WithRuntimeName

Nested classes/interfaces inherited from interface net.bytebuddy.description.annotation.AnnotationSource

AnnotationSource.Empty, AnnotationSource.Explicit

Field Summary

Fields

Modifier and Type	Field and Description
static JavaModule	UNSUPPORTED Canonical representation of a Java module on a JVM that does not support the module API.

Fields inherited from interface net.bytebuddy.description.NamedElement

EMPTY_NAME, NO_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JavaModule(AnnotatedElement module) Creates a new Java module representation.

Method Summary

Modifier and Type	Method and Description
boolean	canRead(JavaModule module) Checks if this module can read the exported packages of the supplied module.
boolean	equals(Object other)
String	getActualName() Returns the name of this element as it is found in the source code.
ClassLoader	getClassLoader() Returns the class loader of this module.
AnnotationList	getDeclaredAnnotations() Returns a list of annotations that are declared by this instance.
InputStream	getResourceAsStream(String name) Returns a resource stream for this module for a resource of the given name or null if such a resource does not exist.
int	hashCode()
boolean	isExported(PackageDescription packageDescription, JavaModule module) Returns true if this module exports the supplied package to this module.
boolean	isNamed() Returns true if this element has an explicit name.
boolean	isOpened(PackageDescription packageDescription, JavaModule module) Returns true if this module opens the supplied package to this module.
static boolean	isSupported() Checks if the current VM supports the java.lang.Module API.
void	modify(Instrumentation instrumentation, Set<JavaModule> reads, Map<String,Set<JavaModule>> exports, Map<String,Set<JavaModule>> opens, Set<Class<?>> uses, Map<Class<?>,List<Class<?>>> provides) Modifies this module's properties.
static JavaModule	of(Object module) Represents the supplied java.lang.Module as an instance of this class and validates that the supplied instance really represents a Java Module.
static JavaModule	ofType(Class<?> type) Returns a representation of the supplied type's java.lang.Module or null if the current VM does not support modules.
String	toString()
Object	unwrap() Unwraps this instance to a java.lang.Module.

Methods inherited from class java.lang.Object

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

Field Detail

UNSUPPORTED

public static final JavaModule UNSUPPORTED

Canonical representation of a Java module on a JVM that does not support the module API.

Constructor Detail

JavaModule

protected JavaModule(AnnotatedElement module)

Creates a new Java module representation.

Parameters:

module - The java.lang.Module instance this wrapper represents.

Method Detail

ofType

public static JavaModule ofType(Class<?> type)

Returns a representation of the supplied type's java.lang.Module or null if the current VM does not support modules.

Parameters:

type - The type for which to describe the module.

Returns:

A representation of the type's module or null if the current VM does not support modules.

of

public static JavaModule of(Object module)

Represents the supplied java.lang.Module as an instance of this class and validates that the supplied instance really represents a Java Module.

Parameters:

module - The module to represent.

Returns:

A representation of the supplied Java module.

isSupported

public static boolean isSupported()

Checks if the current VM supports the java.lang.Module API.

Returns:

true if the current VM supports modules.

isNamed

public boolean isNamed()

Returns true if this element has an explicit name.

Specified by:

isNamed in interface NamedElement.WithOptionalName

Returns:

true if this element has an explicit name.

getActualName

public String getActualName()

Returns the name of this element as it is found in the source code. If no such name exists, an empty string is returned.

Specified by:

getActualName in interface NamedElement

Returns:

The name of this element as given in a Java program's source code.

getResourceAsStream

public InputStream getResourceAsStream(String name)

Returns a resource stream for this module for a resource of the given name or null if such a resource does not exist.

Parameters:

name - The name of the resource.

Returns:

An input stream for the resource or null if it does not exist.

getClassLoader

public ClassLoader getClassLoader()

Returns the class loader of this module.

Returns:

The class loader of the represented module.

unwrap

public Object unwrap()

Unwraps this instance to a java.lang.Module.

Returns:

The represented java.lang.Module.

canRead

public boolean canRead(JavaModule module)

Checks if this module can read the exported packages of the supplied module.

Parameters:

module - The module to check for its readability by this module.

Returns:

true if this module can read the supplied module.

isExported

public boolean isExported(PackageDescription packageDescription,
                          JavaModule module)

Returns true if this module exports the supplied package to this module.

Parameters:

packageDescription - The package to check for

module - The target module.

Returns:

true if this module exports the supplied package to this module.

isOpened

public boolean isOpened(PackageDescription packageDescription,
                        JavaModule module)

Returns true if this module opens the supplied package to this module.

Parameters:

packageDescription - The package to check for.

module - The target module.

Returns:

true if this module opens the supplied package to this module.

getDeclaredAnnotations

public AnnotationList getDeclaredAnnotations()

Returns a list of annotations that are declared by this instance.

Specified by:

getDeclaredAnnotations in interface AnnotationSource

Returns:

A list of declared annotations.

modify

public void modify(Instrumentation instrumentation,
                   Set<JavaModule> reads,
                   Map<String,Set<JavaModule>> exports,
                   Map<String,Set<JavaModule>> opens,
                   Set<Class<?>> uses,
                   Map<Class<?>,List<Class<?>>> provides)

Modifies this module's properties.

Parameters:

instrumentation - The instrumentation instace to use for applying the modification.

reads - A set of additional modules this module should read.

exports - A map of packages to export to a set of modules.

opens - A map of packages to open to a set of modules.

uses - A set of provider interfaces to use by this module.

provides - A map of provider interfaces to provide by this module mapped to the provider implementations.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object