ReferenceWithError (Apache Brooklyn)

java.lang.Object
- brooklyn.util.exceptions.ReferenceWithError<T>

All Implemented Interfaces:

com.google.common.base.Supplier<T>
```
@Beta
public class ReferenceWithError<T>
extends java.lang.Object
implements com.google.common.base.Supplier<T>
```
A reference to an object which can carry an object alongside it.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`checkNoError()` throws if there is an error (even if masked)
`T`	`get()` returns the underlying value, throwing if there is an error which is not masked (ie `#throwsErrorOnAccess()` is set)
`java.lang.Throwable`	`getError()` returns the error (not throwing)
`T`	`getWithError()` throws error, even if there is one (even if masked), else returns the object
`T`	`getWithoutError()` returns the object, ignoring any error (even non-masked)
`boolean`	`hasError()` true if there is an error (whether masked or not)
`boolean`	`masksErrorIfPresent()` whether this will mask any error on an attempt to `get()`; if false (if created with `newInstanceThrowingError(Object, Throwable)`) a call to `get()` will throw if there is an error; true if created with `newInstanceMaskingError(Object, Throwable)` and `get()` will not throw
`static <T> ReferenceWithError<T>`	`newInstanceMaskingError(T object, java.lang.Throwable error)` returns a reference which includes an error, but attempts to get the content do not cause the error to throw
`static <T> ReferenceWithError<T>`	`newInstanceThrowingError(T object, java.lang.Throwable error)` returns a reference which includes an error, and where attempts to get the content cause the error to throw
`static <T> ReferenceWithError<T>`	`newInstanceWithoutError(T object)` returns a reference which includes an error, but attempts to get the content do not cause the error to throw
`java.lang.String`	`toString()`

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

- Method Detail
  - newInstanceThrowingError
```
public static <T> ReferenceWithError<T> newInstanceThrowingError(T object,
                                                 java.lang.Throwable error)
```
    returns a reference which includes an error, and where attempts to get the content cause the error to throw
  - newInstanceMaskingError
```
public static <T> ReferenceWithError<T> newInstanceMaskingError(T object,
                                                java.lang.Throwable error)
```
    returns a reference which includes an error, but attempts to get the content do not cause the error to throw
  - newInstanceWithoutError
```
public static <T> ReferenceWithError<T> newInstanceWithoutError(T object)
```
    returns a reference which includes an error, but attempts to get the content do not cause the error to throw
  - masksErrorIfPresent
```
public boolean masksErrorIfPresent()
```
    whether this will mask any error on an attempt to get(); if false (if created with newInstanceThrowingError(Object, Throwable)) a call to get() will throw if there is an error; true if created with newInstanceMaskingError(Object, Throwable) and get() will not throw
  - get
```
public T get()
```
    returns the underlying value, throwing if there is an error which is not masked (ie #throwsErrorOnAccess() is set)
    
    Specified by:
    
    get in interface com.google.common.base.Supplier<T>
  - getWithoutError
```
public T getWithoutError()
```
    returns the object, ignoring any error (even non-masked)
  - getWithError
```
public T getWithError()
```
    throws error, even if there is one (even if masked), else returns the object
  - checkNoError
```
public void checkNoError()
```
    throws if there is an error (even if masked)
  - getError
```
public java.lang.Throwable getError()
```
    returns the error (not throwing)
  - hasError
```
public boolean hasError()
```
    true if there is an error (whether masked or not)
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ReferenceWithError<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

newInstanceThrowingError

newInstanceMaskingError

newInstanceWithoutError

masksErrorIfPresent

get

getWithoutError

getWithError

checkNoError

getError

hasError

toString