DartdocOptionRoot class
This is a DartdocOptionSet used as a root node.
- Inheritance
-
- Object
- DartdocOption<
void> - DartdocOptionSet
- DartdocOptionRoot
Constructors
- DartdocOptionRoot(String name, ResourceProvider resourceProvider)
Properties
- argParser → ArgParser
-
no setter
- defaultsTo → void
-
This is the value returned if we couldn't find one otherwise.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- help → String
-
Text string for help passed on in command line options.
finalinherited
- isDir → bool
-
Set to true if this option represents the name of a directory.
no setterinherited
- isFile → bool
-
Set to true if this option represents the name of a file.
no setterinherited
- isGlob → bool
-
Set to true if this option represents a glob.
no setterinherited
-
keys
→ Iterable<
String> -
All object names starting at the root.
no setterinherited
- mustExist → bool
-
Set to true if DartdocOption subclasses should validate that the
directory or file exists. Does not imply validation of defaultsTo,
and requires that one of isDir or isFile is set.
finalinherited
- name → String
-
The name of this option, not including the names of any parents.
finalinherited
- optionIs → OptionKind
-
finalinherited
-
parent
↔ DartdocOption<
Object?> -
To avoid accessing early, call add on the option's parent before
looking up unless this is a DartdocOptionRoot.
getter/setter pairinherited-setteroverride-getter
- resourceProvider → ResourceProvider
-
finalinherited
- root → DartdocOptionRoot
-
The DartdocOptionRoot containing this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
add(
DartdocOption< Object?> option) → void -
Adds a DartdocOption to the children of this DartdocOption.
inherited
-
addAll(
Iterable< DartdocOption< options) → voidObject?> > -
Adds a list of dartdoc options to the children of this DartdocOption.
inherited
-
getValueAs<
U> (String name, Folder dir) → U -
Get the immediate child of this node named
name
and its value atdir
.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
parseArguments(
List< String> arguments) → void -
Call this with argv to set up the argument overrides. Applies to all
children.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
traverse(
void visitor(DartdocOption< Object?> option)) → void -
Traverse skips this node, because it doesn't represent a real
configuration object.
override
-
valueAt(
Folder dir) → void -
DartdocOptionSet always has the null value.
inherited
-
valueAtCurrent(
) → Object? -
Calls valueAt with the working directory at the start of the program.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator [](
String name) → DartdocOption< Object?> -
Get the immediate child of this node named
name
.inherited
Static Methods
-
fromOptionGenerators(
String name, Iterable< OptionGenerator> optionGenerators, PackageMetaProvider packageMetaProvider) → DartdocOptionRoot - Asynchronous factory that is the main entry point to initialize Dartdoc options for use.