AnalysisOptionsProvider class

Provide the options found in the analysis options file.

Constructors

AnalysisOptionsProvider([SourceFactory sourceFactory])

Properties

hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
sourceFactory ↔ SourceFactory
The source factory used to resolve include declarations in analysis options files or null if include is not supported.
read / write

Methods

getOptions(Folder root, {bool crawlUp: false}) YamlMap
Provide the options found in root/AnalysisEngine.ANALYSIS_OPTIONS_YAML_FILE. Recursively merge options referenced by an include directive and remove the include directive from the resulting options map. Return an empty options map if the file does not exist.
getOptionsFile(Folder root, {bool crawlUp: false}) File
Return the analysis options file from which options should be read, or null if there is no analysis options file for code in the given root. [...]
getOptionsFromFile(File file) YamlMap
Provide the options found in file. Recursively merge options referenced by an include directive and remove the include directive from the resulting options map. Return an empty options map if the file does not exist.
getOptionsFromSource(Source source) YamlMap
Provide the options found in source. Recursively merge options referenced by an include directive and remove the include directive from the resulting options map. Return an empty options map if the file does not exist.
getOptionsFromString(String optionsSource) YamlMap
Provide the options found in optionsSource. An include directive, if present, will be left as-is, and the referenced options will NOT be merged into the result. Return an empty options map if the source is null.
merge(YamlMap defaults, YamlMap overrides) YamlMap
Merge the given options contents where the values in defaults may be overridden by overrides. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) bool
The equality operator. [...]
inherited