クラス JavaPackage

方法の詳細

• of

  public static JavaPackage of(Classes classes, StringSE name)

  指定されたクラスと名前に対して新しい JavaPackage を作成します。

  パラメーター:

  classes - null であってはなりません。

  name - null または空であってはなりません。

  戻り値:

• isPackageInfoType

  public static boolean isPackageInfoType(com.tngtech.archunit.core.domain.JavaClass type)

  指定された型が package-info.java 型かどうかを返します。

  パラメーター:

  type - null であってはなりません。

• getName

  public StringSE getName()

  パッケージの名前を返します。

  戻り値:

  null になることはありません。

• getTrailingName

  public StringSE getTrailingName(JavaPackage pkg)

  現在の JavaPackage に関して、指定された JavaPackage の名前を返します。

  パラメーター:

  pkg - null であってはなりません。

  戻り値:

  null になることはありません。

  導入:

  1.3

• toSingle

  public JavaPackage toSingle()

  JavaPackage を基本パッケージのみに縮小します。

  戻り値:

  null になることはありません。

• getLocalName

  public StringSE getLocalName()

  パッケージのローカル名、つまり修飾されたパッケージ名の最後のセグメントを返します。

  戻り値:

  null になることはありません。

• getDirectSubPackages

  public CollectionSE<JavaPackage> getDirectSubPackages()

  現在のサブパッケージのすべての直接サブパッケージを返します。

  戻り値:

  null になることはありません。

• getClasses

  public Classes getClasses()

  現在のパッケージに存在するすべてのクラスを返します。現在のパッケージが含めるように作成されている場合は、サブパッケージに存在する可能性もあります。

  戻り値:

  null になることはありません。

• getExposedClasses

  public Classes getExposedClasses()

  このパッケージによって公開されるクラス、つまりパブリックなもののみを返します。package-info 型もフィルタリングします。

  戻り値:

  null になることはありません。

• getSubPackagesAnnotatedWith

  public StreamSE<JavaPackage> getSubPackagesAnnotatedWith(ClassSE<? extends AnnotationSE> annotation)

  指定されたアノテーション型を持つすべてのサブパッケージを返します。

  パラメーター:

  annotation - null であってはなりません。

  戻り値:

  null になることはありません。

• getSubPackagesMatching

  public StreamSE<JavaPackage> getSubPackagesMatching(BiPredicateSE<JavaPackage,StringSE> filter)

  候補パッケージの指定された BiPredicateSE と、現在のパッケージを基準としたその末尾の名前に一致するすべてのサブパッケージを返します。

  パラメーター:

  filter - null であってはなりません。

  戻り値:

  null になることはありません。

  導入:

  1.4

  関連事項:

  • getTrailingName(JavaPackage)

• that

  public Classes that(com.tngtech.archunit.base.DescribedPredicate<? super com.tngtech.archunit.core.domain.JavaClass> predicate)

  指定された DescribedPredicate に一致するすべての Classes を返します。

  パラメーター:

  predicate - null であってはなりません。

  戻り値:

  null になることはありません。

• contains

  public boolean contains(ClassSE<?> type)

  JavaPackage に指定された型が含まれているかどうかを返します。

  パラメーター:

  type - null であってはなりません。

  導入:

  1.4.6, 2.0.1

• contains

  public boolean contains(com.tngtech.archunit.core.domain.JavaClass type)

  JavaPackage に指定された型が含まれているかどうかを返します。

  パラメーター:

  type - null であってはなりません。

• contains

  public boolean contains(StringSE typeName)

  JavaPackage に指定された名前の型が含まれているかどうかを返します。

  パラメーター:

  typeName - null または空であってはなりません。

• couldContain

  public boolean couldContain(ClassSE<?> type)

  現在のインスタンスの実際の型とは独立して、パッケージが型を含むことができるかどうかを返します。この不一致は通常、製品コードとテストコードの違いによって発生します。前者からセットアップされた JavaPackage は、同じパッケージ内にテスト型を含みません。これに対し、このメソッドは、テスト型が論理的にパッケージに属していることを認識します。

  パラメーター:

  type - null であってはなりません。

  導入:

  1.4.6, 2.0.1

• couldContain

  public boolean couldContain(StringSE type)

  現在のインスタンスの実際の型とは独立して、パッケージが型を含むことができるかどうかを返します。この不一致は通常、製品コードとテストコードの違いによって発生します。前者からセットアップされた JavaPackage は、同じパッケージ内にテスト型を含みません。これに対し、このメソッドは、テスト型が論理的にパッケージに属していることを認識します。

  パラメーター:

  type - null であってはなりません。

  導入:

  1.4.6, 2.0.1

• stream

  public StreamSE<com.tngtech.archunit.core.domain.JavaClass> stream()

  JavaPackage に含まれるすべての JavaClass の StreamSE を返します。

  戻り値:

  null になることはありません。

• getAnnotation

  public <A extends AnnotationSE> OptionalSE<A> getAnnotation(ClassSE<A> annotationType)

  パッケージで宣言された指定された型のアノテーションを返します。

  型パラメーター:

  A - アノテーション型。

  パラメーター:

  annotationType - 検索するアノテーションの型。

  戻り値:

  null になることはありません。

• getPackageName

  public PackageName getPackageName()

  パッケージの名前を返します。

  戻り値:

  null になることはありません。

  導入:

  1.4、1.3 以降パッケージは保護されています

• asFilter

  StringSE asFilter()

  そのパッケージ内のすべての型とネストされたパッケージを含むフィルター式を返します。

  戻り値:

  null になることはありません。

  導入:

  1.3

• andSubPackagesAnnotatedWith

  StreamSE<JavaPackage> andSubPackagesAnnotatedWith(ClassSE<? extends AnnotationSE> type)

  指定されたアノテーション型でアノテーションが付けられた現在のパッケージとそのすべてのサブパッケージの新しい StreamSE を返します。

  パラメーター:

  type - null であってはなりません。

  戻り値:

  null になることはありません。

  導入:

  1.3

• isSubPackageOf

  boolean isSubPackageOf(JavaPackage reference)

  現在の JavaPackage が指定された参照パッケージのサブパッケージであるかどうかを返します。

  パラメーター:

  reference - null であってはなりません。

  導入:

  1.3

• isParentPackageOf

  boolean isParentPackageOf(JavaPackage reference)

  現在の JavaPackage が指定された参照パッケージの親パッケージであるかどうかを返します。

  パラメーター:

  reference - null であってはなりません。

  導入:

  1.4.2

• getClassesExcept

  Classes getClassesExcept(IterableSE<JavaPackage> exclusions)

  現在のパッケージに存在するが、指定されたサブパッケージのいずれにも存在しないすべてのクラスを返します。

  パラメーター:

  exclusions - null であってはなりません。

  戻り値:

  null になることはありません。

  導入:

  1.3

• getSubPackages

  JavaPackages getSubPackages()

  すべてのサブパッケージを表す JavaPackages インスタンスを返します。

  戻り値:

  null になることはありません。

  導入:

  1.3

• getSubPackage

  OptionalSE<JavaPackage> getSubPackage(StringSE localName)

  指定されたローカル名を持つサブパッケージを返します。

  パラメーター:

  localName - null または空であってはなりません。

  戻り値:

  null になることはありません。

  導入:

  1.3

• findAnnotation

  public <A extends AnnotationSE> OptionalSE<A> findAnnotation(ClassSE<A> annotationType)

  パッケージ自体に宣言された特定の型、または直接パッケージの型に配置されている任意の型のアノテーションを検索します。

  型パラメーター:

  A - アノテーションの型。

  パラメーター:

  annotationType - null であってはなりません。

  戻り値:

  null になることはありません。

  例外:

  IllegalStateExceptionSE - 現在のパッケージ内の複数の型に、指定されたアノテーションが付けられている場合。

  導入:

  1.2

• isDirectParentOf

  boolean isDirectParentOf(JavaPackage reference)

  現在の JavaPackage が指定された JavaPackage の直接の親であるかどうかを返します。

  パラメーター:

  reference - null であってはなりません。

  導入:

  1.4

• getDescription

  public StringSE getDescription()

  次で指定:

  インターフェース com.tngtech.archunit.base.HasDescription 内の getDescription 

• iterator

  public IteratorSE<com.tngtech.archunit.core.domain.JavaClass> iterator()

  次で指定:

  インターフェース IterableSE<com.tngtech.archunit.core.domain.JavaClass> 内の iterator 

• compareTo

  public int compareTo(JavaPackage o)

  次で指定:

  インターフェース ComparableSE<JavaPackage> 内の compareToSE 

• toString

  public StringSE toString()

  オーバーライド:

  クラス ObjectSE の toString 

• equals

  public boolean equals(ObjectSE obj)

  オーバーライド:

  クラス ObjectSE の equalsSE 

• hashCode

  public int hashCode()

  オーバーライド:

  クラス ObjectSE の hashCode 

• reverse

  static ComparatorSE<JavaPackage> reverse()

• onlySubPackagesExcept

  JavaPackages onlySubPackagesExcept(CollectionSE<JavaPackage> packages)

  指定されたものを除く、現在のパッケージのすべてのサブパッケージを返します。

  パラメーター:

  packages - null になることはありません。

  戻り値:

  null になることはありません。

• without

  JavaPackage without(JavaPackages exclusions)

  新しい JavaPac を返します

  パラメーター:

  exclusions - すべての JavaPackages を除外します。

  戻り値:

  null になることはありません。