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 represetion.

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() {
  const divider = '=========================================================';
  final buffer = StringBuffer('PackageGraph built from ');
  buffer.writeln(defaultPackageName);
  buffer.writeln(divider);
  buffer.writeln();
  for (final name in packageMap.keys) {
    final package = packageMap[name];
    buffer.write('Package $name documented at ${package.documentedWhere} '
        'with libraries: ');
    buffer.writeAll(package.allLibraries);
    buffer.writeln();
  }
  buffer.writeln(divider);
  return buffer.toString();
}