MessageProperty class
Debugging message displayed like a property.
The following two properties are better expressed using this
MessageProperty class, rather than StringProperty, as the intent is to
show a message with property style display rather than to describe the value
of an actual property of the object:
var table = MessageProperty('table size', '$columns\u00D7$rows');
var usefulness = MessageProperty('usefulness ratio', 'no metrics collected yet (never painted)');
On the other hand, StringProperty is better suited when the property has a
concrete value that is a string:
var name = StringProperty('name', _name);See also:
- DiagnosticsNode.message, which serves the same role for messages without a clear property name.
- StringProperty, which is a better fit for properties with string values.
- Inheritance
- Object
- DiagnosticsNode
- DiagnosticsProperty<
void> - MessageProperty
Constructors
- MessageProperty(String name, String message, { DiagnosticLevel level: DiagnosticLevel.info })
- Create a diagnostics property that displays a message. [...]
Properties
- 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
- 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
- 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 → void
-
Returns the value of the property either from cache or by invoking a
ComputePropertyValueCallback. [...]
read-only, inherited
Methods
-
getChildren(
) → List< DiagnosticsNode> -
Children of this DiagnosticsNode. [...]
inherited
-
getProperties(
) → List< DiagnosticsNode> -
Properties of this DiagnosticsNode. [...]
inherited
-
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 non-existent 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. [...]
inherited
-
toJsonMap(
) → Map< String, Object> -
Serialize the node excluding its descendants to a JSON map. [...]
inherited
-
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 }) → String -
Returns a string representation of this node and its descendants. [...]
inherited
-
valueToString(
{TextTreeConfiguration parentConfiguration }) → String -
Returns a string representation of the property value. [...]
inherited
Operators
-
operator ==(
dynamic other) → bool -
The equality operator. [...]
inherited