Joutsen.ArgumentsParsing v0.3.0+1-ga4c84ed
Public Member Functions | Properties | List of all members
Joutsen.ArgumentsParsing.ParseException Class Reference

An exception that occurs if a list of input strings cannot be parsed. More...

Public Member Functions

 ParseException (ArgumentParseException inner)
 creates a new instance. More...
 
 ParseException (ArgumentParseException inner, string usage)
 creates a new instance. More...
 
- Public Member Functions inherited from Joutsen.ArgumentsParsing.WritableException
 WritableException (string message, Exception innerException)
 Creates an instance with an error message and an exception that is the cause for this exception to be raised. More...
 
 WritableException (string message)
 Creates an instance with an error message. More...
 
 WritableException ()
 Creates an empty exception. More...
 
void Write (Stream stream, Encoding encoding=null)
 Writes the errror message of this exception to a stream. More...
 
void Write (TextWriter writer)
 Writes the error message of this exception using a TextWriter. More...
 
void Write ()
 Writes the error message of this exception to stdout. More...
 

Properties

string Usage [get]
 the description of the expected input from the parser that raised this exception. More...
 
override string Message [get]
 The messge describing what caused this exception and stopped the parsing. More...
 

Detailed Description

An exception that occurs if a list of input strings cannot be parsed.

This can be due to missing required arguments, wrong values or unknown arguments.

Since
0.1.0

Constructor & Destructor Documentation

◆ ParseException() [1/2]

Joutsen.ArgumentsParsing.ParseException.ParseException ( ArgumentParseException  inner)

creates a new instance.

Parameters
innerthe exception that was thrown by one of the literal parsers

◆ ParseException() [2/2]

Joutsen.ArgumentsParsing.ParseException.ParseException ( ArgumentParseException  inner,
string  usage 
)

creates a new instance.

Parameters
innerthe exception that was thrown by one of the literal parsers
usagethe usage description of the parser that raised this exception

Property Documentation

◆ Message

override string Joutsen.ArgumentsParsing.ParseException.Message
get

The messge describing what caused this exception and stopped the parsing.

◆ Usage

string Joutsen.ArgumentsParsing.ParseException.Usage
get

the description of the expected input from the parser that raised this exception.