NumberHelper (Handlebars Helpers 4.0.6 API)

Prev Class
Next Class

All Classes

Summary:
Nested |
Enum Constants |
Field |
Method

Detail:
Enum Constants |
Field |
Method

java.lang.Object
- java.lang.Enum<NumberHelper>
- - com.github.jknack.handlebars.helper.NumberHelper

All Implemented Interfaces:

Helper<Object>, Serializable, Comparable<NumberHelper>
```
public enum NumberHelper
extends Enum<NumberHelper>
implements Helper<Object>
```
Commons number function helpers.

Author:

https://github.com/Jarlakxen

Enum Constant Summary

Enum Constants
Enum Constant and Description
`isEven` You can use the isEven helper to return a value only if the first argument is even.
`isOdd` You can use the isOdd helper to return a value only if the first argument is odd.
`stripes` You can use the stripes helper to return different value if the passed argument is odd or even.

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`apply(Object context, Options options)`
`protected boolean`	`isEven(Number value)` Apply the helper to the context.
`static void`	`register(Handlebars handlebars)` Register all the number helpers.
`void`	`registerHelper(Handlebars handlebars)` Register the helper in a handlebars instance.
`protected abstract CharSequence`	`safeApply(Number value, Options options)` Apply the helper to the context.
`static NumberHelper`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static NumberHelper[]`	`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
  - isEven
```
public static final NumberHelper isEven
```
    You can use the isEven helper to return a value only if the first argument is even. Otherwise return null.
  - If value is 2, the output will be "leftBox".

isOdd
```
public static final NumberHelper isOdd
```
You can use the isOdd helper to return a value only if the first argument is odd. Otherwise return null.
If value is 3, the output will be "rightBox".

stripes
```
public static final NumberHelper stripes
```
You can use the stripes helper to return different value if the passed argument is odd or even. If value is 2, the output will be "row-even".

Method Detail
- values
```
public static NumberHelper[] 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 (NumberHelper c : NumberHelper.values())
    System.out.println(c);
```
  Returns:
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static NumberHelper 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
- apply
```
public Object apply(Object context,
           Options options)
             throws IOException
```
  Specified by:
  
  apply in interface Helper<Object>
  
  Throws:
  
  IOException
- safeApply
```
protected abstract CharSequence safeApply(Number value,
                     Options options)
```
  Apply the helper to the context.
  
  Parameters:
  value - The context object (param=0).
  options - The options object.
  
  Returns:
  A string result.
- isEven
```
protected boolean isEven(Number value)
```
  Apply the helper to the context.
  
  Parameters:
  value - The number value.
  
  Returns:
  true is even, false is odd
- registerHelper
```
public void registerHelper(Handlebars handlebars)
```
  Register the helper in a handlebars instance.
  
  Parameters:
  handlebars - A handlebars object. Required.
- register
```
public static void register(Handlebars handlebars)
```
  Register all the number helpers.
  
  Parameters:
  handlebars - The helper's owner. Required.

Prev Class
Next Class

All Classes

Summary:
Nested |
Enum Constants |
Field |
Method

Detail:
Enum Constants |
Field |
Method

Copyright © 2016. All rights reserved.