org.phenotips.data

Enum MedicationEffect

java.lang.Object

java.lang.Enum<MedicationEffect>

org.phenotips.data.MedicationEffect

All Implemented Interfaces:

Serializable, Comparable<MedicationEffect>

@Unstable
public enum MedicationEffect
extends Enum<MedicationEffect>

The effect that a medicine has on the patient's symptoms.

Since:

1.2M5

Version:

$Id: 2256f2eeff6d22a547d8a3c8d57dfb211ae75437 $

Enum Constant Summary

Enum Constants

Enum Constant and Description
INTERMEDIATE_IMPROVEMENT Moderate improvement.
NONE No effect.
SLIGHT_IMPROVEMENT Slight improvement.
STRONG_IMPROVEMENT Strong improvement, the symptoms got visibly better.
UNKNOWN Unknown effect.
WORSENING The symptoms got worse.

Method Summary

Methods

Modifier and Type	Method and Description
static MedicationEffect	fromString(String effect) Get the enum instance corresponding to either a CAPITAL_CASE or a camelCase version of its name.
String	toString()
static MedicationEffect	valueOf(String name) Returns the enum constant of this type with the specified name.
static MedicationEffect[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final MedicationEffect UNKNOWN

Unknown effect.

WORSENING

public static final MedicationEffect WORSENING

The symptoms got worse.

NONE

public static final MedicationEffect NONE

No effect.

SLIGHT_IMPROVEMENT

public static final MedicationEffect SLIGHT_IMPROVEMENT

Slight improvement.

INTERMEDIATE_IMPROVEMENT

public static final MedicationEffect INTERMEDIATE_IMPROVEMENT

Moderate improvement.

STRONG_IMPROVEMENT

public static final MedicationEffect STRONG_IMPROVEMENT

Strong improvement, the symptoms got visibly better.

Method Detail

values

public static MedicationEffect[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MedicationEffect c : MedicationEffect.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MedicationEffect valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static MedicationEffect fromString(String effect)

Get the enum instance corresponding to either a CAPITAL_CASE or a camelCase version of its name.

Parameters:

effect - the serialized effect name

Returns:

an instance of this enum, if one was found

Throws:

IllegalArgumentException - if the effect name cannot be resolved to a known effect instance

toString

public String toString()

Overrides:

toString in class Enum<MedicationEffect>