org.inferred.freebuilder.processor.util

Class PreconditionExcerpts

java.lang.Object

org.inferred.freebuilder.processor.util.PreconditionExcerpts

public class PreconditionExcerpts
extends Object

Code snippets that call or emulate Guava's Preconditions methods.

Method Summary

Modifier and Type	Method and Description
static Excerpt	checkArgument(Object condition, String message, Object... args) Returns an excerpt equivalent to Guava's Preconditions.checkArgument(boolean, String, Object...).
static Excerpt	checkNotNull(Object reference) Returns an excerpt equivalent to Guava's Preconditions.checkNotNull(Object).
static Excerpt	checkNotNullInline(Object reference) Returns an excerpt equivalent to an inline call to Guava's Preconditions.checkNotNull(Object).
static Excerpt	checkNotNullPreamble(Object reference) Returns an excerpt of the preamble required to emulate an inline call to Guava's Preconditions.checkNotNull(Object) method.
static Excerpt	checkState(Object condition, String message, Object... args) Returns an excerpt equivalent to Guava's Preconditions.checkState(boolean, String, Object...).

Methods inherited from class java.lang.Object

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

Method Detail

checkNotNullPreamble

public static Excerpt checkNotNullPreamble(Object reference)

Returns an excerpt of the preamble required to emulate an inline call to Guava's Preconditions.checkNotNull(Object) method.

If Guava or Java 7's Objects are available, no preamble will be generated. Otherwise, the check will be done out-of-line with an if block in this excerpt.

If you use this, you must also use checkNotNullInline(java.lang.Object) to allow the check to be performed inline when possible:

code.add(checkNotNullPreamble("value"))
    .addLine("this.property = %s;", checkNotNullInline("value"));

Parameters:

reference - an excerpt containing the reference to pass to the checkNotNull method

checkNotNullInline

public static Excerpt checkNotNullInline(Object reference)

Returns an excerpt equivalent to an inline call to Guava's Preconditions.checkNotNull(Object).

• If Guava is available, Preconditions.checkNotNull will be used.
• If Objects.requireNonNull is available, it will be used if Guava cannot be.
• If neither are available, the check will be done out-of-line with an if block.

If you use this, you must also use checkNotNullPreamble(java.lang.Object) to allow the check to be performed out-of-line if necessary:

code.add(checkNotNullPreamble("value"))
    .addLine("this.property = %s;", checkNotNullInline("value"));

Parameters:

reference - an excerpt containing the reference to pass to the checkNotNull method

checkNotNull

public static Excerpt checkNotNull(Object reference)

Returns an excerpt equivalent to Guava's Preconditions.checkNotNull(Object).

• If Guava is available, Preconditions.checkNotNull will be used.
• If Objects.requireNonNull is available, it will be used if Guava cannot be.
• If neither are available, the check will be done with an if block.

code.add(checkNotNull("key"))
    .add(checkNotNull("value"))
    .addLine("map.put(key, value);");

Parameters:

reference - an excerpt containing the reference to pass to the checkNotNull method

checkArgument

public static Excerpt checkArgument(Object condition,
                                    String message,
                                    Object... args)

Returns an excerpt equivalent to Guava's Preconditions.checkArgument(boolean, String, Object...).

• If Guava is available, Preconditions.checkArgument will be used.
• Otherwise, the check will be done with an if block.

code.add(checkArgument("age >= 0", "age must be non-negative (got %s)", "age"));

Parameters:

condition - an excerpt containing the expression to pass to the checkArgument method

message - the error message template to pass to the checkArgument method

args - excerpts containing the error message arguments to pass to the checkArgument method

checkState

public static Excerpt checkState(Object condition,
                                 String message,
                                 Object... args)

Returns an excerpt equivalent to Guava's Preconditions.checkState(boolean, String, Object...).

• If Guava is available, Preconditions.checkState will be used.
• Otherwise, the check will be done with an if block.

code.add(checkState("start < end",
         "start must be before end (got %s and %s)", "start", "end"));

Parameters:

condition - an excerpt containing the expression to pass to the checkState method

message - the error message template to pass to the checkState method

args - excerpts containing the error message arguments to pass to the checkState method