Package net.sf.okapi.common

Class ParametersString

  • public class ParametersString
extends Object
    String-based representation of a set of parameters.
    • The string or file should start with "#v1\n"
    • Each parameter is saved in a format: key=value
    • Keys and values are case-sensitive.
    • Keys should not contain periods (.) as this character is reserved for group handling.
    • The character \r should be escaped as $0d$
    • The character \n should be escaped as $0a$
    • The suffix .i and .b should be used for integer and boolean entries.
    • Commented lines are denoted by a character '#' as the first character of the line.
    • White-spaces are significant after '=' for string entries.
    Example: 
    #v1
paramKey1.b=true
paramKey2.i = 123
paramStr  =value for paramStr

    • Constructor Detail

      • ParametersString

        public ParametersString()

      • ParametersString

        public ParametersString​(String data)

    • Method Detail

      • fromString

        public void fromString​(String data)

      • fromString

        public void fromString​(String data,
                       boolean clearBuffer)
        Deserialize the specified data into this object. Optionally reset the internal parameter set before doing so.
        Parameters:
        data - data to deserialize
        clearBuffer - if true, the internal parameters list will be cleared before loading the data. if false, any existing parameters will be left intact unless they are overridden by the data.

      • fromParametersString

        public void fromParametersString​(ParametersString parametersString)

      • fromParametersString

        public void fromParametersString​(ParametersString parametersString,
                                 boolean clearBuffer)

      • reset

        public void reset()

      • remove

        public void remove​(String name)

      • removeGroup

        public void removeGroup​(String groupName)

      • setGroup

        public void setGroup​(String name,
                     String data)

      • setString

        public void setString​(String name,
                      String value)

      • getBoolean

        public boolean getBoolean​(String name,
                          boolean defaultValue)

      • getBoolean

        public boolean getBoolean​(String name)

      • setBoolean

        public void setBoolean​(String name,
                       boolean value)

      • getInteger

        public int getInteger​(String name,
                      int defaultValue)

      • getInteger

        public int getInteger​(String name)

      • setInteger

        public void setInteger​(String name,
                       int value)

      • setParameter

        public void setParameter​(String name,
                         String value)

      • setParameter

        public void setParameter​(String name,
                         boolean value)

      • setParameter

        public void setParameter​(String name,
                         int value)

      • getEncodedString

        public String getEncodedString​(String name,
                               String defaultValue)
        Gets the string value for a given parameter after decoding it if necessary.
        Parameters:
        name - the name of the parameter.
        defaultValue - the default (not encoded) value to use.
        Returns:
        the string value of the given parameter, decoded if necessary.

      • setEncodedString

        public void setEncodedString​(String name,
                             String value)
        Sets the string value of a given parameter and encode it. The encoding applied is only a basic first level of security protecting the value from being casually read by a human, it is not an encryption.
        Parameters:
        name - the name of the parameter.
        value - the value to set and encode.