Package com.tngtech.archunit.core.domain
Class JavaPackage
java.lang.Object
com.tngtech.archunit.core.domain.JavaPackage
- All Implemented Interfaces:
HasDescription
,CanBeAnnotated
,HasAnnotations<JavaPackage>
,HasName
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
static final class
static interface
Nested classes/interfaces inherited from interface com.tngtech.archunit.core.domain.properties.CanBeAnnotated
CanBeAnnotated.Predicates, CanBeAnnotated.Utils
Nested classes/interfaces inherited from interface com.tngtech.archunit.core.domain.properties.HasName
HasName.AndFullName, HasName.Predicates, HasName.Utils
-
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
(Predicate<? super JavaClass> predicate, JavaPackage.ClassVisitor visitor) Traverses the package tree visiting each matching class.void
accept
(Predicate<? super JavaPackage> predicate, JavaPackage.PackageVisitor visitor) Traverses the package tree visiting each matching package.boolean
containsClass
(JavaClass clazz) boolean
containsClass
(Class<?> clazz) boolean
containsClassWithFullyQualifiedName
(String className) boolean
containsClassWithSimpleName
(String className) boolean
containsPackage
(String packageName) Deprecated.<A extends Annotation>
AgetAnnotationOfType
(Class<A> type) getAnnotationOfType
(String typeName) Set<? extends JavaAnnotation<JavaPackage>>
getClassWithFullyQualifiedName
(String className) getClassWithSimpleName
(String className) getName()
getPackage
(String packageName) Deprecated.UsegetSubpackages()
instead.boolean
isAnnotatedWith
(DescribedPredicate<? super JavaAnnotation<?>> predicate) boolean
isAnnotatedWith
(Class<? extends Annotation> annotationType) boolean
isAnnotatedWith
(String annotationTypeName) boolean
isMetaAnnotatedWith
(DescribedPredicate<? super JavaAnnotation<?>> predicate) boolean
isMetaAnnotatedWith
(Class<? extends Annotation> annotationType) boolean
isMetaAnnotatedWith
(String annotationTypeName) toString()
<A extends Annotation>
Optional<A>tryGetAnnotationOfType
(Class<A> type) tryGetAnnotationOfType
(String typeName) Optional<? extends HasAnnotations<?>>
-
Method Details
-
getName
-
getRelativeName
- Returns:
- the (relative) name of this package, e.g.
lang
for packagejava.lang
-
getPackageInfo
-
tryGetPackageInfo
-
getAnnotations
- Specified by:
getAnnotations
in interfaceHasAnnotations<JavaPackage>
-
getAnnotationOfType
- Specified by:
getAnnotationOfType
in interfaceHasAnnotations<JavaPackage>
-
getAnnotationOfType
- Specified by:
getAnnotationOfType
in interfaceHasAnnotations<JavaPackage>
-
tryGetAnnotationOfType
@PublicAPI(usage=ACCESS) public <A extends Annotation> Optional<A> tryGetAnnotationOfType(Class<A> type) - Specified by:
tryGetAnnotationOfType
in interfaceHasAnnotations<JavaPackage>
-
tryGetAnnotationOfType
@PublicAPI(usage=ACCESS) public Optional<JavaAnnotation<JavaPackage>> tryGetAnnotationOfType(String typeName) - Specified by:
tryGetAnnotationOfType
in interfaceHasAnnotations<JavaPackage>
-
isAnnotatedWith
- Specified by:
isAnnotatedWith
in interfaceCanBeAnnotated
-
isAnnotatedWith
- Specified by:
isAnnotatedWith
in interfaceCanBeAnnotated
-
isAnnotatedWith
@PublicAPI(usage=ACCESS) public boolean isAnnotatedWith(DescribedPredicate<? super JavaAnnotation<?>> predicate) - Specified by:
isAnnotatedWith
in interfaceCanBeAnnotated
-
isMetaAnnotatedWith
@PublicAPI(usage=ACCESS) public boolean isMetaAnnotatedWith(Class<? extends Annotation> annotationType) - Specified by:
isMetaAnnotatedWith
in interfaceCanBeAnnotated
-
isMetaAnnotatedWith
- Specified by:
isMetaAnnotatedWith
in interfaceCanBeAnnotated
-
isMetaAnnotatedWith
@PublicAPI(usage=ACCESS) public boolean isMetaAnnotatedWith(DescribedPredicate<? super JavaAnnotation<?>> predicate) - Specified by:
isMetaAnnotatedWith
in interfaceCanBeAnnotated
-
getParent
- Returns:
- the parent package, e.g.
java
for packagejava.lang
-
getClasses
- Returns:
- all classes directly contained in this package, no classes in sub-packages (compare
getAllClasses()
)
-
getAllClasses
- Returns:
- all classes contained in this package or any sub-package (compare
getClasses()
)
-
getSubpackages
- Returns:
- all (direct) sub-packages contained in this package, e.g.
[java.lang, java.io, ...]
for packagejava
(comparegetAllSubpackages()
)
-
getSubPackages
Deprecated.UsegetSubpackages()
instead. -
getAllSubpackages
- Returns:
- all sub-packages including nested sub-packages contained in this package,
e.g.
[java.lang, java.lang.annotation, java.util, java.util.concurrent, ...]
for packagejava
(comparegetSubpackages()
)
-
getAllSubPackages
Deprecated.UsegetAllSubpackages()
instead. -
containsClass
-
containsClass
-
getClass
- Parameters:
clazz
- A Java class- Returns:
- the class if contained in this package, otherwise an Exception is thrown
- See Also:
-
containsClassWithFullyQualifiedName
- Parameters:
className
- fully qualified name of a Java class- Returns:
- true if this package (directly) contains a
JavaClass
with the given fully qualified name - See Also:
-
getClassWithFullyQualifiedName
- Parameters:
className
- fully qualified name of a Java class- Returns:
- the class if contained in this package, otherwise an Exception is thrown
- See Also:
-
containsClassWithSimpleName
- Parameters:
className
- simple name of a Java class- Returns:
- true if this package (directly) contains a
JavaClass
with the given simple name - See Also:
-
getClassWithSimpleName
- Parameters:
className
- simple name of a Java class- Returns:
- the class if contained in this package, otherwise an Exception is thrown
- See Also:
-
containsPackage
- Parameters:
packageName
- name of a package, may consist of several parts, e.g.some.subpackage
- Returns:
- true if this package contains the supplied (sub-) package
- See Also:
-
getPackage
- Parameters:
packageName
- name of a package, may consist of several parts, e.g.some.subpackage
- Returns:
- the (sub-) package with the given (relative) name; throws an exception if there is no such package contained
- See Also:
-
getClassDependenciesFromSelf
- Returns:
- All
dependencies
that originate from aJavaClass
within this package to aJavaClass
outside of this package
-
getClassDependenciesToSelf
- Returns:
- All
dependencies
that originate from aJavaClass
outside of this package to aJavaClass
within this package
-
getPackageDependenciesFromSelf
-
getPackageDependenciesToSelf
-
accept
@PublicAPI(usage=ACCESS) public void accept(Predicate<? super JavaClass> predicate, JavaPackage.ClassVisitor visitor) Traverses the package tree visiting each matching class.- Parameters:
predicate
- determines which classes within the package tree should be visitedvisitor
- will receive each class in the package tree matching the given predicate- See Also:
-
accept
@PublicAPI(usage=ACCESS) public void accept(Predicate<? super JavaPackage> predicate, JavaPackage.PackageVisitor visitor) Traverses the package tree visiting each matching package.- Parameters:
predicate
- determines which packages within the package tree should be visitedvisitor
- will receive each package in the package tree matching the given predicate- See Also:
-
getDescription
- Specified by:
getDescription
in interfaceHasDescription
-
toString
-
getAllSubpackages()
instead.