LightJson.Serialization.JsonParseException Class Reference

The exception that is thrown when a JSON message cannot be parsed. More...

Inheritance diagram for LightJson.Serialization.JsonParseException:

Collaboration diagram for LightJson.Serialization.JsonParseException:

Public Types
enum	ErrorType : int { ErrorType.Unknown = 0, ErrorType.IncompleteMessage, ErrorType.DuplicateObjectKeys, ErrorType.InvalidOrUnexpectedCharacter }
	Types of errors that can occur when parsing a JSON message. More...

Public Member Functions
	JsonParseException ()
	Initializes a new instance of JsonParseException. More...
	JsonParseException (ErrorType type, TextPosition position)
	Initializes a new instance of JsonParseException with the given error type and position. More...
	JsonParseException (string message, ErrorType type, TextPosition position)
	Initializes a new instance of JsonParseException with the given message, error type, and position. More...

Properties
TextPosition	Position [get, private set]
	The text position where the error occurred. More...
ErrorType	Type [get, private set]
	The type of error that caused the exception to be thrown. More...

Static Private Member Functions
static string	GetDefaultMessage (ErrorType type)

Detailed Description

The exception that is thrown when a JSON message cannot be parsed.

Definition at line 8 of file JsonParseException.cs.

Member Enumeration Documentation

ErrorType

enum LightJson.Serialization.JsonParseException.ErrorType : int

strong

Types of errors that can occur when parsing a JSON message.

Enumerator
Unknown	The cause of the error is unknown.
IncompleteMessage	The text ended before the message could be parsed.
DuplicateObjectKeys	A JsonObject contains more than one key with the same name.
InvalidOrUnexpectedCharacter	The parser encountered and invalid or unexpected character.

Definition at line 62 of file JsonParseException.cs.

                              : int
        {
            Unknown = 0,

            IncompleteMessage,

            DuplicateObjectKeys,

            InvalidOrUnexpectedCharacter,
        }

Constructor & Destructor Documentation

JsonParseException() [1/3]

LightJson.Serialization.JsonParseException.JsonParseException ( )

inline

Initializes a new instance of JsonParseException.

Definition at line 19 of file JsonParseException.cs.

            : base(GetDefaultMessage(ErrorType.Unknown)) { }

JsonParseException() [2/3]

LightJson.Serialization.JsonParseException.JsonParseException ( ErrorType  type, TextPosition  position  )

inline

Initializes a new instance of JsonParseException with the given error type and position.

Parameters

type	The error type that describes the cause of the error.
position	The position in the text where the error occurred.

Definition at line 27 of file JsonParseException.cs.

            : this(GetDefaultMessage(type), type, position) { }

JsonParseException() [3/3]

LightJson.Serialization.JsonParseException.JsonParseException ( string  message, ErrorType  type, TextPosition  position  )

inline

Initializes a new instance of JsonParseException with the given message, error type, and position.

Parameters

message	The message that describes the error.
type	The error type that describes the cause of the error.
position	The position in the text where the error occurred.

Definition at line 36 of file JsonParseException.cs.

            : base(message)
        {
            Type = type;
            Position = position;
        }

Member Function Documentation

GetDefaultMessage()

static string LightJson.Serialization.JsonParseException.GetDefaultMessage ( ErrorType  type )

inlinestaticprivate

Definition at line 43 of file JsonParseException.cs.

        {
            switch (type)
            {
                case ErrorType.IncompleteMessage:
                    return "The string ended before a value could be parsed.";

                case ErrorType.InvalidOrUnexpectedCharacter:
                    return "The parser encountered an invalid or unexpected character.";

                case ErrorType.DuplicateObjectKeys:
                    return "The parser encountered a JsonObject with duplicate keys.";

                default:
                    return "An error occurred while parsing the JSON message.";
            }
        }

Property Documentation

Position

TextPosition LightJson.Serialization.JsonParseException.Position

getprivate set

The text position where the error occurred.

Definition at line 11 of file JsonParseException.cs.

Type

ErrorType LightJson.Serialization.JsonParseException.Type

getprivate set

The type of error that caused the exception to be thrown.

Definition at line 14 of file JsonParseException.cs.

Referenced by LightJson.Serialization.TextScanner.Assert().

---

The documentation for this class was generated from the following file:

• LightJSON/Serialization/JsonParseException.cs