All Classes

Class	Description
AbstractClassesTransformer<T>	Default base implementation of ClassesTransformer, where only AbstractClassesTransformer.doTransform(JavaClasses) has to be implemented, while description and filtering via AbstractClassesTransformer.that(DescribedPredicate) are provided.
AccessTarget	Represents the target of a JavaAccess.
AccessTarget.CodeUnitCallTarget	Represents an AccessTarget where the target is a code unit.
AccessTarget.CodeUnitCallTarget.Functions
AccessTarget.ConstructorCallTarget
AccessTarget.ConstructorCallTarget.Functions
AccessTarget.FieldAccessTarget	Represents an AccessTarget where the target is a field.
AccessTarget.FieldAccessTarget.Functions
AccessTarget.Functions
AccessTarget.MethodCallTarget	Represents an CodeUnitCallTarget where the target is a method.
AccessTarget.MethodCallTarget.Functions
AccessTarget.Predicates
AllDependenciesCondition
AnyDependencyCondition
ArchCondition<T>
ArchConditions
ArchConfiguration	Allows access to configured properties in "archunit.properties".
Architectures	Offers convenience to assert typical architectures, like a Architectures.layeredArchitecture().
Architectures.LayeredArchitecture
Architectures.OnionArchitecture
ArchPredicates
ArchRule	Represents a rule about a specified set of objects of interest (e.g.
ArchRule.Assertions
ArchRule.Factory
ArchRule.Transformation
ArchRule.Transformation.As
ArchRule.Transformation.Because
ArchRuleDefinition
ArchRuleDefinition.Creator
ArchUnitException
ArchUnitException.ClassResolverConfigurationException
ArchUnitException.InconsistentClassPathException
ArchUnitException.InvalidSyntaxUsageException
ArchUnitException.LocationException
ArchUnitException.ReflectionException
ArchUnitException.UnsupportedUriSchemeException
ArchUnitExtension	ArchUnit extensions need to implement this interface.
ArchUnitExtensions
CanBeAnnotated
CanBeAnnotated.Predicates
CanBeAnnotated.Utils
CanBeEvaluated
CanOverrideDescription<SELF>
ChainableFunction<F,T>
ClassesIdentityTransformer	Deprecated. There is no use for this as part of the ArchUnit API, since users should always use ArchRuleDefinition.classes()
ClassesShould
ClassesShouldConjunction
ClassesThat<CONJUNCTION>
ClassesTransformer<T>
ClassFileImporter	The central API to import JavaClasses from compiled Java class files.
ClassLoaders
ClassResolver	The ClassFileImporter will use the configured ClassResolver, to determine how to resolve further dependencies. For example, if you import the package com.foo.bar, and some class com.foo.bar.FooBar calls a method of com.other.Dependency, the ClassResolver will decide how this dependency should be treated, i.e.
ClassResolver.ClassUriImporter	Provides a way to import a JavaClass from a given URI.
ClassResolver.Factory
ClassResolverFromClasspath	A ClassResolver that tries to locate missing dependencies on the classpath.
CodeUnitsShould<CONJUNCTION extends CodeUnitsShouldConjunction<?>>
CodeUnitsShouldConjunction<CODE_UNIT extends JavaCodeUnit>
CodeUnitsThat<CONJUNCTION extends GivenCodeUnitsConjunction<?>>
CollectsLines	Deprecated. The API induced by this interface feels clumsy in most places and at best "not harmful".
CompositeArchRule
CompositeArchRule.Creator
ConditionEvent
ConditionEvent.Handler	Handles the data of a ConditionEvent that is the corresponding objects and the description (compare ConditionEvent.handleWith(Handler)). As an example, this could be a single element of type JavaMethodCall together with a description, like
ConditionEvents
Dependency	Represents a dependency of one Java class on another Java class.
Dependency.Functions
Dependency.Predicates
DescribedIterable<T>
DescribedIterable.From
DescribedPredicate<T>	A predicate holding a description.
DomainBuilders
DomainBuilders.CodeUnitCallTargetBuilder<SELF extends DomainBuilders.CodeUnitCallTargetBuilder<SELF>>
DomainBuilders.ConstructorCallTargetBuilder
DomainBuilders.FieldAccessTargetBuilder
DomainBuilders.JavaAccessBuilder<TARGET extends AccessTarget,SELF extends DomainBuilders.JavaAccessBuilder<TARGET,SELF>>
DomainBuilders.JavaAnnotationBuilder
DomainBuilders.JavaClassBuilder
DomainBuilders.JavaCodeUnitBuilder<OUTPUT,SELF extends DomainBuilders.JavaCodeUnitBuilder<OUTPUT,SELF>>
DomainBuilders.JavaConstructorBuilder
DomainBuilders.JavaConstructorCallBuilder
DomainBuilders.JavaEnumConstantBuilder
DomainBuilders.JavaFieldAccessBuilder
DomainBuilders.JavaFieldBuilder
DomainBuilders.JavaMemberBuilder<OUTPUT,SELF extends DomainBuilders.JavaMemberBuilder<OUTPUT,SELF>>
DomainBuilders.JavaMethodBuilder
DomainBuilders.JavaMethodCallBuilder
DomainBuilders.JavaStaticInitializerBuilder
DomainBuilders.MethodCallTargetBuilder
DomainObjectCreationContext	Together with DomainBuilders, this class is the link to create domain objects from the import context.
EvaluatedRule	Bundles an ArchRule together with the JavaClasses that were evaluated, and the respective EvaluationResult.
EvaluationResult	Represents the result of evaluating an ArchRule against some JavaClasses.
FailureReport
FieldsShould<CONJUNCTION extends FieldsShouldConjunction>
FieldsShouldConjunction
FieldsThat<CONJUNCTION extends GivenFieldsConjunction>
Formatters
ForwardingCollection<T>
ForwardingList<T>
ForwardingSet<T>
FreezingArchRule	A decorator around an existing ArchRule that "freezes" the state of all violations on the first call instead of failing the test.
Function<F,T>
Function.Functions
GeneralCodingRules	When checking these rules, it is always important to remember that all necessary classes need to be imported.
GivenClass
GivenClasses
GivenClassesConjunction
GivenCodeUnits<CODE_UNIT extends JavaCodeUnit>
GivenCodeUnitsConjunction<CODE_UNIT extends JavaCodeUnit>
GivenConjunction<OBJECTS>
GivenConstructors
GivenConstructorsConjunction
GivenFields
GivenFieldsConjunction
GivenMembers<MEMBER extends JavaMember>
GivenMembersConjunction<MEMBER extends JavaMember>
GivenMethods
GivenMethodsConjunction
GivenNamedSlices
GivenObjects<T>
GivenSlices
GivenSlicesConjunction
Guava	NOTE: We keep Google Guava out of the public API and use the Gradle Shadow plugin to repackage the internally used Guava classes.
Guava.Iterables
Guava.Maps
HasAnnotations
HasDescription
HasDescriptor
HasModifiers
HasModifiers.Predicates
HasName
HasName.AndFullName
HasName.AndFullName.Functions
HasName.AndFullName.Predicates
HasName.Functions
HasName.Predicates
HasOwner<T>
HasOwner.Functions
HasOwner.Functions.Get
HasOwner.Predicates
HasOwner.Predicates.With
HasParameterTypes
HasParameterTypes.Predicates
HasReturnType
HasReturnType.Functions
HasReturnType.Predicates
HasSourceCodeLocation
HasThrowsClause<LOCATION extends HasParameterTypes & HasReturnType & HasName.AndFullName & CanBeAnnotated & HasOwner<JavaClass>>
HasThrowsClause.Predicates
HasType
HasType.Functions
HasType.Predicates
ImportContext
ImportOption	Will be evaluated for every class location, to determine if the class should be imported. IMPORTANT: For things like caching to work, it's important that the behavior of any implementation is constant, i.e.
ImportOption.DoNotIncludeArchives
ImportOption.DoNotIncludeJars
ImportOption.DoNotIncludeTests	NOTE: This excludes all class files residing in some directory ../target/test-classes/.., ../build/classes/test/..
ImportOption.DontIncludeArchives	Deprecated. Decided to consistently never use contractions -> use ImportOption.DoNotIncludeArchives
ImportOption.DontIncludeJars	Deprecated. Decided to consistently never use contractions -> use ImportOption.DoNotIncludeJars
ImportOption.DontIncludeTests	Deprecated. Decided to consistently never use contractions -> use ImportOption.DoNotIncludeTests
ImportOption.Predefined
ImportOptions	A collection of ImportOption to filter class locations.
InitialConfiguration<T>
Internal	Any element annotated with this annotation, is meant for internal use ONLY.
JavaAccess<TARGET extends AccessTarget>
JavaAccess.Functions
JavaAccess.Functions.Get
JavaAccess.Predicates
JavaAnnotation	Represents an imported annotation on an annotated object like a class or a method.
JavaCall<T extends AccessTarget.CodeUnitCallTarget>
JavaCall.Predicates
JavaClass
JavaClass.Functions
JavaClass.Predicates
JavaClasses
JavaClassList
JavaCodeUnit	Represents a unit of code containing accesses to other units of code.
JavaCodeUnit.Functions
JavaCodeUnit.Functions.Get
JavaCodeUnit.Predicates
JavaConstructor
JavaConstructorCall
JavaEnumConstant
JavaField
JavaFieldAccess
JavaFieldAccess.AccessType
JavaFieldAccess.Predicates
JavaMember
JavaMember.Predicates
JavaMethod
JavaMethodCall
JavaModifier
JavaPackage
JavaPackage.ClassVisitor
JavaPackage.Functions
JavaPackage.PackageVisitor
JavaStaticInitializer
JavaType
JavaType.From
Location	Handles various forms of location from where classes can be imported in a consistent way.
Locations	Represents a set of locations of Java class files.
MayResolveTypesViaReflection	Marks the methods or classes, where resolving types via reflection is allowed.
MembersShould<CONJUNCTION extends MembersShouldConjunction<?>>
MembersShouldConjunction<MEMBER extends JavaMember>
MembersThat<CONJUNCTION extends GivenMembersConjunction<?>>
MethodsShould<CONJUNCTION extends MethodsShouldConjunction>
MethodsShouldConjunction
MethodsThat<CONJUNCTION extends GivenMethodsConjunction>
OnlyBeAccessedSpecification<CONJUNCTION>
Optional<T>
PackageMatcher	Matches packages with a syntax similar to AspectJ.
PackageMatcher.Result
PackageMatchers
PlantUmlArchCondition	Allows to evaluate PlantUML Component Diagrams as ArchUnit rules.
PlantUmlArchCondition.Configurations
PluginLoader<T>
PluginLoader.Creator<T>
PluginLoader.JavaVersion
Predicate<T>
Predicate.Defaults
PredicateAggregator<T>
Priority
PublicAPI	Marks classes and members that are part of ArchUnit's public API.
PublicAPI.State
PublicAPI.Usage
ReflectionUtils
ResolvesTypesViaReflection	Marks the methods or classes that resolve types via reflection so we can use it for architecture assertions.
SelectedClassResolverFromClasspath	Only resolves classes from classpath that are beneath the configured SelectedClassResolverFromClasspath.packageRoots.
SimpleConditionEvent
Slice	A collection of JavaClasses modelling some domain aspect of a code basis.
SliceAssignment	A mapping JavaClass -> SliceIdentifier which defines how to partition a set of JavaClasses into Slices.
SliceDependency
SliceIdentifier	A unique identifier of a Slice.
SliceRule
Slices	Basic collection of Slice for tests of dependencies between different domain packages, e.g.
Slices.Transformer	Specifies how to transform a set of JavaClass into a set of Slice, e.g.
SlicesRuleDefinition	Allows to specify ArchRules for "slices" of a code base.
SlicesRuleDefinition.Creator
SlicesShould
Source	Contains information about an imported class, i.e.
Source.Md5sum
SourceCodeLocation	Location in the source code of an ArchUnit domain object.
ThrowsClause<LOCATION extends HasParameterTypes & HasReturnType & HasName.AndFullName & CanBeAnnotated & HasOwner<JavaClass>>
ThrowsClause.Functions
ThrowsDeclaration<LOCATION extends HasParameterTypes & HasReturnType & HasName.AndFullName & CanBeAnnotated & HasOwner<JavaClass>>	Represents one declared exception of a ThrowsClause.
ThrowsDeclaration.Functions
ThrowsDeclaration.Functions.Get
ViolationHandler<T>
ViolationLineMatcher	Allows FreezingArchRule to decide when two lines of two violations count as "equivalent".
ViolationStore	Provides some sort of storage for violations to FreezingArchRule.