DiagnosticsProperty<T> class

Property with a value of type T.

If the default value.toString() does not provide an adequate description of the value, specify description defining a custom description.

The showSeparator property indicates whether a separator should be placed between the property name and its value.

Inheritance
Implementers

Constructors

DiagnosticsProperty(String? name, T? value, {String? description, String? ifNull, String? ifEmpty, bool showName = true, bool showSeparator = true, Object? defaultValue = kNoDefaultValue, String? tooltip, bool missingIfNull = false, String? linePrefix, bool expandableValue = false, bool allowWrap = true, bool allowNameWrap = true, DiagnosticsTreeStyle style = DiagnosticsTreeStyle.singleLine, DiagnosticLevel level = DiagnosticLevel.info})
Create a diagnostics property.
DiagnosticsProperty.lazy(String? name, ComputePropertyValueCallback<T> computeValue, {String? description, String? ifNull, String? ifEmpty, bool showName = true, bool showSeparator = true, Object? defaultValue = kNoDefaultValue, String? tooltip, bool missingIfNull = false, bool expandableValue = false, bool allowWrap = true, bool allowNameWrap = true, DiagnosticsTreeStyle style = DiagnosticsTreeStyle.singleLine, DiagnosticLevel level = DiagnosticLevel.info})
Property with a value that is computed only when needed.

Properties

allowNameWrap → bool
Whether to wrap the name onto multiple lines or not.
final
allowTruncate → bool
Whether to allow truncation when displaying the node and its children.
no setterinherited
allowWrap → bool
Whether to wrap text on onto multiple lines or not.
final
defaultValue → Object?
The default value of this property, when it has not been set to a specific value.
final
emptyBodyDescription → String?
Description to show if the node has no displayed properties or children.
no setterinherited
exception → Object?
Exception thrown if accessing the property value threw an exception.
no setter
expandableValue → bool
Whether to expose properties and children of the value as properties and children.
final
hashCode → int
The hash code for this object.
no setterinherited
ifEmpty → String?
Description if the property description would otherwise be empty.
final
ifNull → String?
Description if the property value is null.
final
isInteresting → bool
Whether to consider the property's value interesting. When a property is uninteresting, its level is downgraded to DiagnosticLevel.fine regardless of the value provided as the constructor's level argument.
no setter
level → DiagnosticLevel
Priority level of the diagnostic used to control which diagnostics should be shown and filtered.
no setteroverride
linePrefix → String?
Prefix to include at the start of each line.
finalinherited
missingIfNull → bool
Whether a value of null causes the property to have level DiagnosticLevel.warning warning that the property is missing a value.
final
name → String?
Label describing the DiagnosticsNode, typically shown before a separator (see showSeparator).
finalinherited
propertyType → Type
The type of the property value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showName → bool
Whether the name of the property should be shown when showing the default view of the tree.
finalinherited
showSeparator → bool
Whether to show a separator between name and description.
finalinherited
style → DiagnosticsTreeStyle?
Hint for how the node should be displayed.
finalinherited
textTreeConfiguration → TextTreeConfiguration?
Returns a configuration specifying how this object should be rendered as text art.
no setterinherited
tooltip → String?
Optional tooltip typically describing the property.
final
value → T?
Returns the value of the property either from cache or by invoking a ComputePropertyValueCallback.
no setteroverride

Methods

getChildren() → List<DiagnosticsNode>
Children of this DiagnosticsNode.
override
getProperties() → List<DiagnosticsNode>
Properties of this DiagnosticsNode.
override
isFiltered(DiagnosticLevel minLevel) → bool
Whether the diagnostic should be filtered due to its level being lower than minLevel.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDescription({TextTreeConfiguration? parentConfiguration}) → String
Returns a description with a short summary of the node itself not including children or properties.
override
toJsonMap(DiagnosticsSerializationDelegate delegate) → Map<String, Object?>
Serialize the node to a JSON map according to the configuration provided in the DiagnosticsSerializationDelegate.
override
toString({TextTreeConfiguration? parentConfiguration, DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
Returns a string representation of this diagnostic that is compatible with the style of the parent if the node is not the root.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, TextTreeConfiguration? parentConfiguration, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toTimelineArguments() → Map<String, String>?
Converts the properties (getProperties) of this node to a form useful for Timeline event arguments (as in Timeline.startSync).
inherited
valueToString({TextTreeConfiguration? parentConfiguration}) → String
Returns a string representation of the property value.

Operators

operator ==(Object other) → bool
The equality operator.
inherited