Predefined (Golo Programming Language 2.1.0 API)

java.lang.Object
- gololang.Predefined

```
public final class Predefined
extends Object
```
Predefined provides the module of predefined functions in Golo. The provided module is imported by default.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Object`	`aget(Object a, Object i)` Deprecated.
`static Object`	`alength(Object a)` Deprecated.
`static Object`	`Array(Object... values)` Deprecated.
`static Class<?>`	`arrayTypeOf(Object klass)` Returns an array class given a type class.
`static void`	`aset(Object a, Object i, Object value)` Deprecated.
`static Object`	`asInterfaceInstance(Object interfaceClass, Object target)` Turns a method handle into a instance of a single-method interface.
`static Object`	`atoList(Object[] values)` Deprecated.
`static Object`	`charValue(Object obj)` Gives the Character value of some number or String object.
`static String`	`currentDir()` Return current path of execution.
`static Object`	`doubleValue(Object obj)` Gives the Double value of some number or String object.
`static boolean`	`fileExists(Object file)` Check if a file exists.
`static Object`	`fileToText(Object file, Object encoding)` Reads the content of a text file.
`static Object`	`floatValue(Object obj)` Gives the Float value of some number or String object.
`static Object`	`fun(Object name, Object module)` Obtains the first method handle / closure to a function.
`static Object`	`fun(Object name, Object module, Object arity)` Obtains a method handle / closure to a function.
`static Object`	`intValue(Object obj)` Gives the Integer value of some number or String object.
`static boolean`	`isArray(Object object)` Checks if an object is a (JVM) array or not.
`static Object`	`isClosure(Object object)` Test whether an object is a closure or not.
`static Object`	`longValue(Object obj)` Gives the Long value of some number or String object.
`static Object`	`mapEntry(Object key, Object value)` Makes a key / value pair.
`static Object`	`newTypedArray(Class<?> type, int length)` Makes a new typed JVM array.
`static Class<?>`	`objectArrayType()` Function to obtain the `Object[].class` reference.
`static void`	`print(Object obj)` Prints to the standard console.
`static void`	`println(Object obj)` Prints to the standard console, including a newline.
`static void`	`raise(Object message)` Raises a `RuntimeException` with a message.
`static void`	`raise(Object message, Object cause)` Raises a `RuntimeException` with a message and a cause.
`static Object`	`range(Object to)` Makes an range object starting from the default value.
`static Object`	`range(Object from, Object to)` Makes an range object between two bounds.
`static String`	`readln()` Reads the next line of characters from the console.
`static String`	`readln(String message)` Reads the next line of characters from the console.
`static String`	`readPassword()` Reads a password from the console with echoing disabled.
`static String`	`readPassword(String message)` Reads a password from the console with echoing disabled.
`static void`	`require(Object condition, Object errorMessage)` Requires that a condition be `true`.
`static void`	`requireNotNull(Object obj)` Requires that an object is not the `null` reference.
`static Object`	`reversed_range(Object from)` Makes an decreasing range object up to the default value.
`static Object`	`reversed_range(Object from, Object to)` Makes an decreasing range object between two bounds.
`static char[]`	`secureReadPassword()` Reads a password from the console with echoing disabled, returning an `char[]` array.
`static char[]`	`secureReadPassword(String message)` Reads a password from the console with echoing disabled, returning an `char[]` array.
`static void`	`sleep(long ms)` Return current path of execution.
`static void`	`textToFile(Object text, Object file)` Writes some text to a file.
`static String`	`uuid()` Return a universally unique identifier as String.

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

- Method Detail
  - raise
```
public static void raise(Object message)
```
    Raises a RuntimeException with a message.
    
    Parameters:
    
    message - the exception description.
    
    Throws:
    
    RuntimeException - (always)
  - raise
```
public static void raise(Object message,
                         Object cause)
```
    Raises a RuntimeException with a message and a cause.
    
    Parameters:
    
    message - the exception description.
    
    cause - the exception cause.
    
    Throws:
    
    RuntimeException - (always)
  - print
```
public static void print(Object obj)
```
    Prints to the standard console.
    
    Parameters:
    
    obj - the object to be printed.
  - println
```
public static void println(Object obj)
```
    Prints to the standard console, including a newline.
    
    Parameters:
    
    obj - obj the object to be printed.
  - readln
```
public static String readln()
                     throws IOException
```
    Reads the next line of characters from the console.
    
    Returns:
    
    a String.
    
    Throws:
    
    IOException
  - readln
```
public static String readln(String message)
                     throws IOException
```
    Reads the next line of characters from the console.
    
    Parameters:
    
    message - displays a prompt message.
    
    Returns:
    
    a String.
    
    Throws:
    
    IOException
  - readPassword
```
public static String readPassword()
                           throws IOException
```
    Reads a password from the console with echoing disabled.
    
    Returns:
    
    a String.
    
    Throws:
    
    IOException
  - readPassword
```
public static String readPassword(String message)
                           throws IOException
```
    Reads a password from the console with echoing disabled.
    
    Parameters:
    
    message - displays a prompt message.
    
    Returns:
    
    a String.
    
    Throws:
    
    IOException
  - secureReadPassword
```
public static char[] secureReadPassword()
                                 throws IOException
```
    Reads a password from the console with echoing disabled, returning an char[] array.
    
    Returns:
    
    a character array.
    
    Throws:
    
    IOException
  - secureReadPassword
```
public static char[] secureReadPassword(String message)
                                 throws IOException
```
    Reads a password from the console with echoing disabled, returning an char[] array.
    
    Parameters:
    
    message - displays a prompt message.
    
    Returns:
    
    a character array.
    
    Throws:
    
    IOException
  - requireNotNull
```
public static void requireNotNull(Object obj)
                           throws AssertionError
```
    Requires that an object is not the null reference.
    
    Parameters:
    
    obj - the object to test against null.
    
    Throws:
    
    AssertionError - if obj is null.
  - require
```
public static void require(Object condition,
                           Object errorMessage)
                    throws IllegalArgumentException,
                           AssertionError
```
    Requires that a condition be true.
    
    Parameters:
    
    condition - the condition, must be a Boolean.
    
    errorMessage - the error message, must be a String.
    
    Throws:
    
    IllegalArgumentException - if the arguments are of the wrong type.
    
    AssertionError - if condition is false.
  - newTypedArray
```
public static Object newTypedArray(Class<?> type,
                                   int length)
```
    Makes a new typed JVM array. This function simply forwards to java.lang.reflect.Array.newInstance.
    
    Parameters:
    
    type - the array type.
    
    length - the array length.
    
    Returns:
    
    a new typed array.
  - Array
```
@Deprecated
public static Object Array(Object... values)
```
    Deprecated.
    
    Makes a Java primitive array out of values.
    
    Parameters:
    
    values - the values.
    
    Returns:
    
    an array.
  - atoList
```
@Deprecated
public static Object atoList(Object[] values)
```
    Deprecated.
    
    Makes a list out of a Java primitive array.
    
    Parameters:
    
    values - the array.
    
    Returns:
    
    a list from the java.util package.
  - aget
```
@Deprecated
public static Object aget(Object a,
                                      Object i)
```
    Deprecated.
    
    Access an array element by index.
    
    Parameters:
    
    a - the array.
    
    i - the index.
    
    Returns:
    
    the element at index i.
  - aset
```
@Deprecated
public static void aset(Object a,
                                    Object i,
                                    Object value)
```
    Deprecated.
    
    Updates an array element by index.
    
    Parameters:
    
    a - the array.
    
    i - the index.
    
    value - the new value.
  - alength
```
@Deprecated
public static Object alength(Object a)
```
    Deprecated.
    
    Array length.
    
    Parameters:
    
    a - the array.
    
    Returns:
    
    the length of a.
  - range
```
public static Object range(Object from,
                           Object to)
```
    Makes an range object between two bounds. Range objects implement java.lang.Collection (immutable), so they can be used in Golo foreach loops.
    
    Parameters:
    
    from - the lower-bound (inclusive) as an Integer, Long, or Character.
    
    to - the upper-bound (exclusive) as an Integer, Long or Character
    
    Returns:
    
    a range object.
    
    See Also:
    
    Collection
  - range
```
public static Object range(Object to)
```
    Makes an range object starting from the default value.
    The default value is 0 for numbers and 'A' for chars.
    
    Parameters:
    
    to - the upper-bound (exclusive) as an Integer or Long.
    
    Returns:
    
    a range object.
    
    See Also:
    
    gololang.Predefined.range
  - reversed_range
```
public static Object reversed_range(Object from,
                                    Object to)
```
    Makes an decreasing range object between two bounds. Range objects implement java.lang.Collection, so they can be used in Golo foreach loops.
    
    Parameters:
    
    from - the upper-bound (inclusive) as an Integer, Long or Character.
    
    to - the lower-bound (exclusive) as an Integer, Long or Character.
    
    Returns:
    
    a range object.
    
    See Also:
    
    gololang.Predefined.range
  - reversed_range
```
public static Object reversed_range(Object from)
```
    Makes an decreasing range object up to the default value.
    The default value is 0 for numbers and 'A' for chars.
    
    Parameters:
    
    from - the upper-bound (inclusive) as an Integer, Long or Character.
    
    Returns:
    
    a range object.
    
    See Also:
    
    gololang.Predefined.reversed_range, gololang.Predefined.range
  - mapEntry
```
public static Object mapEntry(Object key,
                              Object value)
```
    Makes a key / value pair.
    
    Parameters:
    
    key - the key.
    
    value - the value.
    
    Returns:
    
    an instance of AbstractMap.SimpleEntry
    
    See Also:
    
    AbstractMap.SimpleEntry
  - asInterfaceInstance
```
public static Object asInterfaceInstance(Object interfaceClass,
                                         Object target)
```
    Turns a method handle into a instance of a single-method interface.
    
    Parameters:
    
    interfaceClass - the target single-method interface class.
    
    target - the implementation method handle.
    
    Returns:
    
    an instance of interfaceClass.
    
    See Also:
    
    MethodHandleProxies.asInterfaceInstance(Class, java.lang.invoke.MethodHandle)
  - isClosure
```
public static Object isClosure(Object object)
```
    Test whether an object is a closure or not.
    
    Parameters:
    
    object - the object.
    
    Returns:
    
    true if object is an instance of java.lang.invoke.MethodHandle, false otherwise.
  - fun
```
public static Object fun(Object name,
                         Object module,
                         Object arity)
                  throws Throwable
```
    Obtains a method handle / closure to a function.
    
    Parameters:
    
    name - the function name.
    
    module - the function enclosing module (a Java class).
    
    arity - the function arity, where a negative value means that any arity will do.
    
    Returns:
    
    a method handle to the matched function.
    
    Throws:
    
    NoSuchMethodException - if the target function could not be found.
    
    IllegalArgumentException - if the argument types are not of types (String, Class, Integer).
    
    Throwable - if an error occurs.
  - fun
```
public static Object fun(Object name,
                         Object module)
                  throws Throwable
```
    Obtains the first method handle / closure to a function.
    This is the same as calling fun(name, module, -1).
    
    Throws:
    
    Throwable
    
    See Also:
    
    fun(Object, Object, Object)
  - fileToText
```
public static Object fileToText(Object file,
                                Object encoding)
                         throws Throwable
```
    Reads the content of a text file.
    
    Parameters:
    
    file - the file to read from as an instance of either String, File or Path.
    
    encoding - the file encoding as a String or Charset.
    
    Returns:
    
    the content as a String.
    
    Throws:
    
    Throwable
  - textToFile
```
public static void textToFile(Object text,
                              Object file)
                       throws Throwable
```
    Writes some text to a file. The file is created if it does not exist, and overwritten if it already exists.
    
    Parameters:
    
    text - the text to write.
    
    file - the file to write to as an instance of either String, File or Path.
    
    Throws:
    
    Throwable
  - fileExists
```
public static boolean fileExists(Object file)
```
    Check if a file exists.
    
    Parameters:
    
    file - the file to read from as an instance of either String, File or Path.
    
    Returns:
    
    true if the file exists, false if it doesn't
  - currentDir
```
public static String currentDir()
                         throws Throwable
```
    Return current path of execution.
    
    Returns:
    
    current path of execution
    
    Throws:
    
    Throwable
  - sleep
```
public static void sleep(long ms)
                  throws InterruptedException
```
    Return current path of execution.
    
    Throws:
    
    InterruptedException
  - uuid
```
public static String uuid()
```
    Return a universally unique identifier as String.
    
    Returns:
    
    a universally unique identifier as String
  - isArray
```
public static boolean isArray(Object object)
```
    Checks if an object is a (JVM) array or not.
    
    Parameters:
    
    object - the object to check.
    
    Returns:
    
    true if object is an array, false otherwise or if null.
  - objectArrayType
```
public static Class<?> objectArrayType()
```
    Function to obtain the Object[].class reference.
    
    Returns:
    
    Object[].class
  - arrayTypeOf
```
public static Class<?> arrayTypeOf(Object klass)
                            throws ClassNotFoundException
```
    Returns an array class given a type class.
    
    Parameters:
    
    klass - the array type.
    
    Returns:
    
    the class of the array of type klass, i.e., klass[].
    
    Throws:
    
    ClassNotFoundException - if the type could not be found.
  - charValue
```
public static Object charValue(Object obj)
                        throws IllegalArgumentException
```
    Gives the Character value of some number or String object.
    
    Parameters:
    
    obj - a boxed number or String value.
    
    Returns:
    
    the Character value.
    
    Throws:
    
    IllegalArgumentException - if obj is not a number or a String.
  - intValue
```
public static Object intValue(Object obj)
                       throws IllegalArgumentException
```
    Gives the Integer value of some number or String object.
    
    Parameters:
    
    obj - a boxed number or String value.
    
    Returns:
    
    the Integer value.
    
    Throws:
    
    IllegalArgumentException - if obj is not a number or a String.
  - longValue
```
public static Object longValue(Object obj)
                        throws IllegalArgumentException
```
    Gives the Long value of some number or String object.
    
    Parameters:
    
    obj - a boxed number or String value.
    
    Returns:
    
    the Long value.
    
    Throws:
    
    IllegalArgumentException - if obj is not a number or a String.
  - doubleValue
```
public static Object doubleValue(Object obj)
                          throws IllegalArgumentException
```
    Gives the Double value of some number or String object.
    
    Parameters:
    
    obj - a boxed number or String value.
    
    Returns:
    
    the Double value.
    
    Throws:
    
    IllegalArgumentException - if obj is not a number or a String.
  - floatValue
```
public static Object floatValue(Object obj)
                         throws IllegalArgumentException
```
    Gives the Float value of some number or String object.
    
    Parameters:
    
    obj - a boxed number or String value.
    
    Returns:
    
    the Float value.
    
    Throws:
    
    IllegalArgumentException - if obj is not a number or a String.

Class Predefined

Method Summary

Methods inherited from class java.lang.Object

Method Detail

raise

raise

print

println

readln

readln

readPassword

readPassword

secureReadPassword

secureReadPassword

requireNotNull

require

newTypedArray

Array

atoList

aget

aset

alength

range

range

reversed_range

reversed_range

mapEntry

asInterfaceInstance

isClosure

fun

fun

fileToText

textToFile

fileExists

currentDir

sleep

uuid

isArray

objectArrayType

arrayTypeOf

charValue

intValue

longValue

doubleValue

floatValue