org.checkerframework.checker.formatter

Enum FormatterTreeUtil.InvocationType

java.lang.Object

java.lang.Enum<FormatterTreeUtil.InvocationType>

org.checkerframework.checker.formatter.FormatterTreeUtil.InvocationType

All Implemented Interfaces:

Serializable, Comparable<FormatterTreeUtil.InvocationType>

Enclosing class:

FormatterTreeUtil

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

Describes the ways a format method may be invoked.

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static FormatterTreeUtil.InvocationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static FormatterTreeUtil.InvocationType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static FormatterTreeUtil.InvocationType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FormatterTreeUtil.InvocationType c : FormatterTreeUtil.InvocationType.values())
    System.out.println(c);

Returns:

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

valueOf

public static FormatterTreeUtil.InvocationType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null