org.gradle.exemplar.test.rule

Class Sample

java.lang.Object

org.gradle.exemplar.test.rule.Sample

All Implemented Interfaces:

org.junit.rules.TestRule

public class Sample
extends java.lang.Object
implements org.junit.rules.TestRule

A JUnit rule which copies a sample into the test directory before the test executes.

Looks for a UsesSample annotation on the test method to determine which sample the test requires. If not found, uses the default sample provided in the constructor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Sample.SourceSampleDirSupplier
static interface	Sample.TargetBaseDirSupplier Supplier for the base directory into which samples are copied.

Method Summary

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
static Sample	from(Sample.SourceSampleDirSupplier sourceSampleDirSupplier)
static Sample	from(java.lang.String sourceBaseDirPath)
java.io.File	getDir()
Sample	into(Sample.TargetBaseDirSupplier targetBaseDirSupplier) Copy the samples into a folder returned by the supplied Sample.TargetBaseDirSupplier.
Sample	into(org.junit.rules.TemporaryFolder temporaryFolder) Deprecated. please use intoTemporaryFolder() or intoTemporaryFolder(File)
Sample	intoTemporaryFolder() Copy the samples into a temporary folder that is attempted to be deleted afterwards.
Sample	intoTemporaryFolder(java.io.File parentFolder) Copy the samples into a temporary folder that is attempted to be deleted afterwards.
Sample	withDefaultSample(java.lang.String name)

Methods inherited from class java.lang.Object

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

Method Detail

from

public static Sample from(java.lang.String sourceBaseDirPath)

from

public static Sample from(Sample.SourceSampleDirSupplier sourceSampleDirSupplier)

into

@Deprecated
public Sample into(org.junit.rules.TemporaryFolder temporaryFolder)

Deprecated. please use intoTemporaryFolder() or intoTemporaryFolder(File)

Copy the samples into the supplied TemporaryFolder.

intoTemporaryFolder

public Sample intoTemporaryFolder()

Copy the samples into a temporary folder that is attempted to be deleted afterwards.

intoTemporaryFolder

public Sample intoTemporaryFolder(java.io.File parentFolder)

Copy the samples into a temporary folder that is attempted to be deleted afterwards.

Parameters:

parentFolder - The parent folder of the created temporary folder

into

public Sample into(Sample.TargetBaseDirSupplier targetBaseDirSupplier)

Copy the samples into a folder returned by the supplied Sample.TargetBaseDirSupplier.

See Also:

Sample.TargetBaseDirSupplier

withDefaultSample

public Sample withDefaultSample(java.lang.String name)

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)

Specified by:

apply in interface org.junit.rules.TestRule

getDir

public java.io.File getDir()