Class PropertyStringParser

java.lang.Object
com.martiansoftware.jsap.StringParser
com.martiansoftware.jsap.PropertyStringParser
Direct Known Subclasses:
DateStringParser, FileStringParser

public abstract class PropertyStringParser
extends StringParser
A StringParser subclass that provides a means for setting/getting properties. This is intended to support StringParsers that might requires some configuration, such as DateStringParser (which needs a format String).
Author:
Marty Lamb
See Also:
StringParser, DateStringParser
  • Constructor Summary

    Constructors
    Constructor Description
    PropertyStringParser()  
  • Method Summary

    Modifier and Type Method Description
    java.lang.String getProperty​(java.lang.String key)
    Returns the property associated with the specified key, or null if no such property exists.
    java.lang.String getProperty​(java.lang.String key, java.lang.String defaultValue)
    Returns the property associated with the specified key, or the specified default value if no such property exists.
    void setProperty​(java.lang.String key, java.lang.String value)
    Sets the property with the specified key to the specified value.

    Methods inherited from class com.martiansoftware.jsap.StringParser

    parse, setUp, tearDown

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • PropertyStringParser

      public PropertyStringParser()
  • Method Details

    • setProperty

      public void setProperty​(java.lang.String key, java.lang.String value)
      Sets the property with the specified key to the specified value.
      Parameters:
      key - the key of the property to set.
      value - the value to associated with the specified key.
      See Also:
      Properties.setProperty(String,String)
    • getProperty

      public java.lang.String getProperty​(java.lang.String key)
      Returns the property associated with the specified key, or null if no such property exists.
      Parameters:
      key - the key of the desired property
      Returns:
      the property associated with the specified key, or null if no such property exists.
    • getProperty

      public java.lang.String getProperty​(java.lang.String key, java.lang.String defaultValue)
      Returns the property associated with the specified key, or the specified default value if no such property exists.
      Parameters:
      key - the key of the desired property
      defaultValue - the default value to return if no such property exists
      Returns:
      the requested property, or the specified default value if no such property exists.