com.tavianator.sangria.core

Class DelayedError

java.lang.Object

com.tavianator.sangria.core.DelayedError

public class DelayedError
extends Object

Similar to Binder.addError(String, Object...), but can be canceled later. Useful for enforcing correct usage of fluent APIs.

Since:

1.0

Version:

1.0

Author:

Tavian Barnes (tavianator@tavianator.com)

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancel this error.
static DelayedError	create(Binder binder, Message message) Create a DelayedError.
static DelayedError	create(Binder binder, String message, Object... args) Create a DelayedError.
static DelayedError	create(Binder binder, Throwable t) Create a DelayedError.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static DelayedError create(Binder binder,
                  String message,
                  Object... args)

Create a DelayedError.

Parameters:

binder - The binder to attach the error to.

message - The format string for the message.

args - Arguments that will be passed to the format string.

Returns:

A DelayedError token that can be canceled later.

See Also:

Binder.addError(String, Object...)

create

public static DelayedError create(Binder binder,
                  Throwable t)

Create a DelayedError.

Parameters:

binder - The binder to attach the error to.

t - The Throwable that caused this potential error.

Returns:

A DelayedError token that can be canceled later.

See Also:

Binder.addError(Throwable)

create

public static DelayedError create(Binder binder,
                  Message message)

Create a DelayedError.

Parameters:

binder - The binder to attach the error to.

message - The error message.

Returns:

A DelayedError token that can be canceled later.

See Also:

Binder.addError(Message)

cancel

public void cancel()

Cancel this error.