Class JavaModule

    • Field Summary

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

      Constructors 
      Modifier Constructor Description
      protected JavaModule​(java.lang.Object module)
      Creates a new Java module representation.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addReads​(java.lang.instrument.Instrumentation instrumentation, JavaModule module)
      Adds a read-edge to this module to the supplied module using the instrumentation API.
      boolean canRead​(JavaModule module)
      Checks if this module can read the exported packages of the supplied module.
      boolean equals​(java.lang.Object other)  
      java.lang.String getActualName()
      Returns the name of this element as it is found in the source code.
      java.lang.ClassLoader getClassLoader()
      Returns the class loader of this module.
      java.io.InputStream getResourceAsStream​(java.lang.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 isNamed()
      Returns true if this element has an explicit name.
      static boolean isSupported()
      Checks if the current VM supports the java.lang.Module API.
      static JavaModule of​(java.lang.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​(java.lang.Class<?> type)
      Returns a representation of the supplied type's java.lang.Module or null if the current VM does not support modules.
      java.lang.String toString()  
      java.lang.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​(java.lang.Object module)
        Creates a new Java module representation.
        Parameters:
        module - The java.lang.Module instance this wrapper represents.
    • Method Detail

      • ofType

        public static JavaModule ofType​(java.lang.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​(java.lang.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.
      • getActualName

        public java.lang.String getActualName()
        Description copied from interface: NamedElement
        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 java.io.InputStream getResourceAsStream​(java.lang.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 java.lang.ClassLoader getClassLoader()
        Returns the class loader of this module.
        Returns:
        The class loader of the represented module.
      • unwrap

        public java.lang.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.
      • addReads

        public void addReads​(java.lang.instrument.Instrumentation instrumentation,
                             JavaModule module)
        Adds a read-edge to this module to the supplied module using the instrumentation API.
        Parameters:
        instrumentation - The instrumentation instance to use for adding the edge.
        module - The module to add as a read dependency to this module.
      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object