ModuleMeta (diet4j 0.15 API)

java.lang.Object
- org.diet4j.core.ModuleMeta

```
public class ModuleMeta
extends Object
```
The metadata for a software Module.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JAR_RESOURCE_JAR_ENTRY_PREFIX` The resourceJarEntryPrefix for JAR files.
`protected String`	`theActivationClassName` The name of the Module activation/deactivation class.
`protected String`	`theModuleArtifactId` The artifactId of the module.
`protected long`	`theModuleBuildDate` The time when this Module was built.
`protected String`	`theModuleGroupId` The groupId of the module
`protected JarFile`	`theModuleJar` The JAR that this Module provides.
`protected ModuleLicense`	`theModuleLicense` The license of the Module.
`protected Map<String,String>`	`theModuleUserDescriptions` The user-visible descriptions for this Module, keyed by the locale.
`protected Map<String,String>`	`theModuleUserNames` The user-visible names for this Module, keyed by the locale.
`protected String`	`theModuleVersion` The version of the module.
`protected String`	`theResourceJarEntryPrefix` The relative path below which resources, such as a class files, are to be found.
`protected String`	`theRunClassName` The name of the class in this Module which provides a method to run this Module.
`protected ModuleRequirement[]`	`theRuntimeModuleRequirements` The requirements for other modules that this Module will have at run time.
`static String`	`UNPACKED_RESOURCE_JAR_ENTRY_PREFIX` The resourceJarEntryPrefix for unpacked directories.
`static String`	`WAR_RESOURCE_JAR_ENTRY_PREFIX` The resourceJarEntryPrefix for WAR files.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ModuleMeta(String moduleGroupId, String moduleArtifactId, String moduleVersion, Map<String,String> moduleUserNames, Map<String,String> moduleUserDescriptions, long moduleBuildDate, ModuleLicense license, ModuleRequirement[] runtimeModuleRequirements, JarFile moduleJar, String activationClassName, String runClassName)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Module`	`createModule(AbstractModuleRegistry registry, ClassLoader parentClassLoader)` Create a Module from this ModuleMeta.
`boolean`	`equals(Object other)` Two ModuleMetas are the same if they have the same name and version.
`String`	`getActivationClassName()` Obtain the name of the Module activation/deactivation class.
`String`	`getModuleArtifactId()` Obtain the artifactId of the Module.
`long`	`getModuleBuildDate()` Obtain the time at which this Module was built, in System.currentTimeMillis() format.
`String`	`getModuleGroupId()` Obtain the groupId of the Module.
`ModuleLicense`	`getModuleLicense()` Obtain the license for this Module.
`String`	`getModuleUserDescription(Locale loc)` Obtain the internationalized description of the Module in a specified locale.
`Map<String,String>`	`getModuleUserDescriptions()` Obtain the Map of internationalized descriptions of the Module.
`String`	`getModuleUserName()` Obtain the internationalized name of the Module in the current locale.
`String`	`getModuleUserName(Locale loc)` Obtain the internationalized name of the Module in a specified locale.
`Map<String,String>`	`getModuleUserNames()` Obtain the Map of internationalized names of the Module.
`String`	`getModuleVersion()` Obtain the version of this Module.
`JarFile`	`getProvidesJar()` Obtain the JAR file that this Module provides as JarFile.
`String`	`getResourceJarEntryPrefix()` Obtain the relative path below which resources, such as a class files, are to be found.
`String`	`getRunClassName()` Obtain the name of the class that contains the Module's run method.
`ModuleRequirement[]`	`getRuntimeModuleRequirements()` Obtain the list of requirements for other Modules that this Module depends on at run time.
`int`	`hashCode()` We determine the hash code by looking at the Module's name and version.
`String`	`toString()` Obtain a String representation.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - theModuleGroupId
```
protected String theModuleGroupId
```
    The groupId of the module
  - theModuleArtifactId
```
protected String theModuleArtifactId
```
    The artifactId of the module.
  - theModuleVersion
```
protected String theModuleVersion
```
    The version of the module.
  - theModuleBuildDate
```
protected long theModuleBuildDate
```
    The time when this Module was built.
  - theModuleUserNames
```
protected Map<String,String> theModuleUserNames
```
    The user-visible names for this Module, keyed by the locale.
  - theModuleUserDescriptions
```
protected Map<String,String> theModuleUserDescriptions
```
    The user-visible descriptions for this Module, keyed by the locale.
  - theRuntimeModuleRequirements
```
protected ModuleRequirement[] theRuntimeModuleRequirements
```
    The requirements for other modules that this Module will have at run time.
  - theModuleLicense
```
protected ModuleLicense theModuleLicense
```
    The license of the Module.
  - theModuleJar
```
protected JarFile theModuleJar
```
    The JAR that this Module provides.
  - theResourceJarEntryPrefix
```
protected String theResourceJarEntryPrefix
```
    The relative path below which resources, such as a class files, are to be found. Must be suitable for prepending without further processing, i.e. must end with slash unless at the root.
  - JAR_RESOURCE_JAR_ENTRY_PREFIX
```
public static final String JAR_RESOURCE_JAR_ENTRY_PREFIX
```
    The resourceJarEntryPrefix for JAR files.
    
    See Also:
    
    Constant Field Values
  - WAR_RESOURCE_JAR_ENTRY_PREFIX
```
public static final String WAR_RESOURCE_JAR_ENTRY_PREFIX
```
    The resourceJarEntryPrefix for WAR files.
    
    See Also:
    
    Constant Field Values
  - UNPACKED_RESOURCE_JAR_ENTRY_PREFIX
```
public static final String UNPACKED_RESOURCE_JAR_ENTRY_PREFIX
```
    The resourceJarEntryPrefix for unpacked directories.
    
    See Also:
    
    Constant Field Values
  - theActivationClassName
```
protected String theActivationClassName
```
    The name of the Module activation/deactivation class.
  - theRunClassName
```
protected String theRunClassName
```
    The name of the class in this Module which provides a method to run this Module.
- Constructor Detail
  - ModuleMeta
```
protected ModuleMeta(String moduleGroupId,
                     String moduleArtifactId,
                     String moduleVersion,
                     Map<String,String> moduleUserNames,
                     Map<String,String> moduleUserDescriptions,
                     long moduleBuildDate,
                     ModuleLicense license,
                     ModuleRequirement[] runtimeModuleRequirements,
                     JarFile moduleJar,
                     String activationClassName,
                     String runClassName)
```
    Constructor. This should not be directly invoked by the application programmer.
    
    Parameters:
    
    moduleGroupId - the Maven groupId of the to-be-created Module
    
    moduleArtifactId - the Maven artifactId of the to-be-created Module
    
    moduleVersion - the version of the to-be-created Module, may be null (but that's discouraged)
    
    moduleUserNames - the name shown to the user of the to-be-created Module, keyed by the locale
    
    moduleUserDescriptions - the description shown to the user of the to-be-created Module, keyed by the locale
    
    moduleBuildDate - the time when this Module was built
    
    license - the license for the to-be-created Module
    
    runtimeModuleRequirements - the ModuleRequirements of this Module at run time
    
    moduleJar - JAR file provided by this Module
    
    activationClassName - name of the Module's activation/deactivation class, or null
    
    runClassName - name of the class contained in this Module that contains the Module's run method, or null
- Method Detail
  - getModuleGroupId
```
public final String getModuleGroupId()
```
    Obtain the groupId of the Module.
    
    Returns:
    
    the groupId for this Module
  - getModuleArtifactId
```
public final String getModuleArtifactId()
```
    Obtain the artifactId of the Module.
    
    Returns:
    
    the artifactId for this Module
  - getModuleUserName
```
public String getModuleUserName()
```
    Obtain the internationalized name of the Module in the current locale.
    
    Returns:
    
    the internationalized name of the Module, in the current locale
  - getModuleUserName
```
public String getModuleUserName(Locale loc)
```
    Obtain the internationalized name of the Module in a specified locale.
    
    Parameters:
    
    loc - the locale
    
    Returns:
    
    the internationalized name of the Module, in the specified locale
  - getModuleUserDescription
```
public String getModuleUserDescription(Locale loc)
```
    Obtain the internationalized description of the Module in a specified locale.
    
    Parameters:
    
    loc - the locale
    
    Returns:
    
    the internationalized description of the Module, in the specified locale
  - getModuleUserNames
```
public Map<String,String> getModuleUserNames()
```
    Obtain the Map of internationalized names of the Module.
    
    Returns:
    
    the Map of internationalized names of the Module, keyed by locale
  - getModuleUserDescriptions
```
public Map<String,String> getModuleUserDescriptions()
```
    Obtain the Map of internationalized descriptions of the Module.
    
    Returns:
    
    the Map of internationalized descriptions of the Module, keyed by locale
  - getModuleVersion
```
public final String getModuleVersion()
```
    Obtain the version of this Module.
    
    Returns:
    
    the version for of this Module; may be null
  - getModuleBuildDate
```
public final long getModuleBuildDate()
```
    Obtain the time at which this Module was built, in System.currentTimeMillis() format.
    
    Returns:
    
    the time at which this Module was built.
  - getModuleLicense
```
public final ModuleLicense getModuleLicense()
```
    Obtain the license for this Module.
    
    Returns:
    
    the license for this Module
  - getRuntimeModuleRequirements
```
public final ModuleRequirement[] getRuntimeModuleRequirements()
```
    Obtain the list of requirements for other Modules that this Module depends on at run time.
    
    Returns:
    
    the list of ModuleRequirements of this Module at run time
  - getProvidesJar
```
public final JarFile getProvidesJar()
```
    Obtain the JAR file that this Module provides as JarFile.
    
    Returns:
    
    the JarFile
  - getResourceJarEntryPrefix
```
public final String getResourceJarEntryPrefix()
```
    Obtain the relative path below which resources, such as a class files, are to be found. In a WAR file, for example, that would be "WEB-INF/classes/".
    
    Returns:
    
    the prefix
  - getActivationClassName
```
public final String getActivationClassName()
```
    Obtain the name of the Module activation/deactivation class. If this returns null, it means the Module has no activation method.
    
    Returns:
    
    name of the activation/deactivation class contained in this Module, or null if none
  - getRunClassName
```
public final String getRunClassName()
```
    Obtain the name of the class that contains the Module's run method. If this returns null, it means the Module has no run method.
    
    Returns:
    
    name of the run class contained in this Module, or null if none
  - equals
```
public boolean equals(Object other)
```
    Two ModuleMetas are the same if they have the same name and version.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other - the object to test against
    
    Returns:
    
    if they are equal, return true
  - hashCode
```
public int hashCode()
```
    We determine the hash code by looking at the Module's name and version.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code
  - createModule
```
protected Module createModule(AbstractModuleRegistry registry,
                              ClassLoader parentClassLoader)
```
    Create a Module from this ModuleMeta. This is not supposed to be invoked by the application programmer.
    
    Parameters:
    
    registry - the AbstractModuleRegistry in which the to-be-created Module will look for dependent Modules
    
    parentClassLoader - the ClassLoader of our parent Module
    
    Returns:
    
    the created Module
  - toString
```
public String toString()
```
    Obtain a String representation.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation

Class ModuleMeta

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

theModuleGroupId

theModuleArtifactId

theModuleVersion

theModuleBuildDate

theModuleUserNames

theModuleUserDescriptions

theRuntimeModuleRequirements

theModuleLicense

theModuleJar

theResourceJarEntryPrefix

JAR_RESOURCE_JAR_ENTRY_PREFIX

WAR_RESOURCE_JAR_ENTRY_PREFIX

UNPACKED_RESOURCE_JAR_ENTRY_PREFIX

theActivationClassName

theRunClassName

Constructor Detail

ModuleMeta

Method Detail

getModuleGroupId

getModuleArtifactId

getModuleUserName

getModuleUserName

getModuleUserDescription

getModuleUserNames

getModuleUserDescriptions

getModuleVersion

getModuleBuildDate

getModuleLicense

getRuntimeModuleRequirements

getProvidesJar

getResourceJarEntryPrefix

getActivationClassName

getRunClassName

equals

hashCode

createModule

toString