org.ops4j.pax.exam.spi

Class DefaultExamSystem

java.lang.Object

org.ops4j.pax.exam.spi.DefaultExamSystem

All Implemented Interfaces:

org.ops4j.pax.exam.ExamSystem

public class DefaultExamSystem
extends Object
implements org.ops4j.pax.exam.ExamSystem

DefaultExamSystem represents the default implementation of ExamSystem. It takes care of options (including implicit defaults), temporary folders (and their cleanup) and cross cutting parameters that are frequently used like "timeout" values.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears up resources taken by system (like temporary files).
static org.ops4j.pax.exam.ExamSystem	create(org.ops4j.pax.exam.Option[] options) Creates a fresh ExamSystem.
String	createID(String purposeText)
org.ops4j.pax.exam.TestProbeBuilder	createProbe()
static File	createTempDir()
boolean	equals(Object obj)
org.ops4j.pax.exam.ExamSystem	fork(org.ops4j.pax.exam.Option[] options) Create a new system based on *this*.
File	getConfigFolder()
org.ops4j.pax.exam.options.WarProbeOption	getLatestWarProbeOption()
<T extends org.ops4j.pax.exam.Option> T[]	getOptions(Class<T> optionType)
<T extends org.ops4j.pax.exam.Option> T	getSingleOption(Class<T> optionType) Helper method for single options.
<T extends org.ops4j.pax.exam.Option> T	getSingleOption(Class<T> optionType, org.ops4j.pax.exam.Option[] options)
File	getTempFolder()
org.ops4j.pax.exam.RelativeTimeout	getTimeout()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static org.ops4j.pax.exam.ExamSystem create(org.ops4j.pax.exam.Option[] options)
                                            throws IOException

Creates a fresh ExamSystem. Your options will be combined with internal defaults. If you need to change the system after it has been created, you fork() it. Forking will not add default options again.

Parameters:

options - options to be used to define the new system.

Returns:

a fresh instance of DefaultExamSystem

Throws:

IOException - in case of an instantiation problem. (IO related)

fork

public org.ops4j.pax.exam.ExamSystem fork(org.ops4j.pax.exam.Option[] options)

Create a new system based on *this*. The forked System remembers the forked instances in order to clear resources up (if desired).

Specified by:

fork in interface org.ops4j.pax.exam.ExamSystem

getSingleOption

public <T extends org.ops4j.pax.exam.Option> T getSingleOption(Class<T> optionType)

Helper method for single options. Last occurence has precedence. (support overwrite).

Specified by:

getSingleOption in interface org.ops4j.pax.exam.ExamSystem

getSingleOption

public <T extends org.ops4j.pax.exam.Option> T getSingleOption(Class<T> optionType,
                                                               org.ops4j.pax.exam.Option[] options)

getOptions

public <T extends org.ops4j.pax.exam.Option> T[] getOptions(Class<T> optionType)

Specified by:

getOptions in interface org.ops4j.pax.exam.ExamSystem

getConfigFolder

public File getConfigFolder()

Specified by:

getConfigFolder in interface org.ops4j.pax.exam.ExamSystem

Returns:

the basic directory that Exam should use to look at user-defaults.

getTempFolder

public File getTempFolder()

Specified by:

getTempFolder in interface org.ops4j.pax.exam.ExamSystem

Returns:

the basic directory that Exam should use for all IO write activities.

getTimeout

public org.ops4j.pax.exam.RelativeTimeout getTimeout()

Specified by:

getTimeout in interface org.ops4j.pax.exam.ExamSystem

Returns:

a relative indication of how to deal with timeouts.

clear

public void clear()

Clears up resources taken by system (like temporary files).

Specified by:

clear in interface org.ops4j.pax.exam.ExamSystem

createProbe

public org.ops4j.pax.exam.TestProbeBuilder createProbe()
                                                throws IOException

Specified by:

createProbe in interface org.ops4j.pax.exam.ExamSystem

Throws:

IOException

createID

public String createID(String purposeText)

Specified by:

createID in interface org.ops4j.pax.exam.ExamSystem

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

createTempDir

public static File createTempDir()

getLatestWarProbeOption

public org.ops4j.pax.exam.options.WarProbeOption getLatestWarProbeOption()