toString method

  1. @override
String toString()
override

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Implementation

@override
String toString() {
  final StringBuffer buffer = StringBuffer(message);

  if (element case final Element element?) {
    try {
      final SourceSpan span = spanForElement(element);
      buffer
        ..writeln()
        ..writeln(span.start.toolString)
        ..write(span.highlight());
    } catch (e) {
      buffer
        ..writeln()
        ..writeln('Cause: ${element.runtimeType} : ${element.name}');
    }
  }

  if (node case final AstNode node?) {
    try {
      final SourceSpan span = spanForNode(node);
      buffer
        ..writeln()
        ..writeln(span.start.toolString)
        ..write(span.highlight());
    } catch (_) {
      buffer
        ..writeln()
        ..writeln('Cause: $node');
    }
  }

  return buffer.toString();
}