Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- apply(Project) - Method in class io.github.reqstool.gradle.RequirementsToolPlugin
-
Applies the plugin to a Gradle project.
E
- execute() - Method in class io.github.reqstool.gradle.RequirementsToolTask
-
Executes the task.
G
- getDatasetPath() - Method in class io.github.reqstool.gradle.RequirementsToolExtension
-
Returns the dataset directory containing
requirements.ymland optional supporting files. - getDatasetPath() - Method in class io.github.reqstool.gradle.RequirementsToolTask
-
Returns the dataset directory containing requirements and supporting files.
- getOutputDirectory() - Method in class io.github.reqstool.gradle.RequirementsToolExtension
-
Returns the output directory where the ZIP artifact and combined annotations are written.
- getOutputDirectory() - Method in class io.github.reqstool.gradle.RequirementsToolTask
-
Returns the output directory file property.
- getOutputDirectoryPath() - Method in class io.github.reqstool.gradle.RequirementsToolTask
-
Returns the absolute path to the output directory.
- getProjectBasedir() - Method in class io.github.reqstool.gradle.RequirementsToolTask
-
Returns the base directory of the project.
- getProjectName() - Method in class io.github.reqstool.gradle.RequirementsToolTask
-
Returns the name of the project being built.
- getProjectVersion() - Method in class io.github.reqstool.gradle.RequirementsToolTask
-
Returns the version of the project being built.
- getRequirementsAnnotationsFile() - Method in class io.github.reqstool.gradle.RequirementsToolExtension
-
Returns the path to the requirements annotations YAML file generated by the annotation processor.
- getRequirementsAnnotationsFile() - Method in class io.github.reqstool.gradle.RequirementsToolTask
-
Returns the path to the requirements annotations YAML file.
- getSkip() - Method in class io.github.reqstool.gradle.RequirementsToolExtension
-
Returns whether the entire plugin execution should be skipped.
- getSkip() - Method in class io.github.reqstool.gradle.RequirementsToolTask
-
Returns whether this task execution should be skipped.
- getSkipAssembleZipArtifact() - Method in class io.github.reqstool.gradle.RequirementsToolExtension
-
Returns whether ZIP artifact assembly should be skipped while still combining annotations.
- getSkipAssembleZipArtifact() - Method in class io.github.reqstool.gradle.RequirementsToolTask
-
Returns whether ZIP artifact assembly should be skipped.
- getSkipAttachZipArtifact() - Method in class io.github.reqstool.gradle.RequirementsToolExtension
-
Returns whether attaching the ZIP artifact for Maven publishing should be skipped.
- getSkipAttachZipArtifact() - Method in class io.github.reqstool.gradle.RequirementsToolTask
-
Returns whether artifact attachment should be skipped.
- getSvcsAnnotationsFiles() - Method in class io.github.reqstool.gradle.RequirementsToolExtension
-
Returns the collection of SVCs (Software Verification Cases) annotations YAML files generated by the annotation processor for each test source set.
- getSvcsAnnotationsFiles() - Method in class io.github.reqstool.gradle.RequirementsToolTask
-
Returns the collection of SVCs (Software Verification Cases) annotations YAML files, one per test source set.
- getTestResults() - Method in class io.github.reqstool.gradle.RequirementsToolExtension
-
Returns the list of Ant-style glob patterns used to locate test result XML files.
- getTestResults() - Method in class io.github.reqstool.gradle.RequirementsToolTask
-
Returns the list of test result file glob patterns.
- getZipFile() - Method in class io.github.reqstool.gradle.RequirementsToolTask
-
Returns the path where the reqstool ZIP artifact will be written.
I
- INPUT_FILE_MANUAL_VERIFICATION_RESULTS_YML - Static variable in class io.github.reqstool.gradle.RequirementsToolTask
-
Filename for manual verification results YAML input file.
- INPUT_FILE_REQUIREMENTS_YML - Static variable in class io.github.reqstool.gradle.RequirementsToolTask
-
Filename for requirements YAML input file.
- INPUT_FILE_SOFTWARE_VERIFICATION_CASES_YML - Static variable in class io.github.reqstool.gradle.RequirementsToolTask
-
Filename for software verification cases YAML input file.
- io.github.reqstool.gradle - package io.github.reqstool.gradle
- isSvcsAnnotationsFilesExplicit() - Method in class io.github.reqstool.gradle.RequirementsToolExtension
-
Returns whether
RequirementsToolExtension.getSvcsAnnotationsFiles()was explicitly configured.
O
- OUTPUT_ARTIFACT_DIR_TEST_RESULTS - Static variable in class io.github.reqstool.gradle.RequirementsToolTask
-
Directory name for test results within the ZIP artifact.
- OUTPUT_ARTIFACT_FILE_REQSTOOL_CONFIG_YML - Static variable in class io.github.reqstool.gradle.RequirementsToolTask
-
Filename for reqstool configuration YAML file.
- OUTPUT_FILE_ANNOTATIONS_YML_FILE - Static variable in class io.github.reqstool.gradle.RequirementsToolTask
-
Filename for combined annotations YAML output file.
R
- RequirementsToolExtension - Class in io.github.reqstool.gradle
-
Extension for configuring the Reqstool Gradle Plugin.
- RequirementsToolExtension(Project) - Constructor for class io.github.reqstool.gradle.RequirementsToolExtension
-
Constructs a RequirementsToolExtension with default configuration values.
- RequirementsToolPlugin - Class in io.github.reqstool.gradle
-
Gradle plugin for assembling and attaching reqstool ZIP artifacts.
- RequirementsToolPlugin() - Constructor for class io.github.reqstool.gradle.RequirementsToolPlugin
-
Default constructor for RequirementsToolPlugin.
- RequirementsToolTask - Class in io.github.reqstool.gradle
-
Task for assembling reqstool ZIP artifact.
- RequirementsToolTask() - Constructor for class io.github.reqstool.gradle.RequirementsToolTask
-
Default constructor for RequirementsToolTask.
S
- setSvcsAnnotationsFile(Object) - Method in class io.github.reqstool.gradle.RequirementsToolExtension
-
Deprecated.
- setSvcsAnnotationsFiles(Object...) - Method in class io.github.reqstool.gradle.RequirementsToolExtension
-
Replaces the auto-discovered SVCs annotations file collection with explicit paths and disables auto-wired compile task dependencies.
X
- XML_IMPLEMENTATIONS - Static variable in class io.github.reqstool.gradle.RequirementsToolTask
-
XML element name for requirement implementations.
- XML_REQUIREMENT_ANNOTATIONS - Static variable in class io.github.reqstool.gradle.RequirementsToolTask
-
XML element name for requirement annotations.
- XML_TESTS - Static variable in class io.github.reqstool.gradle.RequirementsToolTask
-
XML element name for tests.
Y
- YAML_LANG_SERVER_SCHEMA_ANNOTATIONS - Static variable in class io.github.reqstool.gradle.RequirementsToolTask
-
YAML language server schema hint for annotations files.
- YAML_LANG_SERVER_SCHEMA_CONFIG - Static variable in class io.github.reqstool.gradle.RequirementsToolTask
-
YAML language server schema hint for reqstool config files.
All Classes and Interfaces|All Packages|Constant Field Values
RequirementsToolExtension.getSvcsAnnotationsFiles()instead.