Class RelativeSolvationType

java.lang.Object

ffx.potential.parameters.BaseType

ffx.potential.parameters.RelativeSolvationType

All Implemented Interfaces:

Comparator<String>

public class RelativeSolvationType
extends BaseType
implements Comparator<String>

A BaseType for relative solvation energies (intended for nonstandard amino acids).

Since:

1.0

Author:

Michael J. Schnieders, Jacob M. Litman

Field Summary

Fields inherited from class BaseType

key

Constructor Summary

Constructors

Constructor	Description
RelativeSolvationType(String resname, double solvEnergy)	Constructor for RelativeSolvationType.

Method Summary

Modifier and Type	Method	Description
int	compare(String o1, String o2)
boolean	equals(Object o)
String	getResName()	Getter for the field resName.
double	getSolvEnergy()	Getter for the field solvEnergy.
int	hashCode()
static RelativeSolvationType	parse(String input, String[] tokens)	Construct a RelativeSolvationType from an input string.
String	toString()

Methods inherited from class BaseType

getKey, log, print, setKey, setKey

Methods inherited from class Object

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

Methods inherited from interface Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Details

RelativeSolvationType

public RelativeSolvationType(String resname,
 double solvEnergy)

Constructor for RelativeSolvationType.

Parameters:

resname - a String object.

solvEnergy - a double.

Method Details

parse

public static RelativeSolvationType parse(String input,
 String[] tokens)

Construct a RelativeSolvationType from an input string.

Parameters:

input - The overall input String.

tokens - The input String tokenized.

Returns:

a RelativeSolvationType instance.

compare

public int compare(String o1,
 String o2)

Specified by:

compare in interface Comparator<String>

equals

public boolean equals(Object o)

Specified by:

equals in interface Comparator<String>

Overrides:

equals in class Object

getResName

public String getResName()

Getter for the field resName.

Returns:

a String object.

getSolvEnergy

public double getSolvEnergy()

Getter for the field solvEnergy.

Returns:

a double.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Basic toString method.

Overrides:

toString in class BaseType