de.cau.cs.kieler.kiml.ogdf.options
Enum AttractionFormula

java.lang.Object
  extended by java.lang.Enum<AttractionFormula>
      extended by de.cau.cs.kieler.kiml.ogdf.options.AttractionFormula
All Implemented Interfaces:
Comparable<AttractionFormula>

public enum AttractionFormula
extends Enum<AttractionFormula>

Definition of attraction formula option for the GEM layouter.

Rating red

Enum Constant Summary
FRUCHTERMAN_REINGOLD
          the Fruchterman-Reingold method.
GEM
          the GEM method.
 
Method Summary
static AttractionFormula valueOf(int i)
          Returns the enumeration value related to the given ordinal.
static AttractionFormula valueOf(String name)
          Returns the enum constant of this type with the specified name.
static AttractionFormula[] 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, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

FRUCHTERMAN_REINGOLD

public static final AttractionFormula FRUCHTERMAN_REINGOLD
the Fruchterman-Reingold method.


GEM

public static final AttractionFormula GEM
the GEM method.

Method Detail

values

public static AttractionFormula[] 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 (AttractionFormula c : AttractionFormula.values())
    System.out.println(c);

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

valueOf

public static AttractionFormula 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

valueOf

public static AttractionFormula valueOf(int i)
Returns the enumeration value related to the given ordinal.

Parameters:
i - ordinal value
Returns:
the related enumeration value