Index (architecture-validator 4.1.0 API)

A C G H N S T U
All Classes and Interfaces|All Packages|Constant Field Values

A

apply(Project) - Method in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorPlugin
applyCleanupDsl(boolean) - Method in class com.arc_e_tect.gradle.architecture.UpdateArchitectureValidatorDslTask: Sets getCleanupDsl() for this run only.
applyGenerateDsl(boolean) - Method in class com.arc_e_tect.gradle.architecture.UpdateArchitectureValidatorDslTask: Sets getGenerateDsl() for this run only.
ArchitectureValidatorExtension - Class in com.arc_e_tect.gradle.architecture: DSL extension for the Architecture Validator Gradle plugin.
ArchitectureValidatorExtension(ObjectFactory, ProjectLayout) - Constructor for class com.arc_e_tect.gradle.architecture.ArchitectureValidatorExtension: Creates the extension, with every property already set to its default.
ArchitectureValidatorPlugin - Class in com.arc_e_tect.gradle.architecture: Gradle plugin that registers the testArchitecture JVM test suite, the generateArchitectureTests and updateArchitectureValidatorDSL tasks, and wires the architectureValidator DSL extension into the project.
ArchitectureValidatorPlugin() - Constructor for class com.arc_e_tect.gradle.architecture.ArchitectureValidatorPlugin: Creates a new plugin instance.

C

com.arc_e_tect.gradle.architecture - package com.arc_e_tect.gradle.architecture

G

generate() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Generates the built-in hexagonal architecture test and the external rule pack bridge suite.
GENERATE_ARCHITECTURE_TESTS_TASK_NAME - Static variable in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorPlugin: Name of the test-generating Gradle task registered by this plugin.
GenerateArchitectureTestsTask - Class in com.arc_e_tect.gradle.architecture: Generates the built-in hexagonal architecture test, and a bridge suite for any external rule pack tests discovered on GenerateArchitectureTestsTask.getRulePackClasspath(), under GenerateArchitectureTestsTask.getOutputDirectory().
GenerateArchitectureTestsTask() - Constructor for class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Creates a new task instance.
getAdapters() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Adapter package patterns, matching both inbound and outbound adapters not already covered by GenerateArchitectureTestsTask.getInboundAdapters()/GenerateArchitectureTestsTask.getOutboundAdapters().
getAdapters() - Method in class com.arc_e_tect.gradle.architecture.HexagonalArchitectureExtension: Adapter package patterns, matching both inbound and outbound adapters not already covered by HexagonalArchitectureExtension.getInboundAdapters()/HexagonalArchitectureExtension.getOutboundAdapters().
getBasePackage() - Method in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorExtension: Root package ArchUnit rules are scoped to.
getBasePackage() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: The explicitly configured base package, i.e.
getBuildFile() - Method in class com.arc_e_tect.gradle.architecture.UpdateArchitectureValidatorDslTask: The build file to update - the project's own build.gradle.
getCleanupDsl() - Method in class com.arc_e_tect.gradle.architecture.UpdateArchitectureValidatorDslTask: Strips every comment line from inside the managed block - both pre-existing ones and any doc comment this run would otherwise add - leaving only properties.
getCommonPackages() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Shared/common package patterns, excluded from layer-boundary rules.
getCommonPackages() - Method in class com.arc_e_tect.gradle.architecture.HexagonalArchitectureExtension: Shared/common package patterns, excluded from layer-boundary rules that would otherwise flag code every layer is allowed to depend on.
getConfigurationPackages() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Package patterns holding DI-framework wiring/configuration classes.
getConfigurationPackages() - Method in class com.arc_e_tect.gradle.architecture.HexagonalArchitectureExtension: Package patterns holding Spring (or other DI-framework) wiring/configuration classes.
getDomainAllowedPackages() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: JDK package patterns the domain model is allowed to depend on, in addition to its own GenerateArchitectureTestsTask.getDomainModel() packages.
getDomainAllowedPackages() - Method in class com.arc_e_tect.gradle.architecture.HexagonalArchitectureExtension: JDK package patterns the domain model is allowed to depend on, in addition to its own HexagonalArchitectureExtension.getDomainModel() packages.
getDomainModel() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Domain model package patterns.
getDomainModel() - Method in class com.arc_e_tect.gradle.architecture.HexagonalArchitectureExtension: Domain model package patterns - the innermost ring, holding pure value objects/entities.
getDomainServices() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Domain service package patterns.
getDomainServices() - Method in class com.arc_e_tect.gradle.architecture.HexagonalArchitectureExtension: Domain service package patterns - the layer that implements use-case orchestration and cross-aggregate business rules on top of the domain model.
getFailOnDuplicateRules() - Method in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorExtension: Whether the build fails when duplicate rules are discovered across the built-in rule pack, external rule packs, and hand-written tests.
getFailOnDuplicateRules() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Whether generation fails when duplicate rules are discovered.
getFailOnViolation() - Method in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorExtension: Whether the build fails when a rule is violated.
getFallbackBasePackage() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Base package used only when GenerateArchitectureTestsTask.getBasePackage() is blank and no package could be inferred from GenerateArchitectureTestsTask.getMainSourceDirectory()'s own layout - the project's own group, resolved by the plugin at apply time.
getFrameworkDenylistPackages() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Framework/library package patterns the domain model, domain services, and ports must never depend on.
getFrameworkDenylistPackages() - Method in class com.arc_e_tect.gradle.architecture.HexagonalArchitectureExtension: Framework/library package patterns the domain model, domain services, and ports must never depend on (directly or transitively), enforced by core_application_layer_must_have_no_denylisted_dependencies.
getGenerateDsl() - Method in class com.arc_e_tect.gradle.architecture.UpdateArchitectureValidatorDslTask: When the architectureValidator block is entirely absent, synthesize a full new one from the schema and append it to the end of the build file; when false (the default), a missing block is left alone.
getHexagonalArchitecture() - Method in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorExtension: Package-pattern overrides for the built-in hexagonal rule pack.
getIgnoreFailures() - Method in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorExtension: Whether violations are reported but never fail the build, overriding ArchitectureValidatorExtension.getFailOnViolation()/ArchitectureValidatorExtension.getMaxAllowedViolations().
getInboundAdapterDenylistPackages() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Additional package patterns inbound adapters must never depend on.
getInboundAdapterDenylistPackages() - Method in class com.arc_e_tect.gradle.architecture.HexagonalArchitectureExtension: Additional package patterns inbound adapters must never depend on.
getInboundAdapters() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Inbound adapter package patterns.
getInboundAdapters() - Method in class com.arc_e_tect.gradle.architecture.HexagonalArchitectureExtension: Inbound adapter package patterns.
getInPorts() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Inbound port package patterns.
getInPorts() - Method in class com.arc_e_tect.gradle.architecture.HexagonalArchitectureExtension: Inbound port package patterns.
getJunitVersion() - Method in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorExtension: JUnit version used for the testArchitecture suite.
getMainSourceDirectory() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: The project's main Java source directory, used to infer a base package from its own directory layout when GenerateArchitectureTestsTask.getBasePackage() is blank.
getMaxAllowedViolations() - Method in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorExtension: Violation count tolerated before failing, when ArchitectureValidatorExtension.getFailOnViolation() is true.
getNamingConventionsEnabled() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Whether bidirectional naming-convention rules are generated in addition to the layer-boundary rules.
getNamingConventionsEnabled() - Method in class com.arc_e_tect.gradle.architecture.HexagonalArchitectureExtension: Whether naming-convention rules (bidirectional suffix/package checks, e.g.
getOutboundAdapters() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Outbound adapter package patterns.
getOutboundAdapters() - Method in class com.arc_e_tect.gradle.architecture.HexagonalArchitectureExtension: Outbound adapter package patterns.
getOutPorts() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Outbound port package patterns.
getOutPorts() - Method in class com.arc_e_tect.gradle.architecture.HexagonalArchitectureExtension: Outbound port package patterns.
getOutputDirectory() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Directory generated test sources are written to.
getPortDataTypePackages() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Package patterns nested inside a port package that hold pure data-transfer types.
getPortDataTypePackages() - Method in class com.arc_e_tect.gradle.architecture.HexagonalArchitectureExtension: Package patterns nested inside a port package that hold pure data-transfer types (commands, queries, results) rather than the port interfaces themselves - excluded from the "ports must be interfaces" and port-naming-convention rules, which apply only to the port contracts.
getRulePackClasspath() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Classpath scanned for external rule pack tests to bridge into a generated JUnit Platform suite.
getRulesDisabled() - Method in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorExtension: Rule names to skip, whether from the built-in hexagonal rule pack, an external rule pack, or a hand-written test.
getTestDirectory() - Method in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorExtension: Directory holding hand-written architecture tests, compiled into the testArchitecture suite alongside the generated ones.
getUseBuiltInHexagonalRulePack() - Method in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorExtension: Whether the built-in hexagonal rule pack is generated, in addition to any external rule packs and hand-written tests.
getUseBuiltInHexagonalRulePack() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Whether the built-in hexagonal architecture test is generated at all.
getUserTestsDirectory() - Method in class com.arc_e_tect.gradle.architecture.GenerateArchitectureTestsTask: Directory holding hand-written architecture tests, scanned only to detect duplicate rules against the generated ones - not itself compiled by this task.

H

hexagonalArchitecture(Action<? super HexagonalArchitectureExtension>) - Method in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorExtension: Configures ArchitectureValidatorExtension.getHexagonalArchitecture().
HexagonalArchitectureExtension - Class in com.arc_e_tect.gradle.architecture: Nested hexagonalArchitecture {} configuration block for the built-in hexagonal rule pack, exposed via ArchitectureValidatorExtension.getHexagonalArchitecture().
HexagonalArchitectureExtension(ObjectFactory) - Constructor for class com.arc_e_tect.gradle.architecture.HexagonalArchitectureExtension: Creates the extension, with every property already set to its default.

N

NAME - Static variable in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorExtension: Extension DSL block name, i.e.

S

setJunitVersion(String) - Method in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorExtension: Convenience setter for ArchitectureValidatorExtension.getJunitVersion(), for a build script pulling the version from a version catalog (e.g.

T

TEST_ARCHITECTURE_TASK_NAME - Static variable in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorPlugin: Name of the JVM test suite registered by this plugin.

U

UPDATE_DSL_TASK_NAME - Static variable in class com.arc_e_tect.gradle.architecture.ArchitectureValidatorPlugin: Name of the DSL-updating task registered by this plugin.
UpdateArchitectureValidatorDslTask - Class in com.arc_e_tect.gradle.architecture: Adds any architectureValidator DSL properties missing from this project's build file, set to their default values - see com.arc_e_tect.gradle.dslupdater.DslUpdater and ArchitectureValidatorDslSchema.
UpdateArchitectureValidatorDslTask() - Constructor for class com.arc_e_tect.gradle.architecture.UpdateArchitectureValidatorDslTask: Creates a new task instance.
updateDsl() - Method in class com.arc_e_tect.gradle.architecture.UpdateArchitectureValidatorDslTask: Reads the build file, adds any missing DSL properties, and writes it back if anything changed - after first copying the original, untouched file alongside it as build.gradle.bak, so there's always a plain-file fallback even for a project not using version control (or one that just hasn't committed the file yet).

A C G H N S T U
All Classes and Interfaces|All Packages|Constant Field Values