Class LongOption

  • All Implemented Interfaces:
    OptionModifiable

    public class LongOption
    extends Option
    This class is used for options with long values.
     Copyright (C) Damian Ryan Eads, 2001. All Rights Reserved.
    
     ritopt is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
    
     ritopt is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
    
     You should have received a copy of the GNU General Public License
     along with ritopt; if not, write to the Free Software
     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
     
    • Constructor Detail

      • LongOption

        public LongOption()
        Constructs a long option that is initially set to zero.
      • LongOption

        public LongOption​(LongOption op)
        Constructs a long option by copying the long option passed.
        Parameters:
        op - The character option to copy.
      • LongOption

        public LongOption​(long value)
        Constructs a long option initialized with the value passed.
        Parameters:
        value - The initial value of this long option.
      • LongOption

        public LongOption​(long value,
                          java.lang.String longOption)
        Constructs a long option initialized with the value and long option passed.
        Parameters:
        value - The initial value of this long option.
        longOption - The long option associated with long option.
      • LongOption

        public LongOption​(long value,
                          char shortOption)
        Constructs a character option initialized with the value and short option passed.
        Parameters:
        value - The initial value of this long option.
        shortOption - The short option associated with this option.
      • LongOption

        public LongOption​(long value,
                          java.lang.String longOption,
                          char shortOption)
        Constructs a long option initialized with the value, short and long option passed.
        Parameters:
        shortOption - The short option associated with this option.
        longOption - The long option associated with this option.
        value - The initial value of this long option.
    • Method Detail

      • getObject

        public java.lang.Object getObject()
        Return the value as an object.
        Specified by:
        getObject in class Option
        Returns:
        This value as an option.
      • modify

        public void modify​(java.lang.String value)
                    throws OptionModificationException
        Modify this option based on a string representation.
        Parameters:
        value - String representation of the object.
        Throws:
        OptionModificationException - Thrown if an error occurs during modification of an option.
      • setValue

        public void setValue​(java.lang.String value)
                      throws OptionModificationException
        Modify this option based on a string representation.
        Parameters:
        value - String representation of the object.
        Throws:
        OptionModificationException - Thrown if an error occurs during modification of an option.
      • setValue

        public void setValue​(long value)
        Modify this option using a long value.
        Parameters:
        value - A long value.
      • getValue

        public long getValue()
        Return this option as a long.
        Returns:
        This option as a long.
      • getStringValue

        public java.lang.String getStringValue()
        Return this option as a string.
        Specified by:
        getStringValue in class Option
        Returns:
        This option as a string.
      • getTypeName

        public java.lang.String getTypeName()
        Returns the type name of this option. For a LongOption, "LONG" is returned.
        Specified by:
        getTypeName in class Option
        Returns:
        The type name of this option.
      • toString

        public java.lang.String toString()
        Returns a string representation of this object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this object.