/* 
    P/P   *  Method: com.dmdirc.installer.cliparser.CLIParam__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 abstract class CLIParam {
    29  	/** Single Character flag for this param. */
    30  	private final char charFlag;
    31  	/** String flag for this param. */
    32  	private final String stringFlag;
    33  	/** Description of this flag. */
    34  	private final String description;
    35  	/** Number of times this param has been given. */
    36  	private int number;
    37  	
    38  	/**
    39  	 * Create a new CLIParam.
    40  	 *
    41  	 * @param chr Single Character flag for this param.
    42  	 * @param str String flag for this param.
    43  	 * @param desc Description of this flag.
    44  	 */
        	 /* 
    P/P 	  *  Method: void com.dmdirc.installer.cliparser.CLIParam(char, String, String)
        	  * 
        	  *  Postconditions:
        	  *    this.charFlag == chr
        	  *    init'ed(this.charFlag)
        	  *    this.description == desc
        	  *    init'ed(this.description)
        	  *    this.stringFlag == str
        	  *    init'ed(this.stringFlag)
        	  */
    45  	protected CLIParam(final char chr, final String str, final String desc) {
    46  		charFlag = chr;
    47  		stringFlag = str;
    48  		description = desc;
    49  	}
    50  	
    51  	/**
    52  	 * Get the single character flag for this param.
    53  	 */
        	 /* 
    P/P 	  *  Method: char getChr()
        	  * 
        	  *  Postconditions:
        	  *    return_value == this.charFlag
        	  *    init'ed(return_value)
        	  */
    54  	public final char getChr() { return charFlag; }
    55  	
    56  	/**
    57  	 * Get the string flag for this param.
    58  	 */
        	 /* 
    P/P 	  *  Method: String getString()
        	  * 
        	  *  Postconditions:
        	  *    return_value == this.stringFlag
        	  *    init'ed(return_value)
        	  */
    59  	public final String getString() { return stringFlag; }
    60  	
    61  	/**
    62  	 * Get the description for this param.
    63  	 */
        	 /* 
    P/P 	  *  Method: String getDescription()
        	  * 
        	  *  Postconditions:
        	  *    return_value == this.description
        	  *    init'ed(return_value)
        	  */
    64  	public final String getDescription() { return description; }
    65  	
    66  	/**
    67  	 * Get the number of times this value has been given.
    68  	 */
        	 /* 
    P/P 	  *  Method: int getNumber()
        	  * 
        	  *  Preconditions:
        	  *    init'ed(this.number)
        	  * 
        	  *  Postconditions:
        	  *    return_value == this.number
        	  *    init'ed(return_value)
        	  */
    69  	public final int getNumber() { return number; }
    70  	
    71  	/**
    72  	 * Increment the number of times this value has been given.
    73  	 */
        	 /* 
    P/P 	  *  Method: void incNumber()
        	  * 
        	  *  Preconditions:
        	  *    this.number <= 232-2
        	  * 
        	  *  Postconditions:
        	  *    this.number == old this.number + 1
        	  *    this.number >= -231+1
        	  */
    74  	public final void incNumber() { ++number; }
    75  	
    76  	/**
    77  	 * Set the value of this param to the value given by a string.
    78  	 *
    79  	 * @param value String taken from command line to use as value.
    80  	 * @return true if value was valid, else false.
    81  	 */
    82  	public abstract boolean setValue(final String value);
    83  	
    84  	/**
    85  	 * Return the value of this param as a string.
    86  	 *
    87  	 * @return The value of this param as a string.
    88  	 */
    89  	public abstract String getStringValue();
    90  }