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
- Object
- DiagnosticsNode
- DiagnosticsProperty
- Implemented by
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, 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, DiagnosticsTreeStyle style: DiagnosticsTreeStyle.singleLine, DiagnosticLevel level: DiagnosticLevel.info }) - Property with a value that is computed only when needed. [...]
Properties
- defaultValue → Object
-
If the
value
of the property equalsdefaultValue
the prioritylevel
of the property is downgraded toDiagnosticLevel.fine
as the property value is uninteresting. [...]final - exception → Object
-
Exception thrown if accessing the property value threw an exception. [...]
read-only
- ifEmpty → String
-
Description if the property description would otherwise be empty.
final
- ifNull → String
-
Description if the property
value
is null.final - level → DiagnosticLevel
-
Priority level of the diagnostic used to control which diagnostics should
be shown and filtered. [...]
read-only
- missingIfNull → bool
-
Whether a
value
of null causes the property to havelevel
DiagnosticLevel.warning
warning that the property is missing avalue
.final - propertyType → Type
-
The type of the property value. [...]
read-only
- 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. [...]
read-only
- emptyBodyDescription → String
-
Description to show if the node has no displayed properties or children.
read-only, inherited
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- name → String
-
Label describing the
DiagnosticsNode
, typically shown before a separator (seeshowSeparator
). [...]final, 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
Methods
-
getChildren(
) → List< DiagnosticsNode> - Children of this DiagnosticsNode. [...]
-
getProperties(
) → List< DiagnosticsNode> - Properties of this DiagnosticsNode. [...]
-
toDescription(
{TextTreeConfiguration parentConfiguration }) → String - Returns a description with a short summary of the node itself not including children or properties. [...]
-
toJsonMap(
) → Map< String, Object> - Serialize the node excluding its descendants to a JSON map. [...]
-
valueToString(
{TextTreeConfiguration parentConfiguration }) → String - Returns a string representation of the property value. [...]
-
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
-
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
Operators
-
operator ==(
dynamic other) → bool -
The equality operator. [...]
inherited