BrickVariableProperties class
An object representing a brick variable.
- Annotations
-
- @immutable
- @JsonSerializable()
Constructors
-
BrickVariableProperties({required BrickVariableType type, String? description, Object? defaultValue, Object? defaultValues, String? prompt, List<
String> ? values, String? separator}) -
An object representing a brick variable.
const
-
BrickVariableProperties.array({required List<
String> values, String? description, List<String> ? defaultValues, String? prompt}) -
An object representing a brick variable.
const
- BrickVariableProperties.boolean({String? description, bool? defaultValue, String? prompt})
-
An object representing a brick variable.
const
-
BrickVariableProperties.enumeration({required List<
String> values, String? description, String? defaultValue, String? prompt}) -
An object representing a brick variable.
const
- BrickVariableProperties.fromJson(Map json)
-
Converts Map to BrickYaml
factory
- BrickVariableProperties.list({String? description, String? prompt, String? separator})
-
An object representing a brick variable.
const
- BrickVariableProperties.number({String? description, num? defaultValue, String? prompt})
-
An object representing a brick variable.
const
- BrickVariableProperties.string({String? description, String? defaultValue, String? prompt})
-
An object representing a brick variable.
const
Properties
- defaultValue → Object?
-
An optional default value for the variable.
final
- defaultValues → Object?
-
Optional default values for the variable used
when type is BrickVariableType.array.
final
- description → String?
-
An optional description of the variable.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- prompt → String?
-
An optional prompt used when requesting the variable.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- separator → String?
-
An optional separator used when type is:
final
- type → BrickVariableType
-
The type of the variable.
final
-
values
→ List<
String> ? -
An optional list of values used when type is:
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map - Converts BrickVariableProperties to Map
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited