/* 
    P/P   *  Method: com.dmdirc.installer.cliparser.StringParam__static_init
          */
     1  /*
     2   * Copyright (c) 2006-2009 Shane Mc Cormack
     3   *
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   *
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   *
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  
    23  package com.dmdirc.installer.cliparser;
    24  
    25  /**
    26   * Command Line argument type.
    27   */
    28  public class StringParam extends CLIParam {
    29  	/** The value of this param. */
    30  	private String myValue = "";
    31  	
    32  	/**
    33  	 * Create a new StringParam.
    34  	 *
    35  	 * @param chr Single Character flag for this param.
    36  	 * @param str String flag for this param.
    37  	 * @param desc Description of this flag.
    38  	 */
    39  	public StringParam(final char chr, final String str, final String desc) {
        		 /* 
    P/P 		  *  Method: void com.dmdirc.installer.cliparser.StringParam(char, String, String)
        		  * 
        		  *  Postconditions:
        		  *    this.charFlag == chr
        		  *    init'ed(this.charFlag)
        		  *    this.description == desc
        		  *    init'ed(this.description)
        		  *    this.myValue == &""
        		  *    this.stringFlag == str
        		  *    init'ed(this.stringFlag)
        		  */
    40  		super(chr, str, desc);
    41  	}
    42  	
    43  	/**
    44  	 * Set the value of this param to the value given by a string.
    45  	 *
    46  	 * @param value String taken from command line to use as value.
    47  	 * @return true if value was valid, else false.
    48  	 */
    49  	public boolean setValue(final String value) {
        		 /* 
    P/P 		  *  Method: bool setValue(String)
        		  * 
        		  *  Postconditions:
        		  *    return_value == 1
        		  *    this.myValue == value
        		  *    init'ed(this.myValue)
        		  */
    50  		myValue = value;
    51  		return true;
    52  	}
    53  	
    54  	/**
    55  	 * Get the value of this param.
    56  	 *
    57  	 * @return Value of this parameter
    58  	 */
    59  	public String getValue() {
        		 /* 
    P/P 		  *  Method: String getValue()
        		  * 
        		  *  Preconditions:
        		  *    init'ed(this.myValue)
        		  * 
        		  *  Postconditions:
        		  *    return_value == this.myValue
        		  *    init'ed(return_value)
        		  */
    60  		return myValue;
    61  	}
    62  	
    63  	/**
    64  	 * Return the value of this param as a string.
    65  	 *
    66  	 * @return The value of this param as a string.
    67  	 */
    68  	public String getStringValue() {
        		 /* 
    P/P 		  *  Method: String getStringValue()
        		  * 
        		  *  Preconditions:
        		  *    init'ed(this.myValue)
        		  * 
        		  *  Postconditions:
        		  *    return_value == this.myValue
        		  *    init'ed(return_value)
        		  */
    69  		return getValue();
    70  	}
    71  }