com.tngtech.archunit.lang

Class AbstractClassesTransformer<T>

java.lang.Object

com.tngtech.archunit.lang.AbstractClassesTransformer<T>

All Implemented Interfaces:

HasDescription, ClassesTransformer<T>

Direct Known Subclasses:

ClassesIdentityTransformer

public abstract class AbstractClassesTransformer<T>
extends java.lang.Object
implements ClassesTransformer<T>

Default base implementation of ClassesTransformer, where only doTransform(JavaClasses) has to be implemented, while description and filtering via that(DescribedPredicate) are provided.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractClassesTransformer(java.lang.String description)

Method Summary

Methods

Modifier and Type	Method and Description
ClassesTransformer<T>	as(java.lang.String description)
abstract java.lang.Iterable<T>	doTransform(JavaClasses collection)
java.lang.String	getDescription()
ClassesTransformer<T>	that(DescribedPredicate<? super T> predicate) Can be used to further filter the transformation result.
DescribedIterable<T>	transform(JavaClasses collection) Defines how to transform imported JavaClasses to the respective objects to test.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractClassesTransformer

protected AbstractClassesTransformer(java.lang.String description)

Method Detail

transform

public final DescribedIterable<T> transform(JavaClasses collection)

Description copied from interface: ClassesTransformer

Defines how to transform imported JavaClasses to the respective objects to test.

Specified by:

transform in interface ClassesTransformer<T>

Parameters:

collection - Imported JavaClasses

Returns:

A DescribedIterable holding the transformed objects

See Also:

Slices.Transformer

doTransform

public abstract java.lang.Iterable<T> doTransform(JavaClasses collection)

that

public final ClassesTransformer<T> that(DescribedPredicate<? super T> predicate)

Description copied from interface: ClassesTransformer

Can be used to further filter the transformation result.

Specified by:

that in interface ClassesTransformer<T>

Parameters:

predicate - Predicate to filter the collection of transformed objects

Returns:

A transformer that additionally filters the transformed result

getDescription

public final java.lang.String getDescription()

Specified by:

getDescription in interface HasDescription

as

public final ClassesTransformer<T> as(java.lang.String description)

Specified by:

as in interface ClassesTransformer<T>

Parameters:

description - A new description for this transformer

Returns:

A transformer for the same transformation with an adjusted description