Configuration (Requirements 2.0.0 API)

java.lang.Object
- org.bitbucket.cowwoc.requirements.spi.Configuration

```
@Beta
public final class Configuration
extends Object
```
Determines the behavior of a requirements verifier.

Author:

Gili Tzabari

Constructor Summary

Constructors
Constructor and Description

Configuration(Class<? extends RuntimeException> exceptionOverride, Map<String,Object> context)
Creates a new instance.

Constructors
Constructor and Description
`Configuration(Class<? extends RuntimeException> exceptionOverride, Map<String,Object> context)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<E extends RuntimeException> RuntimeException`	`createException(Class<E> type, String message)` Creates a new exception.
`<E extends RuntimeException> RuntimeException`	`createException(Class<E> type, String message, Map<String,Object> initialContext, Throwable cause)` Creates a new exception.
`<E extends RuntimeException> RuntimeException`	`createException(Class<E> type, String message, String key1, Object value1)` Creates a new exception.
`<E extends RuntimeException> RuntimeException`	`createException(Class<E> type, String message, String key1, Object value1, String key2, Object value2)` Creates a new exception.
`<E extends RuntimeException> RuntimeException`	`createException(Class<E> type, String message, String key1, Object value1, String key2, Object value2, String key3, Object value3)` Creates a new exception.
`<E extends RuntimeException> RuntimeException`	`createException(Class<E> type, String message, String key1, Object value1, String key2, Object value2, String key3, Object value3, String key4, Object value4)` Creates a new exception.
`<E extends RuntimeException> RuntimeException`	`createException(Class<E> type, String message, String key1, Object value1, String key2, Object value2, String key3, Object value3, String key4, Object value4, Throwable cause)` Creates a new exception.
`<E extends RuntimeException> RuntimeException`	`createException(Class<E> type, String message, String key1, Object value1, String key2, Object value2, String key3, Object value3, Throwable cause)` Creates a new exception.
`<E extends RuntimeException> RuntimeException`	`createException(Class<E> type, String message, String key1, Object value1, String key2, Object value2, Throwable cause)` Creates a new exception.
`<E extends RuntimeException> RuntimeException`	`createException(Class<E> type, String message, String key1, Object value1, Throwable cause)` Creates a new exception.
`<E extends RuntimeException> RuntimeException`	`createException(Class<E> type, String message, Throwable cause)` Creates a new exception.
`ImmutableMap<String,Object>`	`getContext()`
`Class<? extends RuntimeException>`	`getExceptionOverride()`
`Configuration`	`withContext(Map<String,Object> context)` Supplies additional key-value pairs to output if a requirement is not met.
`Configuration`	`withException(Class<? extends RuntimeException> exception)` Overrides the type of exception that will get thrown if a requirement fails.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- Configuration
```
public Configuration(Class<? extends RuntimeException> exceptionOverride,
                     Map<String,Object> context)
```
  Creates a new instance.
  
  Parameters:
  
  exceptionOverride - the type of exception to throw, null to disable the override
  
  context - key-value pairs to append to the exception message

Method Detail

withException
```
public Configuration withException(Class<? extends RuntimeException> exception)
```
Overrides the type of exception that will get thrown if a requirement fails.

Parameters:

exception - the type of exception to throw, null to disable the override

Returns:

this

withContext
```
public Configuration withContext(Map<String,Object> context)
                          throws NullPointerException
```
Supplies additional key-value pairs to output if a requirement is not met.

Parameters:

context - a map of key-value pairs

Returns:

this

Throws:

NullPointerException - if context is null

getExceptionOverride
```
public Class<? extends RuntimeException> getExceptionOverride()
```
Returns:

the type of exception to throw, null to disable the override

getContext
```
public ImmutableMap<String,Object> getContext()
```
Returns:

key-value pairs to append to the exception message

createException

public <E extends RuntimeException> RuntimeException createException(Class<E> type,
                                                                     String message)

Creates a new exception.

Type Parameters:: E - the type of the exception
Parameters:: type - the type of the exception; message - an explanation of what went wrong
Returns:: the exception
Throws:: NullPointerException - if type or message are null

createException

public <E extends RuntimeException> RuntimeException createException(Class<E> type,
                                                                     String message,
                                                                     Throwable cause)

Creates a new exception.

Type Parameters:: E - the type of the exception
Parameters:: type - the type of the exception; message - an explanation of what went wrong; cause - the cause of the exception
Returns:: the exception
Throws:: NullPointerException - if type or message are null

createException

public <E extends RuntimeException> RuntimeException createException(Class<E> type,
                                                                     String message,
                                                                     String key1,
                                                                     Object value1)

Creates a new exception.

Type Parameters:: E - the type of the exception
Parameters:: type - the type of the exception; message - an explanation of what went wrong; key1 - the first key to append to the exception message; value1 - the first value to append to the exception message
Returns:: the exception
Throws:: NullPointerException - if type, message or key1 are null

createException

public <E extends RuntimeException> RuntimeException createException(Class<E> type,
                                                                     String message,
                                                                     String key1,
                                                                     Object value1,
                                                                     Throwable cause)

Creates a new exception.

Type Parameters:: E - the type of the exception
Parameters:: type - the type of the exception; message - an explanation of what went wrong; key1 - the first key to append to the exception message; value1 - the first value to append to the exception message; cause - the cause of the exception
Returns:: the exception
Throws:: NullPointerException - if type, message or key1 are null

createException

public <E extends RuntimeException> RuntimeException createException(Class<E> type,
                                                                     String message,
                                                                     String key1,
                                                                     Object value1,
                                                                     String key2,
                                                                     Object value2)

Creates a new exception.

Type Parameters:: E - the type of the exception
Parameters:: type - the type of the exception; message - an explanation of what went wrong; key1 - the first key to append to the exception message; value1 - the first value to append to the exception message; key2 - the second key to append to the exception message; value2 - the second value to append to the exception message
Returns:: the exception
Throws:: NullPointerException - if type, message, key1 or key2 are null

createException

public <E extends RuntimeException> RuntimeException createException(Class<E> type,
                                                                     String message,
                                                                     String key1,
                                                                     Object value1,
                                                                     String key2,
                                                                     Object value2,
                                                                     Throwable cause)

Creates a new exception.

Type Parameters:: E - the type of the exception
Parameters:: type - the type of the exception; message - an explanation of what went wrong; key1 - the first key to append to the exception message; value1 - the first value to append to the exception message; key2 - the second key to append to the exception message; value2 - the second value to append to the exception message; cause - the cause of the exception
Returns:: the exception
Throws:: NullPointerException - if type, message, key1 or key2 are null

createException

public <E extends RuntimeException> RuntimeException createException(Class<E> type,
                                                                     String message,
                                                                     String key1,
                                                                     Object value1,
                                                                     String key2,
                                                                     Object value2,
                                                                     String key3,
                                                                     Object value3)

Creates a new exception.

Type Parameters:: E - the type of the exception
Parameters:: type - the type of the exception; message - an explanation of what went wrong; key1 - the first key to append to the exception message; value1 - the first value to append to the exception message; key2 - the second key to append to the exception message; value2 - the second value to append to the exception message; key3 - the third key to append to the exception message; value3 - the third value to append to the exception message
Returns:: the exception
Throws:: NullPointerException - if type, message, key1, key2 or key3 are null

createException

public <E extends RuntimeException> RuntimeException createException(Class<E> type,
                                                                     String message,
                                                                     String key1,
                                                                     Object value1,
                                                                     String key2,
                                                                     Object value2,
                                                                     String key3,
                                                                     Object value3,
                                                                     Throwable cause)

Creates a new exception.

Type Parameters:: E - the type of the exception
Parameters:: type - the type of the exception; message - an explanation of what went wrong; key1 - the first key to append to the exception message; value1 - the first value to append to the exception message; key2 - the second key to append to the exception message; value2 - the second value to append to the exception message; key3 - the third key to append to the exception message; value3 - the third value to append to the exception message; cause - the cause of the exception
Returns:: the exception
Throws:: NullPointerException - if type, message, key1, key2 or key3 are null

createException

public <E extends RuntimeException> RuntimeException createException(Class<E> type,
                                                                     String message,
                                                                     String key1,
                                                                     Object value1,
                                                                     String key2,
                                                                     Object value2,
                                                                     String key3,
                                                                     Object value3,
                                                                     String key4,
                                                                     Object value4)

Creates a new exception.

Type Parameters:: E - the type of the exception
Parameters:: type - the type of the exception; message - an explanation of what went wrong; key1 - the first key to append to the exception message; value1 - the first value to append to the exception message; key2 - the second key to append to the exception message; value2 - the second value to append to the exception message; key3 - the third key to append to the exception message; value3 - the third value to append to the exception message; key4 - the third key to append to the exception message; value4 - the third value to append to the exception message
Returns:: the exception
Throws:: NullPointerException - if type, message, key1, key2, key3 or key4 are null

createException

public <E extends RuntimeException> RuntimeException createException(Class<E> type,
                                                                     String message,
                                                                     String key1,
                                                                     Object value1,
                                                                     String key2,
                                                                     Object value2,
                                                                     String key3,
                                                                     Object value3,
                                                                     String key4,
                                                                     Object value4,
                                                                     Throwable cause)

Creates a new exception.

Type Parameters:: E - the type of the exception
Parameters:: type - the type of the exception; message - an explanation of what went wrong; key1 - the first key to append to the exception message; value1 - the first value to append to the exception message; key2 - the second key to append to the exception message; value2 - the second value to append to the exception message; key3 - the third key to append to the exception message; value3 - the third value to append to the exception message; key4 - the third key to append to the exception message; value4 - the third value to append to the exception message; cause - the cause of the exception
Returns:: the exception
Throws:: NullPointerException - if type, message, key1, key2, key3 or key4 are null

createException

public <E extends RuntimeException> RuntimeException createException(Class<E> type,
                                                                     String message,
                                                                     Map<String,Object> initialContext,
                                                                     Throwable cause)

Creates a new exception.

Type Parameters:: E - the type of the exception
Parameters:: type - the type of the exception; message - an explanation of what went wrong; initialContext - key-value pairs to append to the exception message before the context passed into the constructor; cause - the cause of the exception
Returns:: the exception
Throws:: NullPointerException - if any of the arguments are null

Class Configuration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Configuration

Method Detail

withException

withContext

getExceptionOverride

getContext

createException

createException

createException

createException

createException

createException

createException

createException

createException

createException

createException