Package ortus.boxlang.runtime.bifs.global.array

Class ArrayUnshift

java.lang.Object

ortus.boxlang.runtime.bifs.BIF

ortus.boxlang.runtime.bifs.global.array.ArrayUnshift

@BoxBIF
@BoxMember(type=ARRAY)
public class ArrayUnshift
extends BIF

Field Summary

Fields inherited from class ortus.boxlang.runtime.bifs.BIF

__functionName, __isMemberExecution, asyncService, cacheService, componentService, declaredArguments, functionService, interceptorService, logger, moduleService, runtime, schedulerService

Constructor Summary

Constructors

Constructor	Description
ArrayUnshift()	Constructor

Method Summary

Modifier and Type	Method	Description
Object	_invoke(IBoxContext context, ArgumentsScope arguments)	This function adds one or more elements to the beginning of the original array and returns the length of the modified array.

Methods inherited from class ortus.boxlang.runtime.bifs.BIF

announce, getDeclaredArguments, invoke

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ArrayUnshift

public ArrayUnshift()

Constructor

Method Details

_invoke

public Object _invoke(IBoxContext context,
 ArgumentsScope arguments)

This function adds one or more elements to the beginning of the original array and returns the length of the modified array.

Specified by:

_invoke in class BIF

Parameters:

context - The context in which the BIF is being invoked.

arguments - Argument scope for the BIF.

Returns:

The result of the invocation