Class Argument


  • public class Argument
    extends java.lang.Object
    This is a data class to store the argument information for a Command
    Author:
    Jason Johns
    • Constructor Summary

      Constructors 
      Constructor Description
      Argument​(java.lang.String aSwitch, java.lang.String sub, java.lang.String value, boolean streamed)
      Default constructor, initializes the members
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getSubstitution()
      Returns the substitution switch
      java.lang.String getSwitch()
      Returns the switch
      java.lang.String getValue()
      Returns the value of the argument
      boolean isStreamed()
      Returns the boolean indicating if this argument should be sent to an input stream.
      void setStreamed​(boolean aBool)
      Sets the boolean indicating if this argument should be sent to an input stream
      void setSubstitution​(java.lang.String aValue)
      Sets the substitution switch
      void setSwitch​(java.lang.String aValue)
      Sets the switch member
      void setValue​(java.lang.String aValue)
      Sets the value of the argument
      java.lang.String toString()
      Returns a string representation of the argument, for purposes of debugging
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Argument

        public Argument​(java.lang.String aSwitch,
                        java.lang.String sub,
                        java.lang.String value,
                        boolean streamed)
        Default constructor, initializes the members
        Parameters:
        aSwitch - a String object.
        sub - a String object.
        value - a String object.
        streamed - a boolean.
    • Method Detail

      • setSwitch

        public void setSwitch​(java.lang.String aValue)
        Sets the switch member
        Parameters:
        aValue - the value of the switch
      • setSubstitution

        public void setSubstitution​(java.lang.String aValue)
        Sets the substitution switch
        Parameters:
        aValue - the value of the substitution
      • setValue

        public void setValue​(java.lang.String aValue)
        Sets the value of the argument
        Parameters:
        aValue - the value of the argument
      • getSwitch

        public java.lang.String getSwitch()
        Returns the switch
        Returns:
        String, the switch string
      • getSubstitution

        public java.lang.String getSubstitution()
        Returns the substitution switch
        Returns:
        String, the substitution
      • getValue

        public java.lang.String getValue()
        Returns the value of the argument
        Returns:
        String, the value of the argument
      • setStreamed

        public void setStreamed​(boolean aBool)
        Sets the boolean indicating if this argument should be sent to an input stream
        Parameters:
        aBool - true if the argument should be sent to a input stream, false otherwise
      • isStreamed

        public boolean isStreamed()
        Returns the boolean indicating if this argument should be sent to an input stream.
        Returns:
        true if the argument should be sent to a input stream, false otherwise
      • toString

        public java.lang.String toString()
        Returns a string representation of the argument, for purposes of debugging
        Overrides:
        toString in class java.lang.Object
        Returns:
        String, a string representation