ErrorSummary class

A short (one line) description of the problem that was detected.

Error summaries from the same source location should have little variance, so that they can be recognized as related. For example, they shouldn't include hash codes.

A FlutterError must start with an ErrorSummary and may not contain multiple summaries.

See also:

  • ErrorDescription, which provides an explanation of the problem and its cause, any information that may help track down the problem, background information, etc.
  • ErrorHint, which provides specific, non-obvious advice that may be applicable.
  • FlutterError, which is the most common place to use an ErrorSummary.


ErrorSummary(String message)
A lint enforces that this constructor can only be called with a string literal to match the limitations of the Dart Kernel transformer that optionally extracts out objects referenced using string interpolation in the message passed in. [...]


allowNameWrap bool
Whether to wrap the name onto multiple lines or not.
final, inherited
allowTruncate bool
Whether to allow truncation when displaying the node and its children.
read-only, inherited
allowWrap bool
Whether to wrap text on onto multiple lines or not.
final, inherited
defaultValue Object
If the value of the property equals defaultValue the priority level of the property is downgraded to DiagnosticLevel.fine as the property value is uninteresting. [...]
final, inherited
emptyBodyDescription String
Description to show if the node has no displayed properties or children.
read-only, inherited
exception Object
Exception thrown if accessing the property value threw an exception. [...]
read-only, inherited
expandableValue bool
Whether to expose properties and children of the value as properties and children.
final, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
ifEmpty String
Description if the property description would otherwise be empty.
final, inherited
ifNull String
Description if the property value is null.
final, inherited
level DiagnosticLevel
Priority level of the diagnostic used to control which diagnostics should be shown and filtered. [...]
read-only, inherited
linePrefix String
Prefix to include at the start of each line
final, inherited
missingIfNull bool
Whether a value of null causes the property to have level DiagnosticLevel.warning warning that the property is missing a value.
final, inherited
name String
Label describing the DiagnosticsNode, typically shown before a separator (see showSeparator). [...]
final, inherited
propertyType Type
The type of the property value. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
showName bool
Whether the name of the property should be shown when showing the default view of the tree. [...]
final, inherited
showSeparator bool
Whether to show a separator between name and description. [...]
final, inherited
style DiagnosticsTreeStyle
Hint for how the node should be displayed.
final, inherited
textTreeConfiguration TextTreeConfiguration
Returns a configuration specifying how this object should be rendered as text art.
@protected, read-only, inherited
tooltip String
Optional tooltip typically describing the property. [...]
final, inherited
value List<Object>
Returns the value of the property either from cache or by invoking a ComputePropertyValueCallback. [...]
read-only, inherited


getChildren() List<DiagnosticsNode>
Children of this DiagnosticsNode. [...]
getProperties() List<DiagnosticsNode>
Properties of this DiagnosticsNode. [...]
isFiltered(DiagnosticLevel minLevel) bool
Whether the diagnostic should be filtered due to its level being lower than minLevel. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
toDescription({TextTreeConfiguration parentConfiguration }) String
Returns a description with a short summary of the node itself not including children or properties. [...]
toJsonMap(DiagnosticsSerializationDelegate delegate) Map<String, Object>
Serialize the node to a JSON map according to the configuration provided in the DiagnosticsSerializationDelegate. [...]
toString({TextTreeConfiguration parentConfiguration, DiagnosticLevel minLevel: }) String
Returns a string representation of this diagnostic that is compatible with the style of the parent if the node is not the root. [...]
toStringDeep({String prefixLineOne: '', String prefixOtherLines, TextTreeConfiguration parentConfiguration, DiagnosticLevel minLevel: DiagnosticLevel.debug }) String
Returns a string representation of this node and its descendants. [...]
valueToString({TextTreeConfiguration parentConfiguration }) String
Returns a string representation of the property value. [...]


operator ==(dynamic other) bool
The equality operator. [...]