BuiltinFunction (Closure Templates)

java.lang.Object
- java.lang.Enum<BuiltinFunction>
- - com.google.template.soy.shared.internal.BuiltinFunction

All Implemented Interfaces:

SoyFunction, Serializable, Comparable<BuiltinFunction>
```
public enum BuiltinFunction
extends Enum<BuiltinFunction>
implements SoyFunction
```
Enum of built-in functions supported in Soy expressions.
Important: Do not use outside of Soy code (treat as superpackage-private).

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CHECK_NOT_NULL`
`CSS` Function for substituting CSS class names according to a lookup map.
`INDEX`
`IS_FIRST`
`IS_LAST`
`IS_PRIMARY_MSG_IN_USE`
`MSG_ID`
`QUOTE_KEYS_IF_JS`
`REMAINDER`
`V1_EXPRESSION`
`XID`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static BuiltinFunction`	`forFunctionName(String functionName)` Returns the NonpluginFunction for the given function name, or null if not found.
`String`	`getName()` Gets the name of the Soy function.
`Set<Integer>`	`getValidArgsSizes()` Gets the set of valid args list sizes.
`static com.google.common.collect.ImmutableSet<String>`	`names()`
`static BuiltinFunction`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static BuiltinFunction[]`	`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
  - IS_FIRST
```
public static final BuiltinFunction IS_FIRST
```
  - IS_LAST
```
public static final BuiltinFunction IS_LAST
```
  - INDEX
```
public static final BuiltinFunction INDEX
```
  - QUOTE_KEYS_IF_JS
```
public static final BuiltinFunction QUOTE_KEYS_IF_JS
```
  - CHECK_NOT_NULL
```
public static final BuiltinFunction CHECK_NOT_NULL
```
  - CSS
```
public static final BuiltinFunction CSS
```
    Function for substituting CSS class names according to a lookup map.
    Takes 1 or 2 arguments: an optional prefix (if present, this is the first arg), followed by a string literal selector name.
  - XID
```
public static final BuiltinFunction XID
```
  - V1_EXPRESSION
```
public static final BuiltinFunction V1_EXPRESSION
```
  - REMAINDER
```
public static final BuiltinFunction REMAINDER
```
  - MSG_ID
```
public static final BuiltinFunction MSG_ID
```
  - IS_PRIMARY_MSG_IN_USE
```
public static final BuiltinFunction IS_PRIMARY_MSG_IN_USE
```
- Method Detail
  - values
```
public static BuiltinFunction[] 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 (BuiltinFunction c : BuiltinFunction.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BuiltinFunction 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
  - names
```
public static com.google.common.collect.ImmutableSet<String> names()
```
  - forFunctionName
```
@Nullable
public static BuiltinFunction forFunctionName(String functionName)
```
    Returns the NonpluginFunction for the given function name, or null if not found.
    
    Parameters:
    
    functionName - The function name to retrieve.
  - getName
```
public String getName()
```
    Description copied from interface: SoyFunction
    
    Gets the name of the Soy function.
    
    Specified by:
    
    getName in interface SoyFunction
    
    Returns:
    
    The name of the Soy function.
  - getValidArgsSizes
```
public Set<Integer> getValidArgsSizes()
```
    Description copied from interface: SoyFunction
    
    Gets the set of valid args list sizes. For example, the set {0, 2} would indicate that this function can take 0 or 2 arguments (but not 1).
    
    Specified by:
    
    getValidArgsSizes in interface SoyFunction
    
    Returns:
    
    The set of valid args list sizes.

Enum BuiltinFunction

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

IS_FIRST

IS_LAST

INDEX

QUOTE_KEYS_IF_JS

CHECK_NOT_NULL

CSS

XID

V1_EXPRESSION

REMAINDER

MSG_ID

IS_PRIMARY_MSG_IN_USE

Method Detail

values

valueOf

names

forFunctionName

getName

getValidArgsSizes