dart:core

ArgumentError class

Error thrown when a function is passed an unacceptable argument.

The method should document restrictions on the arguments it accepts, for example if an integer argument must be non-nullable, a string argument must be non-empty, or a dynamic-typed argument must actually have one of a few accepted types.

The user should be able to predict which arguments will cause an error to be throw, and avoid calling with those.

It's almost always a good idea to provide the unacceptable value as part of the error, to help the user figure out what vent wrong, so the ArgumentError.value constructor is the preferred constructor. Use ArgumentError.new only when the value cannot be provided for some reason.

Inheritance

• Object
• Error
• ArgumentError

Implementers

• IndexError
• RangeError

Constructors

ArgumentError([dynamic message, @Since("2.14") String? name])

Creates an error with message describing the problem with an argument.

ArgumentError.notNull([String? name])

Creates an argument error for a null argument that must not be null.

ArgumentError.value(dynamic value, [String? name, dynamic message])

Creates error containing the invalid value.

Properties

hashCode → int

read-onlyinherited

The hash code for this object.

invalidValue → dynamic

final

The invalid value.

message → dynamic

final

Message describing the problem.

name → String?

final

Name of the invalid argument, if available.

runtimeType → Type

read-onlyinherited

A representation of the runtime type of the object.

stackTrace → StackTrace?

read-onlyinherited

The stack trace at the point where this error was first thrown.

Methods

noSuchMethod(Invocation invocation) → dynamic

inherited

Invoked when a non-existent method or property is accessed.

toString() → String

override

A string representation of this object.

Operators

operator ==(Object other) → bool

inherited

The equality operator.

Static Methods

checkNotNull<@Since("2.8") T>(T? argument, [String? name]) → T

Throws if argument is null.