Package ffx.utilities

Class Keyword

java.lang.Object
ffx.utilities.Keyword
public class Keyword extends Object
The Keyword class holds a single Force Field X keyword entry.
Since:
1.0
Author:
Michael J. Schnieders

  • Constructor Details

    • Keyword

      public Keyword(String k)
      Constructor for Keyword.
      Parameters:
      k - a String object.

    • Keyword

      public Keyword(String k, String entry)
      Constructor for Keyword.
      Parameters:
      k - a String object.
      entry - a String object.

    • Keyword

      public Keyword(String k, String[] entry)
      Constructor for Keyword.
      Parameters:
      k - a String object.
      entry - an array of String objects.

  • Method Details

    • loadProperties

      public static org.apache.commons.configuration2.CompositeConfiguration loadProperties(File file)
      This method sets up configuration properties in the following precedence * order:

      1.) Structure specific properties (for example pdbname.properties)

      2.) Java system properties a.) -Dkey=value from the Java command line b.) System.setProperty("key","value") within Java code.

      3.) User specific properties (~/.ffx/ffx.properties)

      4.) System wide properties (file defined by environment variable FFX_PROPERTIES)

      5.) Internal force field definition.

      Parameters:
      file - a File object.
      Returns:
      a CompositeConfiguration object.
      Since:
      1.0

    • append

      public void append(String entry)
      append
      Parameters:
      entry - a String object.

    • append

      public void append(String[] entry)
      append
      Parameters:
      entry - an array of String objects.

    • clear

      public void clear()
      clear

    • getEntries

      public Vector<String> getEntries()
      getEntries
      Returns:
      a Vector object.

    • getEntry

      public String getEntry(int i)
      getEntry
      Parameters:
      i - The index of the entry to return.
      Returns:
      a String object.

    • getKeyword

      public String getKeyword()
      Getter for the field keyword.
      Returns:
      a String object.

    • print

      public void print()
      print

    • toString

      public String toString()
      Overrides:
      toString in class Object