com.abiquo.event.model.details

Class ErrorDetails

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.collect.ForwardingMap<AbiquoKey,java.lang.Object>

com.abiquo.event.model.details.EventDetails

com.abiquo.event.model.details.ErrorDetails

All Implemented Interfaces:

java.io.Serializable, java.util.Map<AbiquoKey,java.lang.Object>

public class ErrorDetails
extends EventDetails

Decorator for map with the details of the performed event when the severity event is Severity.ERROR.

An ErrorDetails always will report about the error code, error message and error scope of the event, and may report the stracktrace of a thrown Exception.

Author:

Sergi Castro

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorDetails.Builder<B extends ErrorDetails.Builder<B,E>,E extends ErrorDetails> Builder helper for ErrorDetails.
static class	ErrorDetails.KEYS Enumeration of all keys for this map

Nested classes/interfaces inherited from class com.google.common.collect.ForwardingMap

com.google.common.collect.ForwardingMap.StandardEntrySet, com.google.common.collect.ForwardingMap.StandardKeySet, com.google.common.collect.ForwardingMap.StandardValues

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ErrorDetails(com.google.common.collect.ImmutableMap<AbiquoKey,java.lang.Object> map) Creates the forwarding map using a copy of the given ImmutableMap map.

Method Summary

Modifier and Type	Method and Description
static ErrorDetails.Builder<?,ErrorDetails>	builder(AbiquoError error, ErrorScope scope) Returns a builder instance for ErrorDetails with the required parameters AbiquoError error and ErrorScope scope.
static ErrorDetails.Builder<?,ErrorDetails>	builder(AbiquoError error, ErrorScope scope, java.lang.Throwable stacktrace) Returns a builder instance for ErrorDetails with the required parameters AbiquoError error and ErrorScope scope and the optional parameter stacktrace of the Throwable.
static ErrorDetails.Builder<?,ErrorDetails>	builder(java.util.List<AbiquoError> errors, ErrorScope scope) Returns a builder instance for ErrorDetails with the required parameters AbiquoError errors and ErrorScope scope.
static ErrorDetails.Builder<?,ErrorDetails>	builder(java.util.List<AbiquoError> errors, ErrorScope scope, java.lang.Throwable stacktrace) Returns a builder instance for ErrorDetails with the required parameters AbiquoError errors and ErrorScope scope and the optional parameter stacktrace of the Throwable.
static ErrorDetails.Builder<?,ErrorDetails>	builder(java.lang.String code, java.lang.String message, java.lang.String scope) Returns a builder instance for ErrorDetails with the required parameters
java.lang.String	getCode()
static java.lang.String	getFormattedStracktrace(java.lang.Throwable throwable) Extracts the stack trace elements and formatted them into a single string.
java.lang.String	getMessage()
java.lang.String	getScope()
java.lang.String	getStacktrace()

Methods inherited from class com.abiquo.event.model.details.EventDetails

delegate, equals, getTransportMap, hashCode

Methods inherited from class com.google.common.collect.ForwardingMap

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, standardClear, standardContainsKey, standardContainsValue, standardEquals, standardHashCode, standardIsEmpty, standardPutAll, standardRemove, standardToString, values

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ErrorDetails

protected ErrorDetails(com.google.common.collect.ImmutableMap<AbiquoKey,java.lang.Object> map)

Creates the forwarding map using a copy of the given ImmutableMap map.

Must be a non-visible constructor to force the developer to use the ErrorDetails.Builder.

Parameters:

map - the immutable map to create the event details

Method Detail

getCode

public java.lang.String getCode()

Returns:

the code of an abiquo api error

getMessage

public java.lang.String getMessage()

Returns:

the message an abiquo api error

getScope

public java.lang.String getScope()

Returns:

the scope affected by the error

getStacktrace

public java.lang.String getStacktrace()

Returns:

the stacktrace generated by the error

builder

public static ErrorDetails.Builder<?,ErrorDetails> builder(AbiquoError error,
                                                           ErrorScope scope)

Returns a builder instance for ErrorDetails with the required parameters AbiquoError error and ErrorScope scope.

Parameters:

error - the AbiquoError which has promoted the event

scope - the ErrorScope which has affected by the error of the event

Returns:

a builder instance for ErrorDetails

builder

public static ErrorDetails.Builder<?,ErrorDetails> builder(java.util.List<AbiquoError> errors,
                                                           ErrorScope scope)

Returns a builder instance for ErrorDetails with the required parameters AbiquoError errors and ErrorScope scope.

Parameters:

errors - the list of AbiquoError which have promoted the event

scope - the ErrorScope which has affected by the error of the event

Returns:

a builder instance for ErrorDetails

builder

public static ErrorDetails.Builder<?,ErrorDetails> builder(java.util.List<AbiquoError> errors,
                                                           ErrorScope scope,
                                                           java.lang.Throwable stacktrace)

Returns a builder instance for ErrorDetails with the required parameters AbiquoError errors and ErrorScope scope and the optional parameter stacktrace of the Throwable.

Parameters:

errors - the AbiquoError which have promoted the event

scope - the ErrorScope which has affected by the error of the event

stacktrace - of the Throwable which has caused the error

Returns:

a builder instance for ErrorDetails

builder

public static ErrorDetails.Builder<?,ErrorDetails> builder(AbiquoError error,
                                                           ErrorScope scope,
                                                           java.lang.Throwable stacktrace)

Returns a builder instance for ErrorDetails with the required parameters AbiquoError error and ErrorScope scope and the optional parameter stacktrace of the Throwable.

Parameters:

error - the AbiquoError which has promoted the event

scope - the ErrorScope which has affected by the error of the event

stacktrace - of the Throwable which has caused the error

Returns:

a builder instance for ErrorDetails

builder

public static ErrorDetails.Builder<?,ErrorDetails> builder(java.lang.String code,
                                                           java.lang.String message,
                                                           java.lang.String scope)

Returns a builder instance for ErrorDetails with the required parameters

Parameters:

code - the code of an abiquo api error

message - the message an abiquo api error

scope - the stacktrace generated by the error

Returns:

a builder instance for ErrorDetails

getFormattedStracktrace

public static java.lang.String getFormattedStracktrace(java.lang.Throwable throwable)

Extracts the stack trace elements and formatted them into a single string. If no stack trace a empty string is returned.

Parameters:

throwable - with a stacktrace or not.

Returns:

Formatted stack trace if present in throwable empty otherwise.