com.github.mjeanroy.junit.servers.servers

Class AbstractConfigurationBuilder<T extends AbstractConfigurationBuilder<T,U>,U extends AbstractConfiguration>

java.lang.Object

com.github.mjeanroy.junit.servers.servers.AbstractConfigurationBuilder<T,U>

Type Parameters:

T - Type of extended builder.

U - Type of AbstractConfiguration implementation.

public abstract class AbstractConfigurationBuilder<T extends AbstractConfigurationBuilder<T,U>,U extends AbstractConfiguration>
extends Object

Builder for AbstractConfiguration instances, should be extended by custom configuration implementation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConfigurationBuilder() Build default configuration.

Method Summary

Modifier and Type	Method and Description
abstract U	build() Build the final configuration instance.
String	getClasspath() Get current classpath.
Map<String,String>	getEnvProperties() Get current envProperties.
List<Hook>	getHooks() Get current hooks.
String	getOverrideDescriptor() Get current overrideDescriptor.
ClassLoader	getParentClassLoader() Get current parentClassLoader.
String	getPath() Get current path.
int	getPort() Get current port.
String	getWebapp() Get current webapp.
protected abstract T	self() The this object, useful to get correct chaining.
T	withClasspath(String classpath) Change classpath value.
T	withHook(Hook hook) Add new executable hook to the hooks list.
T	withOverrideDescriptor(String overrideDescriptor) Change overrideDescriptor (path of the custom web.xml file descriptor=.
T	withParentClassLoader(Class<?> cls) Change parentClassLoader value.
T	withParentClasspath(Collection<URL> classpath) Change parentClassLoader value.
T	withParentClasspath(URL classpath, URL... others) Change parentClassLoader value.
T	withPath(String path) Change path value.
T	withPort(int port) Change port value.
T	withProperty(String name, String value) Add new property entry to the envProperties map.
T	withWebapp(File webapp) Change webapp value.
T	withWebapp(String webapp) Change webapp value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractConfigurationBuilder

protected AbstractConfigurationBuilder()

Build default configuration.

Method Detail

self

protected abstract T self()

The this object, useful to get correct chaining.

Returns:

this.

build

public abstract U build()

Build the final configuration instance.

Returns:

The configuration instance.

getPath

public String getPath()

Get current path.

Returns:

path.

getWebapp

public String getWebapp()

Get current webapp.

Returns:

webapp.

getClasspath

public String getClasspath()

Get current classpath.

Returns:

classpath.

getPort

public int getPort()

Get current port.

Returns:

port.

getEnvProperties

public Map<String,String> getEnvProperties()

Get current envProperties.

Returns:

envProperties.

getHooks

public List<Hook> getHooks()

Get current hooks.

Returns:

hooks.

getParentClassLoader

public ClassLoader getParentClassLoader()

Get current parentClassLoader.

Returns:

parentClassLoader.

getOverrideDescriptor

public String getOverrideDescriptor()

Get current overrideDescriptor.

Returns:

overrideDescriptor.

withPath

public T withPath(String path)

Change path value.

Parameters:

path - New path value.

Returns:

this

Throws:

NullPointerException - If path is null.

withWebapp

public T withWebapp(String webapp)

Change webapp value.

Parameters:

webapp - New webapp value.

Returns:

this

Throws:

NullPointerException - If webapp is null.

withWebapp

public T withWebapp(File webapp)

Change webapp value.

Parameters:

webapp - New webapp value (the absolute path will be used).

Returns:

this

Throws:

NullPointerException - If webapp is null.

withPort

public T withPort(int port)

Change port value.

Parameters:

port - New port value.

Returns:

this

Throws:

IllegalArgumentException - If port is strictly lower than zero.

withClasspath

public T withClasspath(String classpath)

Change classpath value.

Parameters:

classpath - New classpath value.

Returns:

this

withProperty

public T withProperty(String name,
                      String value)

Add new property entry to the envProperties map.

Parameters:

name - Property name.

value - Property value.

Returns:

this

Throws:

NullPointerException - If name or value are null.

IllegalArgumentException - if name is empty or blank.

withHook

public T withHook(Hook hook)

Add new executable hook to the hooks list.

Parameters:

hook - Hook.

Returns:

this

Throws:

NullPointerException - if hook is null.

withParentClassLoader

public T withParentClassLoader(Class<?> cls)

Change parentClassLoader value.

Parameters:

cls - The class that will be used to get classloader.

Returns:

this

withParentClasspath

public T withParentClasspath(URL classpath,
                             URL... others)

Change parentClassLoader value.

Parameters:

classpath - New classpath entry.

others - Other (optional) classpath urls.

Returns:

this

withParentClasspath

public T withParentClasspath(Collection<URL> classpath)

Change parentClassLoader value.

Parameters:

classpath - New parentClassLoader value.

Returns:

this

withOverrideDescriptor

public T withOverrideDescriptor(String overrideDescriptor)

Change overrideDescriptor (path of the custom web.xml file descriptor=.

Parameters:

overrideDescriptor - The new overrideDescriptor value.

Returns:

this