Exception: UsageError

Inherits:

RuntimeError

• Object
• RuntimeError
• UsageError

Defined in:

exceptions.rb

Overview

Raised when a command is used wrong.

Direct Known Subclasses

FormulaOrCaskUnspecifiedError, FormulaUnspecifiedError, Homebrew::CLI::InvalidConstraintError, Homebrew::CLI::MaxNamedArgumentsError, Homebrew::CLI::MinNamedArgumentsError, Homebrew::CLI::NumberOfNamedArgumentsError, Homebrew::CLI::OptionConflictError, Homebrew::CLI::OptionConstraintError, KegUnspecifiedError

Instance Attribute Summary

• #reason ⇒ Object readonly

  Returns the value of attribute reason.

Instance Method Summary

• #initialize(reason = nil) ⇒ UsageError constructor

  A new instance of UsageError.

• #to_s ⇒ String

Constructor Details

#initialize(reason = nil) ⇒ UsageError

Returns a new instance of UsageError.

# File 'exceptions.rb', line 11

def initialize(reason = nil)
  super

  @reason = reason
end

Instance Attribute Details

#reason ⇒ Object (readonly)

Returns the value of attribute reason.

# File 'exceptions.rb', line 9

def reason
  @reason
end

Instance Method Details

#to_s ⇒ String

Returns:

• (String)

# File 'exceptions.rb', line 18

def to_s
  s = "Invalid usage"
  s += ": #{reason}" if reason
  s
end