module Parameters
  class InstanceParam < Param

    # Owning object
    attr_reader :object

    #
    # Creates a new InstanceParam object.
    #
    # @param [Object] object
    #   The object containing the instance variable for the instance
    #   parameter.
    #
    # @param [Symbol, String] name
    #   The name of the instance parameter.
    #
    # @param [String, nil] description
    #   The description of the instance parameter.
    #
    def initialize(object,name,description=nil)
      super(name,description)

      @object = object
    end

    #
    # @return
    #   The value of the instance param.
    #
    def value
      @object.instance_variable_get("@#{@name}".to_sym)
    end

    #
    # Sets the value of the instance param.
    #
    # @param [Object] value
    #   The new value of the instance param.
    #
    # @return [Object]
    #   The new value of the instance param.
    #
    def value=(value)
      @object.instance_variable_set("@#{@name}".to_sym,value)
    end

    #
    # @return [String]
    #   Representation of the instance param.
    #
    def to_s
      text = @name.to_s

      text << " [#{value.inspect}]" if value
      text << "\t#{@description}" if @description

      return text
    end

    #
    # @return [String]
    #   Inspection of the instance params value.
    #
    def inspect
      value.inspect
    end

  end
end