Package org.checkerframework.checker.formatter

Enum Class FormatterTreeUtil.InvocationType

java.lang.Object

java.lang.Enum<FormatterTreeUtil.InvocationType>

org.checkerframework.checker.formatter.FormatterTreeUtil.InvocationType

All Implemented Interfaces:

Serializable, Comparable<FormatterTreeUtil.InvocationType>, Constable

Enclosing class:

FormatterTreeUtil

public static enum FormatterTreeUtil.InvocationType
extends Enum<FormatterTreeUtil.InvocationType>

Describes the ways a format method may be invoked.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARRAY	The parameters are passed as array.
NULLARRAY	A null array is passed to the format method.
VARARG	The parameters are passed as varargs.

Method Summary

Modifier and Type	Method	Description
static FormatterTreeUtil.InvocationType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FormatterTreeUtil.InvocationType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

VARARG

public static final FormatterTreeUtil.InvocationType VARARG

The parameters are passed as varargs. For example:

 String.format("%s %d", "Example", 7);
 

ARRAY

public static final FormatterTreeUtil.InvocationType ARRAY

The parameters are passed as array. For example:

 Object[] a = new Object[]{"Example",7};
 String.format("%s %d", a);
 

NULLARRAY

public static final FormatterTreeUtil.InvocationType NULLARRAY

A null array is passed to the format method. This happens seldomly.

 String.format("%s %d", (Object[])null);
 

Method Details

values

public static FormatterTreeUtil.InvocationType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FormatterTreeUtil.InvocationType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null