|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ops4j.pax.exam.CoreOptions
public class CoreOptions
Factory methods for core options.
Method Summary | |
---|---|
static Option |
allEquinoxVersions()
Creates a composite option of all EquinoxFrameworkOption versions (up to the date of Pax Exam release). |
static Option |
allFelixVersions()
Creates a composite option of all FelixFrameworkOption versions (up to the date of Pax Exam release). |
static Option |
allFrameworks()
Creates a composite option of latest versions of Felix, Equinox and Knopflerfish. |
static Option |
allFrameworksVersions()
Creates a composite option of all versions of Felix, Equinox and Knopflerfish. |
static Option |
allKnopflerfishVersions()
Creates a composite option of all KnopflerfishFrameworkOption versions (up to the date of Pax Exam
release). |
static Option |
bootClasspathLibraries(BootClasspathLibraryOption... libraries)
Creates a composite option of BootClasspathLibraryOption s. |
static Option |
bootClasspathLibraries(java.lang.String... urls)
Creates a composite option of BootClasspathLibraryOption s. |
static BootClasspathLibraryOption |
bootClasspathLibrary(java.lang.String libraryUrl)
Creates a BootClasspathLibraryOption . |
static BootClasspathLibraryOption |
bootClasspathLibrary(UrlReference libraryUrl)
Creates a BootClasspathLibraryOption . |
static BootDelegationOption |
bootDelegationPackage(java.lang.String pkg)
Creates a BootDelegationOption . |
static Option |
bootDelegationPackages(BootDelegationOption... packages)
Creates a composite option of BootDelegationOption s. |
static Option |
bootDelegationPackages(java.lang.String... packages)
Creates a composite option of BootDelegationOption s. |
static UrlProvisionOption |
bundle(java.lang.String url)
Creates a UrlProvisionOption . |
static BundleStartLevelOption |
bundleStartLevel(int startLevel)
Creates an BundleStartLevelOption . |
static Option |
composite(Option... options)
Convenience method (more to be used for a nice fluent api) for creating a composite option. |
static CustomFrameworkOption |
customFramework(java.lang.String baseFrameworkName,
java.lang.String definitionURL,
java.lang.String name)
|
static DebugClassLoadingOption |
debugClassLoading()
Creates a DebugClassLoadingOption . |
static TestContainerStartTimeoutOption |
doNotWaitForFrameworkStartup()
Creates a TestContainerStartTimeoutOption that will not wait for framework startup. |
static EquinoxFrameworkOption |
equinox()
Creates a EquinoxFrameworkOption . |
static FelixFrameworkOption |
felix()
Creates a FelixFrameworkOption . |
static Option |
frameworks(FrameworkOption... frameworks)
Creates a composite option of FrameworkOption s. |
static FrameworkStartLevelOption |
frameworkStartLevel(int startLevel)
Creates an FrameworkStartLevelOption . |
static KnopflerfishFrameworkOption |
knopflerfish()
Creates a KnopflerfishFrameworkOption . |
static MavenArtifactUrlReference |
maven()
Creates a MavenArtifactUrlReference . |
static MavenArtifactUrlReference |
maven(java.lang.String groupId,
java.lang.String artifactId)
Convenience method (shorter) for referencing an maven artifact based on groupId/artifactId. |
static MavenArtifactUrlReference |
maven(java.lang.String groupId,
java.lang.String artifactId,
java.lang.String version)
Convenience method (shorter) for referencing a maven artifact based on groupId/artifactId/version. |
static MavenArtifactProvisionOption |
mavenBundle()
Creates a MavenArtifactProvisionOption . |
static MavenArtifactProvisionOption |
mavenBundle(MavenArtifactUrlReference artifact)
Convenience factory method for adding a maven bundle based on a meven artifact. |
static MavenArtifactProvisionOption |
mavenBundle(java.lang.String groupId,
java.lang.String artifactId)
Convenience method (shorter) for adding a maven bundle based on groupId/artifactId. |
static MavenArtifactProvisionOption |
mavenBundle(java.lang.String groupId,
java.lang.String artifactId,
java.lang.String version)
Convenience method (shorter) for adding a maven bundle based on groupId/artifactId/version. |
static MavenPluginGeneratedConfigOption |
mavenConfiguration()
Creates a MavenPluginGeneratedConfigOption . |
static MavenPluginGeneratedConfigOption |
mavenConfiguration(java.lang.String url)
Creates a MavenPluginGeneratedConfigOption . |
static MavenPluginGeneratedConfigOption |
mavenConfiguration(java.net.URL url)
Creates a MavenPluginGeneratedConfigOption . |
static Option[] |
options(Option... options)
Convenience method (more to be used for a nice fluent api) for creating an array of options. |
static Option |
provision(java.io.InputStream... streams)
Creates a composite option of ProvisionOption s. |
static Option |
provision(ProvisionOption... urls)
Creates a composite option of ProvisionOption s. |
static Option |
provision(java.lang.String... urls)
Creates a composite option of ProvisionOption s. |
static SystemPackageOption |
systemPackage(java.lang.String pkg)
Creates a SystemPackageOption . |
static Option |
systemPackages(java.lang.String... packages)
Creates a composite option of SystemPackageOption s. |
static Option |
systemPackages(SystemPackageOption... packages)
Creates a composite option of SystemPackageOption s. |
static Option |
systemProperties(SystemPropertyOption... systemProperties)
Creates a composite option of SystemPropertyOption s. |
static SystemPropertyOption |
systemProperty(java.lang.String key)
Creates a SystemPropertyOption . |
static RawUrlReference |
url(java.lang.String url)
Creates a RawUrlReference . |
static TestContainerStartTimeoutOption |
waitForFrameworkStartup()
Creates a TestContainerStartTimeoutOption that will wait for framework startup without timing out. |
static TestContainerStartTimeoutOption |
waitForFrameworkStartupFor(long timeoutInMillis)
Creates a TestContainerStartTimeoutOption for a number of millis. |
static OptionalCompositeOption |
when(boolean condition)
Creates a OptionalCompositeOption . |
static OptionalCompositeOption |
when(OptionalCompositeOption.Condition condition)
Creates a OptionalCompositeOption . |
static WrappedUrlProvisionOption |
wrappedBundle(java.lang.String jarToWrapUrl)
Creates a WrappedUrlProvisionOption . |
static WrappedUrlProvisionOption |
wrappedBundle(UrlReference jarToWrapUrl)
Creates a WrappedUrlProvisionOption . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static Option[] options(Option... options)
options
- options
OptionUtils.expand(Option...)
public static Option composite(Option... options)
options
- options
public static Option frameworks(FrameworkOption... frameworks)
FrameworkOption
s.
frameworks
- framework options
public static FelixFrameworkOption felix()
FelixFrameworkOption
.
public static Option allFelixVersions()
FelixFrameworkOption
versions (up to the date of Pax Exam release).
public static EquinoxFrameworkOption equinox()
EquinoxFrameworkOption
.
public static Option allEquinoxVersions()
EquinoxFrameworkOption
versions (up to the date of Pax Exam release).
public static KnopflerfishFrameworkOption knopflerfish()
KnopflerfishFrameworkOption
.
public static Option allKnopflerfishVersions()
KnopflerfishFrameworkOption
versions (up to the date of Pax Exam
release).
public static Option allFrameworks()
public static Option allFrameworksVersions()
public static CustomFrameworkOption customFramework(java.lang.String baseFrameworkName, java.lang.String definitionURL, java.lang.String name)
baseFrameworkName
- one of the frameworks supported by pax runner. Must match the framework you link to via #definitionURLdefinitionURL
- url to a custom pax runner platform xml descriptorname
- a custom name you give this combo (will show up in pax runner startup and error msg)
public static Option provision(java.lang.String... urls)
ProvisionOption
s.
urls
- provision urls (cannot be null or containing null entries)
java.lang.IllegalArgumentException
- - If urls array is null or contains null entriespublic static Option provision(java.io.InputStream... streams)
ProvisionOption
s.
This is handy when bundles are built on the fly via TinyBundles.
streams
- provision sources
java.lang.IllegalArgumentException
- - If a problem occured while flushing streamspublic static Option provision(ProvisionOption... urls)
ProvisionOption
s.
urls
- provision options
public static RawUrlReference url(java.lang.String url)
RawUrlReference
.
url
- url as a string
public static UrlProvisionOption bundle(java.lang.String url)
UrlProvisionOption
.
url
- bundle url
public static MavenArtifactUrlReference maven()
MavenArtifactUrlReference
.
public static MavenArtifactUrlReference maven(java.lang.String groupId, java.lang.String artifactId)
groupId
- artifact group idartifactId
- artifact id
public static MavenArtifactUrlReference maven(java.lang.String groupId, java.lang.String artifactId, java.lang.String version)
groupId
- artifact group idartifactId
- artifact idversion
- artifact version
public static MavenArtifactProvisionOption mavenBundle()
MavenArtifactProvisionOption
.
public static MavenArtifactProvisionOption mavenBundle(java.lang.String groupId, java.lang.String artifactId)
groupId
- artifact group idartifactId
- artifact id
public static MavenArtifactProvisionOption mavenBundle(java.lang.String groupId, java.lang.String artifactId, java.lang.String version)
groupId
- artifact group idartifactId
- artifact idversion
- artifact version
public static MavenArtifactProvisionOption mavenBundle(MavenArtifactUrlReference artifact)
artifact
- maven artifact
public static WrappedUrlProvisionOption wrappedBundle(java.lang.String jarToWrapUrl)
WrappedUrlProvisionOption
.
jarToWrapUrl
- url of jar to be wrapped
public static WrappedUrlProvisionOption wrappedBundle(UrlReference jarToWrapUrl)
WrappedUrlProvisionOption
.
jarToWrapUrl
- url of jar to be wrapped
public static Option bootDelegationPackages(java.lang.String... packages)
BootDelegationOption
s.
packages
- boot delegation packages (cannot be null or containing null entries)
java.lang.IllegalArgumentException
- - If urls array is null or contains null entriespublic static Option bootDelegationPackages(BootDelegationOption... packages)
BootDelegationOption
s.
packages
- boot delegation package options
public static BootDelegationOption bootDelegationPackage(java.lang.String pkg)
BootDelegationOption
.
pkg
- boot delegation package
public static Option bootClasspathLibraries(java.lang.String... urls)
BootClasspathLibraryOption
s.
urls
- boot classpath library urls (cannot be null or containing null entries)
java.lang.IllegalArgumentException
- - If urls array is null or contains null entriespublic static Option bootClasspathLibraries(BootClasspathLibraryOption... libraries)
BootClasspathLibraryOption
s.
libraries
- boot classpath library options
public static BootClasspathLibraryOption bootClasspathLibrary(java.lang.String libraryUrl)
BootClasspathLibraryOption
.
libraryUrl
- boot classpath library url
public static BootClasspathLibraryOption bootClasspathLibrary(UrlReference libraryUrl)
BootClasspathLibraryOption
.
libraryUrl
- boot classpath library url
public static Option systemPackages(java.lang.String... packages)
SystemPackageOption
s.
packages
- system packages (cannot be null or containing null entries)
java.lang.IllegalArgumentException
- - If urls array is null or contains null entriespublic static Option systemPackages(SystemPackageOption... packages)
SystemPackageOption
s.
packages
- system package options
public static SystemPackageOption systemPackage(java.lang.String pkg)
SystemPackageOption
.
pkg
- system package
public static Option systemProperties(SystemPropertyOption... systemProperties)
SystemPropertyOption
s.
systemProperties
- system property options
public static SystemPropertyOption systemProperty(java.lang.String key)
SystemPropertyOption
.
key
- system property key
public static DebugClassLoadingOption debugClassLoading()
DebugClassLoadingOption
.
public static MavenPluginGeneratedConfigOption mavenConfiguration()
MavenPluginGeneratedConfigOption
.
public static MavenPluginGeneratedConfigOption mavenConfiguration(java.lang.String url)
MavenPluginGeneratedConfigOption
.
url
- of configuration to be used
public static MavenPluginGeneratedConfigOption mavenConfiguration(java.net.URL url)
MavenPluginGeneratedConfigOption
.
url
- of configuration to be used
public static OptionalCompositeOption when(boolean condition)
OptionalCompositeOption
.
condition
- boolean condition to evaluate
public static OptionalCompositeOption when(OptionalCompositeOption.Condition condition)
OptionalCompositeOption
.
condition
- condition to evaluate
public static FrameworkStartLevelOption frameworkStartLevel(int startLevel)
FrameworkStartLevelOption
.
startLevel
- framework start level (must be bigger then zero)
public static BundleStartLevelOption bundleStartLevel(int startLevel)
BundleStartLevelOption
.
startLevel
- initial bundle start level (must be bigger then zero)
public static TestContainerStartTimeoutOption waitForFrameworkStartupFor(long timeoutInMillis)
TestContainerStartTimeoutOption
for a number of millis.
timeoutInMillis
- timeout in millis
public static TestContainerStartTimeoutOption doNotWaitForFrameworkStartup()
TestContainerStartTimeoutOption
that will not wait for framework startup.
public static TestContainerStartTimeoutOption waitForFrameworkStartup()
TestContainerStartTimeoutOption
that will wait for framework startup without timing out.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |