Index

A C D E F H I L M O P R S T V W
All Classes and Interfaces|All Packages

A

AbstractDocLintMojo - Class in ch.so.agi.hop.doclint.mojo

Base implementation of the DocLint goals.

AbstractDocLintMojo() - Constructor for class ch.so.agi.hop.doclint.mojo.AbstractDocLintMojo

ACTION - Enum constant in enum class ch.so.agi.hop.doclint.model.PluginType

annotationName() - Method in enum class ch.so.agi.hop.doclint.model.PluginType

AsciiDocPage - Class in ch.so.agi.hop.doclint.doc

Minimal AsciiDoc reader for the doclint contract: document attributes and level-2 sections.

attribute(String) - Method in class ch.so.agi.hop.doclint.doc.AsciiDocPage

C

ch.so.agi.hop_plugin_doclint_maven_plugin - package ch.so.agi.hop_plugin_doclint_maven_plugin

ch.so.agi.hop.doclint.config - package ch.so.agi.hop.doclint.config

ch.so.agi.hop.doclint.doc - package ch.so.agi.hop.doclint.doc

ch.so.agi.hop.doclint.model - package ch.so.agi.hop.doclint.model

ch.so.agi.hop.doclint.mojo - package ch.so.agi.hop.doclint.mojo

ch.so.agi.hop.doclint.report - package ch.so.agi.hop.doclint.report

ch.so.agi.hop.doclint.scan - package ch.so.agi.hop.doclint.scan

ch.so.agi.hop.doclint.validate - package ch.so.agi.hop.doclint.validate

check() - Method in record class ch.so.agi.hop.doclint.model.CheckResult

Returns the value of the check record component.

CheckMojo - Class in ch.so.agi.hop.doclint.mojo

Runs the metadata, documentation and example checks; the goal wired into verify.

CheckMojo() - Constructor for class ch.so.agi.hop.doclint.mojo.CheckMojo

CheckResult - Record Class in ch.so.agi.hop.doclint.model

Result of a single check.

CheckResult(String, String, CheckStatus, String) - Constructor for record class ch.so.agi.hop.doclint.model.CheckResult

Creates an instance of a CheckResult record class.

CheckStatus - Enum Class in ch.so.agi.hop.doclint.model

Outcome of a single documentation check.

classesDirectory - Variable in class ch.so.agi.hop.doclint.mojo.AbstractDocLintMojo

className() - Method in class ch.so.agi.hop.doclint.model.PluginElement

D

detail() - Method in record class ch.so.agi.hop.doclint.model.CheckResult

Returns the value of the detail record component.

display(Path) - Method in record class ch.so.agi.hop.doclint.config.DocLintConfig

Renders a path relative to the repository root when possible, for stable messages.

DocLintConfig - Record Class in ch.so.agi.hop.doclint.config

Resolved DocLint settings for one Maven project.

DocLintConfig(Path, Path, Path, boolean, boolean, boolean) - Constructor for record class ch.so.agi.hop.doclint.config.DocLintConfig

Creates an instance of a DocLintConfig record class.

docsDirectory - Variable in class ch.so.agi.hop.doclint.mojo.AbstractDocLintMojo

docsDirectory() - Method in record class ch.so.agi.hop.doclint.config.DocLintConfig

Returns the value of the docsDirectory record component.

docsSubdirectory() - Method in enum class ch.so.agi.hop.doclint.model.PluginType

documentationEnabled() - Method in class ch.so.agi.hop.doclint.mojo.AbstractDocLintMojo

documentationEnabled() - Method in class ch.so.agi.hop.doclint.mojo.CheckMojo

documentationEnabled() - Method in class ch.so.agi.hop.doclint.mojo.DocumentationMojo

documentationEnabled() - Method in class ch.so.agi.hop.doclint.mojo.MetadataMojo

documentationEnabled() - Method in class ch.so.agi.hop.doclint.mojo.SamplesMojo

DocumentationMojo - Class in ch.so.agi.hop.doclint.mojo

Validates the AsciiDoc pages referenced by the Hop plugin annotations.

DocumentationMojo() - Constructor for class ch.so.agi.hop.doclint.mojo.DocumentationMojo

DocumentationValidator - Class in ch.so.agi.hop.doclint.validate

Validates the AsciiDoc page of every discovered plugin element.

DocumentationValidator() - Constructor for class ch.so.agi.hop.doclint.validate.DocumentationValidator

E

elementId() - Method in record class ch.so.agi.hop.doclint.model.CheckResult

Returns the value of the elementId record component.

elements() - Method in record class ch.so.agi.hop.doclint.scan.PluginElementScanner.ScanOutcome

Returns the value of the elements record component.

equals(Object) - Method in record class ch.so.agi.hop.doclint.config.DocLintConfig

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class ch.so.agi.hop.doclint.model.CheckResult

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class ch.so.agi.hop.doclint.scan.PluginElementScanner.ScanOutcome

Indicates whether some other object is "equal to" this one.

examplesDirectory - Variable in class ch.so.agi.hop.doclint.mojo.AbstractDocLintMojo

examplesDirectory() - Method in record class ch.so.agi.hop.doclint.config.DocLintConfig

Returns the value of the examplesDirectory record component.

execute() - Method in class ch.so.agi.hop_plugin_doclint_maven_plugin.HelpMojo

execute() - Method in class ch.so.agi.hop.doclint.mojo.AbstractDocLintMojo

F

fail(String, String) - Static method in record class ch.so.agi.hop.doclint.model.CheckResult

fail(String, String, String) - Static method in record class ch.so.agi.hop.doclint.model.CheckResult

FAIL - Enum constant in enum class ch.so.agi.hop.doclint.model.CheckStatus

H

has(String) - Method in class ch.so.agi.hop.doclint.model.PluginElement

hasAnchor(String) - Method in class ch.so.agi.hop.doclint.doc.AsciiDocPage

True when the page declares the given explicit anchor ([[id]] or [#id]).

hashCode() - Method in record class ch.so.agi.hop.doclint.config.DocLintConfig

Returns a hash code value for this object.

hashCode() - Method in record class ch.so.agi.hop.doclint.model.CheckResult

Returns a hash code value for this object.

hashCode() - Method in record class ch.so.agi.hop.doclint.scan.PluginElementScanner.ScanOutcome

Returns a hash code value for this object.

hasIdAliases() - Method in class ch.so.agi.hop.doclint.model.PluginElement

hasList(String) - Method in class ch.so.agi.hop.doclint.model.PluginElement

hasSection(String) - Method in class ch.so.agi.hop.doclint.doc.AsciiDocPage

hasSectionContent(String) - Method in class ch.so.agi.hop.doclint.doc.AsciiDocPage

True when the section exists and contains at least one readable line.

HelpMojo - Class in ch.so.agi.hop_plugin_doclint_maven_plugin

Display help information on hop-plugin-doclint-maven-plugin.
Call mvn hop-plugin-doclint:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

HelpMojo() - Constructor for class ch.so.agi.hop_plugin_doclint_maven_plugin.HelpMojo

I

id() - Method in class ch.so.agi.hop.doclint.model.PluginElement

The primary annotation id; aliases after the first comma are ignored.

id() - Method in enum class ch.so.agi.hop.doclint.model.PluginType

isError() - Method in record class ch.so.agi.hop.doclint.model.CheckResult

isWarning() - Method in record class ch.so.agi.hop.doclint.model.CheckResult

L

label() - Method in enum class ch.so.agi.hop.doclint.model.PluginType

M

METADATA - Enum constant in enum class ch.so.agi.hop.doclint.model.PluginType

metadataEnabled() - Method in class ch.so.agi.hop.doclint.mojo.AbstractDocLintMojo

metadataEnabled() - Method in class ch.so.agi.hop.doclint.mojo.CheckMojo

metadataEnabled() - Method in class ch.so.agi.hop.doclint.mojo.DocumentationMojo

metadataEnabled() - Method in class ch.so.agi.hop.doclint.mojo.MetadataMojo

metadataEnabled() - Method in class ch.so.agi.hop.doclint.mojo.SamplesMojo

MetadataMojo - Class in ch.so.agi.hop.doclint.mojo

Validates the Hop annotation metadata of compiled plugin classes.

MetadataMojo() - Constructor for class ch.so.agi.hop.doclint.mojo.MetadataMojo

MetadataValidator - Class in ch.so.agi.hop.doclint.validate

Validates the Hop annotation metadata of every discovered plugin element.

MetadataValidator() - Constructor for class ch.so.agi.hop.doclint.validate.MetadataValidator

O

ok(String, String) - Static method in record class ch.so.agi.hop.doclint.model.CheckResult

ok(String, String, String) - Static method in record class ch.so.agi.hop.doclint.model.CheckResult

OK - Enum constant in enum class ch.so.agi.hop.doclint.model.CheckStatus

P

parse(String) - Static method in class ch.so.agi.hop.doclint.doc.AsciiDocPage

PluginElement - Class in ch.so.agi.hop.doclint.model

One annotated Hop plugin element discovered on the compiled classes.

PluginElement(PluginType, String, String, Map<String, Object>) - Constructor for class ch.so.agi.hop.doclint.model.PluginElement

PluginElementScanner - Class in ch.so.agi.hop.doclint.scan

Discovers Hop plugin annotations on compiled classes.

PluginElementScanner() - Constructor for class ch.so.agi.hop.doclint.scan.PluginElementScanner

PluginElementScanner.ScanOutcome - Record Class in ch.so.agi.hop.doclint.scan

Discovered plugin elements and the number of classes that were scanned.

PluginType - Enum Class in ch.so.agi.hop.doclint.model

Hop plugin element types understood by the linter.

project - Variable in class ch.so.agi.hop.doclint.mojo.AbstractDocLintMojo

R

rawId() - Method in class ch.so.agi.hop.doclint.model.PluginElement

read(Path) - Static method in class ch.so.agi.hop.doclint.doc.AsciiDocPage

ReportWriter - Class in ch.so.agi.hop.doclint.report

Writes the DocLint console report grouped by plugin element.

ReportWriter(Log) - Constructor for class ch.so.agi.hop.doclint.report.ReportWriter

repositoryRoot() - Method in record class ch.so.agi.hop.doclint.config.DocLintConfig

Returns the value of the repositoryRoot record component.

requireDocumentation - Variable in class ch.so.agi.hop.doclint.mojo.AbstractDocLintMojo

requireDocumentation() - Method in record class ch.so.agi.hop.doclint.config.DocLintConfig

Returns the value of the requireDocumentation record component.

requiredSections() - Method in enum class ch.so.agi.hop.doclint.model.PluginType

requireExamples - Variable in class ch.so.agi.hop.doclint.mojo.AbstractDocLintMojo

requireExamples() - Method in record class ch.so.agi.hop.doclint.config.DocLintConfig

Returns the value of the requireExamples record component.

requireKeywords - Variable in class ch.so.agi.hop.doclint.mojo.AbstractDocLintMojo

requireKeywords() - Method in record class ch.so.agi.hop.doclint.config.DocLintConfig

Returns the value of the requireKeywords record component.

S

samplesEnabled() - Method in class ch.so.agi.hop.doclint.mojo.AbstractDocLintMojo

samplesEnabled() - Method in class ch.so.agi.hop.doclint.mojo.CheckMojo

samplesEnabled() - Method in class ch.so.agi.hop.doclint.mojo.DocumentationMojo

samplesEnabled() - Method in class ch.so.agi.hop.doclint.mojo.MetadataMojo

samplesEnabled() - Method in class ch.so.agi.hop.doclint.mojo.SamplesMojo

SamplesMojo - Class in ch.so.agi.hop.doclint.mojo

Validates the user examples under examples/ for every Hop plugin element.

SamplesMojo() - Constructor for class ch.so.agi.hop.doclint.mojo.SamplesMojo

SampleValidator - Class in ch.so.agi.hop.doclint.validate

Validates that every plugin element has a user example under examples/.

SampleValidator() - Constructor for class ch.so.agi.hop.doclint.validate.SampleValidator

scan(Path) - Method in class ch.so.agi.hop.doclint.scan.PluginElementScanner

scanned() - Static method in enum class ch.so.agi.hop.doclint.model.PluginType

Types that are currently discovered on the compiled classes.

scannedClasses() - Method in record class ch.so.agi.hop.doclint.scan.PluginElementScanner.ScanOutcome

Returns the value of the scannedClasses record component.

ScanOutcome(List<PluginElement>, int) - Constructor for record class ch.so.agi.hop.doclint.scan.PluginElementScanner.ScanOutcome

Creates an instance of a ScanOutcome record class.

session - Variable in class ch.so.agi.hop.doclint.mojo.AbstractDocLintMojo

skip - Variable in class ch.so.agi.hop.doclint.mojo.AbstractDocLintMojo

skip(String, String) - Static method in record class ch.so.agi.hop.doclint.model.CheckResult

SKIP - Enum constant in enum class ch.so.agi.hop.doclint.model.CheckStatus

status() - Method in record class ch.so.agi.hop.doclint.model.CheckResult

Returns the value of the status record component.

T

text(String) - Method in class ch.so.agi.hop.doclint.model.PluginElement

textList(String) - Method in class ch.so.agi.hop.doclint.model.PluginElement

toString() - Method in record class ch.so.agi.hop.doclint.config.DocLintConfig

Returns a string representation of this record class.

toString() - Method in record class ch.so.agi.hop.doclint.model.CheckResult

Returns a string representation of this record class.

toString() - Method in class ch.so.agi.hop.doclint.model.PluginElement

toString() - Method in record class ch.so.agi.hop.doclint.scan.PluginElementScanner.ScanOutcome

Returns a string representation of this record class.

TRANSFORM - Enum constant in enum class ch.so.agi.hop.doclint.model.PluginType

type() - Method in class ch.so.agi.hop.doclint.model.PluginElement

typeId() - Method in class ch.so.agi.hop.doclint.model.PluginElement

V

validate(List<PluginElement>, DocLintConfig) - Method in class ch.so.agi.hop.doclint.validate.DocumentationValidator

validate(List<PluginElement>, DocLintConfig) - Method in class ch.so.agi.hop.doclint.validate.SampleValidator

validate(List<PluginElement>, DocLintConfig, Path) - Method in class ch.so.agi.hop.doclint.validate.MetadataValidator

valueOf(String) - Static method in enum class ch.so.agi.hop.doclint.model.CheckStatus

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class ch.so.agi.hop.doclint.model.PluginType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class ch.so.agi.hop.doclint.model.CheckStatus

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class ch.so.agi.hop.doclint.model.PluginType

Returns an array containing the constants of this enum class, in the order they are declared.

W

warn(String, String, String) - Static method in record class ch.so.agi.hop.doclint.model.CheckResult

WARN - Enum constant in enum class ch.so.agi.hop.doclint.model.CheckStatus

write(List<PluginElement>, List<CheckResult>) - Method in class ch.so.agi.hop.doclint.report.ReportWriter

A C D E F H I L M O P R S T V W
All Classes and Interfaces|All Packages