CommonFunctions (TriggerReactor API)

java.lang.Object
- io.github.wysohn.triggerreactor.core.manager.trigger.share.CommonFunctions

All Implemented Interfaces:

SelfReference

Direct Known Subclasses:

AbstractCommonFunctions, CommonFunctions
```
public class CommonFunctions
extends Object
implements SelfReference
```

Constructor Summary

Constructors
Constructor and Description

CommonFunctions()

Constructors
Constructor and Description
`CommonFunctions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object[]`	`array(int size)` create an empty array
`Object[]`	`arrayOf(Object... values)`
`String`	`formatCurrency(double money)` Translate money into specified country's currency format.
`String`	`formatCurrency(double money, String locale1, String locale2)` Translate money into specified country's currency format.
`List<Object>`	`list()`
`List<Object>`	`listOf(Object... values)`
`Map<Object,Object>`	`map()`
`boolean`	`matches(String str, String regex)` matches the str by using regular expression regex
`String`	`mergeArguments(String[] args)` Merge array of String.
`String`	`mergeArguments(String[] args, int indexFrom)` Merge array of String.
`String`	`mergeArguments(String[] args, int indexFrom, int indexTo)` Merge array of String.
`Object`	`newInstance(String className, Object... args)`
`double`	`parseDouble(String str)` parse the string that contains decimal into real decimal value.
`Object`	`parseEnum(String enumClassName, String valueName)` Get enum value manually.
`int`	`parseInt(String str)` parse the string that contains integer into real integer value.
`double`	`random(double end)`
`double`	`random(double start, double end)`
`float`	`random(float end)`
`float`	`random(float start, float end)`
`int`	`random(int end)` get a random integer value between 0 to end
`int`	`random(int start, int end)` get a random integer value between start to end *
`long`	`random(long end)`
`long`	`random(long start, long end)`
`String`	`round(double val, int decimal)` get a string representing the input value rounded to the set decimal place
`Set<Object>`	`set()`
`Set<Object>`	`set(Collection<?> iterable)`
`SimpleLocation`	`slocation(String world, int x, int y, int z)`
`double`	`sqrt(int num)`
`Object`	`staticGetFieldValue(String className, String fieldName)` Try to get static value for specified field from specified class.
`Object`	`staticMethod(String className, String methodName, Object... args)` Invoke the static method of provided class.
`void`	`staticSetFieldValue(String className, String fieldName, Object value)` Try to set static value for specified field from specified class.
`byte`	`toByte(Number number)`
`double`	`toDouble(Number number)`
`float`	`toFloat(Number number)`
`int`	`toInt(Number number)`
`long`	`toLong(Number number)`
`short`	`toShort(Number number)`
`String`	`typeOf(Object value, boolean withFullPath)` Return the name of the class that provided object was created by.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CommonFunctions
```
public CommonFunctions()
```
- Method Detail
  - random
```
public int random(int end)
```
    get a random integer value between 0 to end
    Example) #MESSAGE "You rolled the dice: "+(random(6) + 1)
    
    Parameters:
    
    end - exclusive
    
    Returns:
  - random
```
public float random(float end)
```
  - random
```
public double random(double end)
```
  - random
```
public long random(long end)
```
  - random
```
public int random(int start,
                  int end)
```
    get a random integer value between start to end *
    Example) #MESSAGE "You rolled the dice: "+random(1, 7)
    
    Parameters:
    
    start - inclusive
    
    end - exclusive
    
    Returns:
  - random
```
public float random(float start,
                    float end)
```
  - random
```
public double random(double start,
                     double end)
```
  - random
```
public long random(long start,
                   long end)
```
  - round
```
public String round(double val,
                    int decimal)
```
    get a string representing the input value rounded to the set decimal place
    Example) #MESSAGE "1.09 rounded to the nearest tenth is " + round(1.09,1)
    
    Parameters:
    
    val - the double to be rounded
    
    decimal - the decimal place to round to
    
    Returns:
    
    string representing rounded number
  - staticGetFieldValue
```
public Object staticGetFieldValue(String className,
                                  String fieldName)
                           throws ClassNotFoundException,
                                  NoSuchFieldException
```
    Try to get static value for specified field from specified class.
    
    Parameters:
    
    className - the full class name
    
    fieldName - the name of static field
    
    Returns:
    
    the value in the static field
    
    Throws:
    
    ClassNotFoundException - error if the specified 'className' does not exist
    
    NoSuchFieldException - error if the specified 'fieldName' field does not exist in the class.
  - staticSetFieldValue
```
public void staticSetFieldValue(String className,
                                String fieldName,
                                Object value)
                         throws ClassNotFoundException,
                                NoSuchFieldException,
                                IllegalArgumentException
```
    Try to set static value for specified field from specified class. This can lead any plugin to catastrpohic failuer if you don't what exactly you are doing. Use it with your own risk.
    
    Parameters:
    
    className - full name of the class
    
    fieldName - name of the static field
    
    value - the value to save into the field
    
    Throws:
    
    ClassNotFoundException - error if the specified 'className' does not exist
    
    NoSuchFieldException - error if the specified 'fieldName' field does not exist in the class.
    
    IllegalArgumentException - if the 'value' is incompatible with the field type.
  - staticMethod
```
public Object staticMethod(String className,
                           String methodName,
                           Object... args)
                    throws ClassNotFoundException,
                           NoSuchMethodException,
                           IllegalArgumentException,
                           IllegalAccessException
```
    Invoke the static method of provided class.
    
    Parameters:
    
    className - the full name of the class.
    
    methodName - the name of static method.
    
    args - array of arguments. This can be empty if the method doesn't have any arguments. (Ex. staticMethod("my.class", "PewPew")
    
    Returns:
    
    some value depends on the method; it can be null if the method returns nothing.
    
    Throws:
    
    ClassNotFoundException - error if the 'className' does not exist.
    
    NoSuchMethodException - error if the 'methodName' does not exist in the class.
    
    IllegalArgumentException - error if invalid 'args' are passed to the method.
    
    IllegalAccessException
  - parseEnum
```
public Object parseEnum(String enumClassName,
                        String valueName)
                 throws ClassNotFoundException
```
    Get enum value manually. Usually, you can simply pass String value to the Enum parameter, yet in some cases, you need to manually create enum value. For example, TriggerReactor cannot detect Generic argument, so you have to manually create enum value.
    Example) /trg run #MESSAGE "value is "+parseEnum("org.bukkit.GameMode", "CREATIVE")
    
    Example) /trg run player.setGameMode(parseEnum("org.bukkit.GameMode", "CREATIVE"))
    
    Example) /trg run player.setGameMode("CREATIVE") //This also works
    
    Parameters:
    
    enumClassName - the full class name of enum.
    
    valueName - the enum value to parse.
    
    Returns:
    
    the actual enum value.
    
    Throws:
    
    ClassNotFoundException - if the provided class name doesn't exist or not enum class.
  - slocation
```
public SimpleLocation slocation(String world,
                                int x,
                                int y,
                                int z)
```
  - newInstance
```
public Object newInstance(String className,
                          Object... args)
                   throws ClassNotFoundException,
                          NoSuchMethodException,
                          InstantiationException,
                          IllegalArgumentException,
                          InvocationTargetException
```
    Throws:
    
    ClassNotFoundException
    
    NoSuchMethodException
    
    InstantiationException
    
    IllegalArgumentException
    
    InvocationTargetException
  - matches
```
public boolean matches(String str,
                       String regex)
```
    matches the str by using regular expression regex
    Example) /trg run IF matches("PewPew", "[a-zA-Z0-9 ]+"); #MESSAGE "Seems to be English"; ENDIF;
    
    Parameters:
    
    str -
    
    regex -
    
    Returns:
    
    true if str matches with regex; false if not
  - parseInt
```
public int parseInt(String str)
```
    parse the string that contains integer into real integer value.
    Example) /trg run #MESSAGE parseInt("300") + 50
    
    Parameters:
    
    str - the string that contains integer
    
    Returns:
    
    the real integer
  - parseDouble
```
public double parseDouble(String str)
```
    parse the string that contains decimal into real decimal value.
    Example) /trg run #MESSAGE parseDouble("15.30") + 2.12
    
    Parameters:
    
    str - the string that contains decimal
    
    Returns:
    
    the real decimal
  - array
```
public Object[] array(int size)
```
    create an empty array
    Example) /trg run temp = array(5); temp[3] = "hi"; #MESSAGE temp[3];
    
    Parameters:
    
    size - size of array
    
    Returns:
  - arrayOf
```
public Object[] arrayOf(Object... values)
```
  - list
```
public List<Object> list()
```
  - listOf
```
public List<Object> listOf(Object... values)
```
  - map
```
public Map<Object,Object> map()
```
  - set
```
public Set<Object> set()
```
  - set
```
public Set<Object> set(Collection<?> iterable)
```
  - mergeArguments
```
public String mergeArguments(String[] args)
```
    Merge array of String. This is specifically useful for args variable of Command Trigger but not limited to.
    
    Parameters:
    
    args - array to merge
    
    Returns:
  - mergeArguments
```
public String mergeArguments(String[] args,
                             int indexFrom)
```
    Merge array of String. This is specifically useful for args variable of Command Trigger but not limited to.
    
    Parameters:
    
    args - array to merge
    
    indexFrom - inclusive
    
    Returns:
  - mergeArguments
```
public String mergeArguments(String[] args,
                             int indexFrom,
                             int indexTo)
```
    Merge array of String. This is specifically useful for args variable of Command Trigger but not limited to.
    
    Parameters:
    
    args - array to merge
    
    indexFrom - inclusive
    
    indexTo - inclusive
    
    Returns:
  - toByte
```
public byte toByte(Number number)
```
  - toShort
```
public short toShort(Number number)
```
  - toInt
```
public int toInt(Number number)
```
  - toLong
```
public long toLong(Number number)
```
  - toFloat
```
public float toFloat(Number number)
```
  - toDouble
```
public double toDouble(Number number)
```
  - sqrt
```
public double sqrt(int num)
```
  - formatCurrency
```
public String formatCurrency(double money,
                             String locale1,
                             String locale2)
```
    Translate money into specified country's currency format. You need to provide exact locale provided in http://www.oracle.com/technetwork/java/javase/java8locales-2095355.html
    
    Parameters:
    
    money -
    
    locale1 - language code (Ex. en)
    
    locale2 - country code (Ex. US)
    
    Returns:
    
    formatted currecy
  - formatCurrency
```
public String formatCurrency(double money)
```
    Translate money into specified country's currency format. US currency will be used.
    
    Parameters:
    
    money -
    
    Returns:
    
    formatted currecy
  - typeOf
```
public String typeOf(Object value,
                     boolean withFullPath)
```
    Return the name of the class that provided object was created by. if hasFullPath is set to true, this will return class name that contains full path. (Ex. org.bukkit.craftbukkit.v1_12_R1.entity.CraftPlayer)
    
    Parameters:
    
    value - the object to get its class name
    
    withFullPath - if true this returns class name containing full path
    
    Returns:
    
    source class of the object

Class CommonFunctions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CommonFunctions

Method Detail

random

random

random

random

random

random

random

random

round

staticGetFieldValue

staticSetFieldValue

staticMethod

parseEnum

slocation

newInstance

matches

parseInt

parseDouble

array

arrayOf

list

listOf

map

set

set

mergeArguments

mergeArguments

mergeArguments

toByte

toShort

toInt

toLong

toFloat

toDouble

sqrt

formatCurrency

formatCurrency

typeOf