com.jstatcom.engine
Class LoadTypes

java.lang.Object
  extended by com.jstatcom.engine.LoadTypes
Direct Known Subclasses:
GaussLoadTypes, GRTELoadTypes, MatlabLoadTypes, MLabLoadTypes, OxLoadTypes, RStatLoadTypes, StubLoadTypes, StubMlabLoadTypes

public abstract class LoadTypes
extends java.lang.Object

This class contains an enumeration of constants that define different types of modules that can be loaded by a certain engine, for example dynamic link libraries (.dll) or special engine executables (.lib). This class needs to be subclassed to define the necessary constants for a certain engine.

It implements the typesave enum pattern (Joshua Bloch, "Effective Java", Item 21). If you compare LoadTypes, always use the == operator.

Author:
Markus Kraetzig

Constructor Summary
LoadTypes(java.lang.String name)
          Creates a new config key.
 
Method Summary
 boolean equals(java.lang.Object o)
          Override prevention method to enforce a.equals(b) if and only if a==b.
 int hashCode()
          Override prevention method invokes super method.
 java.lang.String name()
          Gets the name of this load type.
 java.lang.String toString()
          Gets a string representation.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LoadTypes

public LoadTypes(java.lang.String name)
Creates a new config key.

Parameters:
name - the identifier of the new key
Throws:
java.lang.IllegalArgumentException - if (name == null)
Method Detail

equals

public final boolean equals(java.lang.Object o)
Override prevention method to enforce a.equals(b) if and only if a==b.

Overrides:
equals in class java.lang.Object
Parameters:
o - object to compare with
Returns:
true if equal, false otherwise

hashCode

public final int hashCode()
Override prevention method invokes super method.

Overrides:
hashCode in class java.lang.Object
Returns:
hash code

name

public final java.lang.String name()
Gets the name of this load type.

Returns:
the name of this type

toString

public final java.lang.String toString()
Gets a string representation.

Overrides:
toString in class java.lang.Object
Returns:
a string representation of this