RESTAssert (Taimos RESTUtils 1.8 API)

java.lang.Object
- de.taimos.restutils.RESTAssert

```
public final class RESTAssert
extends Object
```
Use this class to assert preconditions in REST Handler

assert methods throw WebApplicationException on failure

Author:

thoeger

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PATTERN_DATE` Pattern for date 'yyyy-MM-dd'
`static String`	`PATTERN_DATETIME` Pattern for datetime 'yyyy-MM-dd HH:mm:ss'
`static String`	`PATTERN_ISO` Pattern for ISO date
`static String`	`PATTERN_TIME` Pattern for time 'HH:mm:ss'

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`assertEquals(Object one, Object two)` assert that objects are equal. This means they are both null or `one.equals(two)` returns true
`static void`	`assertEquals(Object one, Object two, javax.ws.rs.core.Response.StatusType status)` assert that objects are equal. This means they are both null or `one.equals(two)` returns true
`static void`	`assertFalse(boolean condition)` returns if condition evaluates to false and throws `WebApplicationException`(422) if it evaluates to true
`static void`	`assertFalse(boolean condition, javax.ws.rs.core.Response.StatusType status)` returns if condition evaluates to false and throws `WebApplicationException` if it evaluates to true
`static void`	`assertInt(String string)` assert that string matches [+-]?[0-9]*
`static void`	`assertInt(String string, javax.ws.rs.core.Response.StatusType status)` assert that string matches [+-]?[0-9]*
`static void`	`assertNotEmpty(Collection<?> collection)` assert that collection is not empty
`static void`	`assertNotEmpty(Collection<?> collection, javax.ws.rs.core.Response.StatusType status)` assert that collection is not empty
`static void`	`assertNotEmpty(String string)` assert that string is not null nor empty
`static void`	`assertNotEmpty(String string, javax.ws.rs.core.Response.StatusType status)` assert that string is not null nor empty
`static void`	`assertNotNull(Object object)` assert that object is not null
`static void`	`assertNotNull(Object object, javax.ws.rs.core.Response.StatusType status)` assert that object is not null
`static void`	`assertPattern(String string, String pattern)` assert that string matches the given pattern
`static void`	`assertPattern(String string, String pattern, javax.ws.rs.core.Response.StatusType status)` assert that string matches the given pattern
`static void`	`assertSingleElement(Collection<?> collection)` assert that collection has one element
`static void`	`assertSingleElement(Collection<?> collection, javax.ws.rs.core.Response.StatusType status)` assert that collection has one element
`static void`	`assertTrue(boolean condition)` returns if condition evaluates to true and throws `WebApplicationException`(422) if it evaluates to false
`static void`	`assertTrue(boolean condition, javax.ws.rs.core.Response.StatusType status)` returns if condition evaluates to true and throws `WebApplicationException` if it evaluates to false
`static void`	`changeFailStatus(javax.ws.rs.core.Response.Status _status)`
`static void`	`fail()` fails every time; same as assertTrue(false)
`static void`	`fail(javax.ws.rs.core.Response.StatusType status)` fails every time; same as assertTrue(false)

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

- Field Detail
  - PATTERN_DATE
```
public static final String PATTERN_DATE
```
    Pattern for date 'yyyy-MM-dd'
    
    See Also:
    
    Constant Field Values
  - PATTERN_TIME
```
public static final String PATTERN_TIME
```
    Pattern for time 'HH:mm:ss'
    
    See Also:
    
    Constant Field Values
  - PATTERN_DATETIME
```
public static final String PATTERN_DATETIME
```
    Pattern for datetime 'yyyy-MM-dd HH:mm:ss'
    
    See Also:
    
    Constant Field Values
  - PATTERN_ISO
```
public static final String PATTERN_ISO
```
    Pattern for ISO date
    
    See Also:
    
    Constant Field Values
- Method Detail
  - changeFailStatus
```
public static void changeFailStatus(javax.ws.rs.core.Response.Status _status)
```
    Parameters:
    
    _status - the new default status code
  - assertTrue
```
public static void assertTrue(boolean condition)
```
    returns if condition evaluates to true and throws WebApplicationException(422) if it evaluates to false
    
    Parameters:
    
    condition - the condition to assert
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with status code 422 (Unprocessable Entity) if condition is false
  - assertTrue
```
public static void assertTrue(boolean condition,
                              javax.ws.rs.core.Response.StatusType status)
```
    returns if condition evaluates to true and throws WebApplicationException if it evaluates to false
    
    Parameters:
    
    condition - the condition to assert
    
    status - the status code to throw
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with given status code if condition is false
  - assertFalse
```
public static void assertFalse(boolean condition)
```
    returns if condition evaluates to false and throws WebApplicationException(422) if it evaluates to true
    
    Parameters:
    
    condition - the condition to assert
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with status code 422 (Unprocessable Entity) if condition is true
  - assertFalse
```
public static void assertFalse(boolean condition,
                               javax.ws.rs.core.Response.StatusType status)
```
    returns if condition evaluates to false and throws WebApplicationException if it evaluates to true
    
    Parameters:
    
    condition - the condition to assert
    
    status - the status code to throw
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with given status code if condition is true
  - fail
```
public static void fail(javax.ws.rs.core.Response.StatusType status)
```
    fails every time; same as assertTrue(false)
    
    Parameters:
    
    status - the status to fail with
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with given status code
  - fail
```
public static void fail()
```
    fails every time; same as assertTrue(false)
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with status code 422 (Unprocessable Entity)
  - assertNotNull
```
public static void assertNotNull(Object object)
```
    assert that object is not null
    
    Parameters:
    
    object - the object to check
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with status code 422 (Unprocessable Entity)
  - assertNotNull
```
public static void assertNotNull(Object object,
                                 javax.ws.rs.core.Response.StatusType status)
```
    assert that object is not null
    
    Parameters:
    
    object - the object to check
    
    status - the status code to throw
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with given status code
  - assertNotEmpty
```
public static void assertNotEmpty(String string)
```
    assert that string is not null nor empty
    
    Parameters:
    
    string - the string to check
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with status code 422 (Unprocessable Entity)
  - assertNotEmpty
```
public static void assertNotEmpty(String string,
                                  javax.ws.rs.core.Response.StatusType status)
```
    assert that string is not null nor empty
    
    Parameters:
    
    string - the string to check
    
    status - the status code to throw
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with given status code
  - assertNotEmpty
```
public static void assertNotEmpty(Collection<?> collection)
```
    assert that collection is not empty
    
    Parameters:
    
    collection - the collection to check
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with status code 422 (Unprocessable Entity)
  - assertNotEmpty
```
public static void assertNotEmpty(Collection<?> collection,
                                  javax.ws.rs.core.Response.StatusType status)
```
    assert that collection is not empty
    
    Parameters:
    
    collection - the collection to check
    
    status - the status code to throw
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with given status code
  - assertSingleElement
```
public static void assertSingleElement(Collection<?> collection)
```
    assert that collection has one element
    
    Parameters:
    
    collection - the collection to check
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with status code 422 (Unprocessable Entity)
  - assertSingleElement
```
public static void assertSingleElement(Collection<?> collection,
                                       javax.ws.rs.core.Response.StatusType status)
```
    assert that collection has one element
    
    Parameters:
    
    collection - the collection to check
    
    status - the status code to throw
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with given status code
  - assertEquals
```
public static void assertEquals(Object one,
                                Object two)
```
    assert that objects are equal.
    This means they are both null or one.equals(two) returns true
    
    Parameters:
    
    one - the first object
    
    two - the second object
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with status code 422 (Unprocessable Entity)
  - assertEquals
```
public static void assertEquals(Object one,
                                Object two,
                                javax.ws.rs.core.Response.StatusType status)
```
    assert that objects are equal.
    This means they are both null or one.equals(two) returns true
    
    Parameters:
    
    one - the first object
    
    two - the second object
    
    status - the status code to throw
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with given status code
  - assertInt
```
public static void assertInt(String string)
```
    assert that string matches [+-]?[0-9]*
    
    Parameters:
    
    string - the string to check
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with status code 422 (Unprocessable Entity)
  - assertInt
```
public static void assertInt(String string,
                             javax.ws.rs.core.Response.StatusType status)
```
    assert that string matches [+-]?[0-9]*
    
    Parameters:
    
    string - the string to check
    
    status - the status code to throw
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with given status code
  - assertPattern
```
public static void assertPattern(String string,
                                 String pattern)
```
    assert that string matches the given pattern
    
    Parameters:
    
    string - the string to check
    
    pattern - the pattern to check
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with status code 422 (Unprocessable Entity)
  - assertPattern
```
public static void assertPattern(String string,
                                 String pattern,
                                 javax.ws.rs.core.Response.StatusType status)
```
    assert that string matches the given pattern
    
    Parameters:
    
    string - the string to check
    
    status - the status code to throw
    
    Throws:
    
    javax.ws.rs.WebApplicationException - with given status code

Class RESTAssert

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATTERN_DATE

PATTERN_TIME

PATTERN_DATETIME

PATTERN_ISO

Method Detail

changeFailStatus

assertTrue

assertTrue

assertFalse

assertFalse

fail

fail

assertNotNull

assertNotNull

assertNotEmpty

assertNotEmpty

assertNotEmpty

assertNotEmpty

assertSingleElement

assertSingleElement

assertEquals

assertEquals

assertInt

assertInt

assertPattern

assertPattern