PatchbayCliSyntax class final

One CLI spelling derived from a protocol-owned command descriptor.

This metadata is deliberately local to the Dart packages: it is build-time syntax for the separately deployed CLI, not a runtime capability, and is therefore never included in PatchbayCommandDescriptor.toJson. One service command may expose several spellings when the path injects a fixed argument such as an on/off or ui.wait condition variant.

Constructors

PatchbayCliSyntax({required String id, required List<String> path, required String summary, String usageSuffix = '', List<String> positionalParameters = const <String>[], Map<String, String> optionParameters = const <String, String>{}, Set<String> positiveParameters = const <String>{}, Map<String, Object?> fixedArguments = const <String, Object?>{}, bool fencesNavigationRevision = false, PatchbayCliInputMode inputMode = PatchbayCliInputMode.descriptorParameters, Set<String> nonNegativeParameters = const <String>{}, Set<String> omitOptionDefaults = const <String>{}, String? trailingParameter, String? stdinParameter, String? stdinMarkerParameter, PatchbayCliEqualsCondition? trailingWhen, PatchbayCliArtifactDisposition artifactDisposition = PatchbayCliArtifactDisposition.none})
const

Properties

artifactDisposition → PatchbayCliArtifactDisposition
final
fencesNavigationRevision → bool
Whether an omitted revision is resolved through navigation.current.
final
fixedArguments → Map<String, Object?>
Arguments implied by the chosen path rather than typed by the operator.
final
hashCode → int
The hash code for this object.
no setterinherited
id → String
Stable Dart identifier used by generated CLI registration code.
final
inputMode → PatchbayCliInputMode
final
nonNegativeParameters → Set<String>
final
omitOptionDefaults → Set<String>
final
optionParameters → Map<String, String>
Descriptor parameter name to long option name.
final
path → List<String>
final
positionalParameters → List<String>
Descriptor parameter names, in argv positional order.
final
positiveParameters → Set<String>
Numeric parameters whose CLI spelling accepts positive values only.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stdinMarkerParameter → String?
final
stdinParameter → String?
final
summary → String
final
trailingParameter → String?
final
trailingWhen → PatchbayCliEqualsCondition?
final
usageSuffix → String
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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