ApiError (Apache Brooklyn)

java.lang.Object
- brooklyn.rest.domain.ApiError

All Implemented Interfaces:: java.io.Serializable

public class ApiError
extends java.lang.Object
implements java.io.Serializable

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ApiError.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`ApiError.Builder`

Constructor Summary

Constructors
Constructor and Description
`ApiError(java.lang.String message)`
`ApiError(java.lang.String message, java.lang.String details)`
`ApiError(java.lang.String message, java.lang.String details, java.lang.Integer error)`

Method Summary

Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`asBadRequestResponseJson()`
`javax.ws.rs.core.Response`	`asJsonResponse()`
`javax.ws.rs.core.Response`	`asResponse(javax.ws.rs.core.MediaType type)`
`javax.ws.rs.core.Response`	`asResponse(javax.ws.rs.core.Response.Status defaultStatus, javax.ws.rs.core.MediaType type)`
`static ApiError.Builder`	`builder()`
`static ApiError.Builder`	`builderFromThrowable(java.lang.Throwable t)`
`boolean`	`equals(java.lang.Object other)`
`static ApiError.Builder`	`fromThrowable(java.lang.Throwable t)` Deprecated. since 0.7.0; use `builderFromThrowable(Throwable)`
`java.lang.String`	`getDetails()`
`java.lang.Integer`	`getError()`
`java.lang.String`	`getMessage()`
`int`	`hashCode()`
`static ApiError`	`of(java.lang.String message)`
`static ApiError`	`of(java.lang.Throwable t)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApiError

public ApiError(java.lang.String message)

ApiError

public ApiError(java.lang.String message,
        java.lang.String details)

ApiError

public ApiError(java.lang.String message,
        java.lang.String details,
        java.lang.Integer error)

Method Detail

builder

public static ApiError.Builder builder()

of

public static ApiError of(java.lang.Throwable t)

of

public static ApiError of(java.lang.String message)

fromThrowable

@Deprecated
public static ApiError.Builder fromThrowable(java.lang.Throwable t)

Deprecated. since 0.7.0; use builderFromThrowable(Throwable)

builderFromThrowable
```
public static ApiError.Builder builderFromThrowable(java.lang.Throwable t)
```
Returns:
An ApiError.Builder whose message is initialised to either the throwable's message or the throwable's class name if the message is null and whose details are initialised to the throwable's stack trace.

getMessage
```
public java.lang.String getMessage()
```

getDetails
```
public java.lang.String getDetails()
```

getError
```
public java.lang.Integer getError()
```

equals

public boolean equals(java.lang.Object other)

Overrides:: equals in class java.lang.Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

asBadRequestResponseJson

public javax.ws.rs.core.Response asBadRequestResponseJson()

asResponse

public javax.ws.rs.core.Response asResponse(javax.ws.rs.core.Response.Status defaultStatus,
                                   javax.ws.rs.core.MediaType type)

asResponse

public javax.ws.rs.core.Response asResponse(javax.ws.rs.core.MediaType type)

asJsonResponse

public javax.ws.rs.core.Response asJsonResponse()

Class ApiError

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiError

ApiError

ApiError

Method Detail

builder

of

of

fromThrowable

builderFromThrowable

getMessage

getDetails

getError

equals

hashCode

toString

asBadRequestResponseJson

asResponse

asResponse

asJsonResponse