Package com.uc4.api.objects

Class VariableValues

java.lang.Object
com.uc4.api.objects.VariableValues
public final class VariableValues extends Object
This class represents the "Variables" tab of a STATIC and XML VARA object.

  • Constructor Details

    • VariableValues

      protected VariableValues(com.uc4.util.XMLDocument doc, boolean xml)

  • Method Details

    • keyIterator

      public Iterator<String> keyIterator()
      Returns an iterator over validity keywords. All validity keywords have the type java.lang.String
      Returns:
      Iterator

    • add

      public void add(String validityKeyword, String value, boolean replace)
      Adds a new key and value to the variables. The parameter replace can be used to define if the value should be replaced in case of an already existing validity keyword.
      Parameters:
      validityKeyword - Key
      value - Value
      replace - If true the value will be replaced if a key with this name does already exist

    • add

      public void add(String validityKeyword, String[] value, boolean replace)
      Adds a new key and values to the variables. The parameter replace can be used to define if the values should be replaced in case of an already existing validity keyword.
      Parameters:
      validityKeyword - Key
      value - Array of five elements
      replace - If true the value will be replaced if a key with this name does already exist

    • get

      public String get(String validityKeyword)
      Returns the value for a given key The method returns null if the key does not exist.
      Parameters:
      validityKeyword - Key
      Returns:
      Value or null if the key does not exist

    • getRow

      public String[] getRow(String key)
      Returns the values of a row with the specified key.
      Parameters:
      key - Name of the key
      Returns:
      Array of Strings containing the values

    • entryIterator

      protected Iterator<Map.Entry<String,String[]>> entryIterator()

    • remove

      public boolean remove(String validityKeyword)
      Removes a variable entry The method returns false if the validity keyword was not found.
      Parameters:
      validityKeyword - Key
      Returns:
      True if the values was removed

    • size

      public int size()
      Returns:
      Number of entries in the Variable.

    • removeAll

      public void removeAll()
      Removes all entries from the Variable.

    • store

      protected void store(com.uc4.util.XMLDocument doc, Element objectElement)