org.inferred.freebuilder.processor.source

Class PreconditionExcerpts

java.lang.Object

org.inferred.freebuilder.processor.source.PreconditionExcerpts

public class PreconditionExcerpts
extends java.lang.Object

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

Method Summary

Modifier and Type	Method and Description
static Excerpt	checkArgument(java.lang.String conditionTemplate, java.lang.String messageTemplate, java.lang.Object... args) Returns an excerpt equivalent to Guava's Preconditions.checkArgument(boolean, String, Object...).
static Excerpt	checkState(java.lang.String conditionTemplate, java.lang.String messageTemplate, java.lang.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

checkArgument

public static Excerpt checkArgument(java.lang.String conditionTemplate,
                                    java.lang.String messageTemplate,
                                    java.lang.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("%1$s >= 0", "age must be >= 0 (got %1$s)", "age"));

Parameters:

condition - a code template 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(java.lang.String conditionTemplate,
                                 java.lang.String messageTemplate,
                                 java.lang.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("%1$s < %2$s",
         "start must be before end (got %1$s and %2$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