java.lang.Object
- adams.env.Modules.Module

All Implemented Interfaces:

Serializable, Comparable<Modules.Module>

Enclosing class:

Modules
```
public static class Modules.Module
extends Object
implements Serializable, Comparable<Modules.Module>
```
Container class for module information.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ADAMS_PREFIX`	the prefix for adams modules.
`protected String`	`m_Author`	the author of the module.
`protected BaseDateTime`	`m_BuildTimestamp`	the build timestamp of the module.
`protected String`	`m_Description`	the description of the module.
`protected ImageIcon`	`m_Logo`	the logo.
`protected String`	`m_LogoName`	the logo name.
`protected String`	`m_Name`	the name of the module.
`protected String`	`m_Organization`	the organization.
`protected String`	`m_Version`	the version of the module.

Constructor Summary

Constructors
Constructor Description

Module(Properties props)
Initializes the object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(Modules.Module o)`	Compares this object with the specified object for order.
`boolean`	`equals(Object o)`	Checks whether the object is the same.
`String`	`getAuthor()`	Returns the name of the author(s).
`BaseDateTime`	`getBuildTimestamp()`	Returns the build timestamp of the module.
`String`	`getDescription()`	Returns the description of the module.
`ImageIcon`	`getLogo()`	Returns the logo of the module.
`String`	`getLogoName()`	Returns the logo name of the module.
`String`	`getName()`	Returns the name of the module.
`String`	`getOrganization()`	Returns the name of the organization.
`String`	`getVersion()`	Returns the version of the module.
`int`	`hashCode()`	Hashcode so can be used as hashtable key.
`String`	`toString()`	Just outputs the name.

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

- Field Detail
  - ADAMS_PREFIX
```
public static final String ADAMS_PREFIX
```
    the prefix for adams modules.
    
    See Also:
    
    Constant Field Values
  - m_Name
```
protected String m_Name
```
    the name of the module.
  - m_Version
```
protected String m_Version
```
    the version of the module.
  - m_BuildTimestamp
```
protected BaseDateTime m_BuildTimestamp
```
    the build timestamp of the module.
  - m_Description
```
protected String m_Description
```
    the description of the module.
  - m_Author
```
protected String m_Author
```
    the author of the module.
  - m_Organization
```
protected String m_Organization
```
    the organization.
  - m_LogoName
```
protected String m_LogoName
```
    the logo name.
  - m_Logo
```
protected ImageIcon m_Logo
```
    the logo.
- Constructor Detail
  - Module
```
public Module(Properties props)
```
    Initializes the object.
    
    Parameters:
    
    props - the module information to use
- Method Detail
  - getName
```
public String getName()
```
    Returns the name of the module.
    
    Returns:
    
    the name
  - getVersion
```
public String getVersion()
```
    Returns the version of the module.
    
    Returns:
    
    the version
  - getBuildTimestamp
```
public BaseDateTime getBuildTimestamp()
```
    Returns the build timestamp of the module.
    
    Returns:
    
    the timestamp
  - getDescription
```
public String getDescription()
```
    Returns the description of the module.
    
    Returns:
    
    the description
  - getAuthor
```
public String getAuthor()
```
    Returns the name of the author(s).
    
    Returns:
    
    the name of the author(s)
  - getOrganization
```
public String getOrganization()
```
    Returns the name of the organization.
    
    Returns:
    
    the name of the organization
  - getLogoName
```
public String getLogoName()
```
    Returns the logo name of the module.
    
    Returns:
    
    the logo name
  - getLogo
```
public ImageIcon getLogo()
```
    Returns the logo of the module.
    
    Returns:
    
    the logo
  - compareTo
```
public int compareTo(Modules.Module o)
```
    Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
    
    Specified by:
    
    compareTo in interface Comparable<Modules.Module>
    
    Parameters:
    
    o - the object to be compared.
    
    Returns:
    
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
  - equals
```
public boolean equals(Object o)
```
    Checks whether the object is the same.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - the object to compare against
    
    Returns:
    
    true if the same, false otherwise
  - hashCode
```
public int hashCode()
```
    Hashcode so can be used as hashtable key. Returns the hashcode of the name string.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hashcode
  - toString
```
public String toString()
```
    Just outputs the name.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the name

Class Modules.Module

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ADAMS_PREFIX

m_Name

m_Version

m_BuildTimestamp

m_Description

m_Author

m_Organization

m_LogoName

m_Logo

Constructor Detail

Module

Method Detail

getName

getVersion

getBuildTimestamp

getDescription

getAuthor

getOrganization

getLogoName

getLogo

compareTo

equals

hashCode

toString