CreateObject

Creates a new object representation according to the {@code type} and {@code className} arguments.

Available types are:

class/component - Creates a new instance of a BoxLang class (Default if not used)
java - Creates a new instance of a Java class
{anything} - Passes the request to the {@code BoxEvent.ON_CREATEOBJECT_REQUEST} event for further processing

If the type requested is not supported, then it passes to an interception call to the {@code BoxEvent.ON_CREATEOBJECT_REQUEST} event, so any listeners can contribute to the object creation request (if any). If there are no listeners, an exception is thrown.

You can also target an explicit class from a loaded BoxLang module by using the {@code @moduleName} suffix. Example: {@code createObject( 'class', 'class.name.path@module' )}

The properties is an optional argument that can be used to pass to the object creation process according to the type.

class/component - The properties are not used
java - The properties can be a single or an array of absolute path(s) to a directory containing Jars/Classes, or absolute path(s) to specific Jars/Classes to classload
{anything} - The properties can be any object that the listener can use to create the object

IMPORTANT: This does NOT create an instance of the class, for that you will need to call the {@code init()} method on the returned object.

Method Signature

CreateObject(type=[string], className=[string], properties=[any])

Arguments

Argument

Type

Required

Description

Default

type

string

false

The type of object to create: java, class (component), or any other type

class

className

string

false

A fully qualified class name to create an instance of

properties

any

false

Depending on the type, this can be used to pass additional properties to the object creation process

Examples

Create a BX / Component Instance

createObject Component

<bx:script>
	tellTimeClass = createObject( "component", "appResources.components.tellTime" );
	tellTimeClass.getLocalTime();
</bx:script>

Create a SOAP WebService Instance

createObject WebService

<bx:script>
	ws = createObject( "webservice", "http://www.xmethods.net/sd/2001/TemperatureService.wsdl" );
	xlatstring = ws.getTemp( zipcode="55987" );
	writeOutput( "The temperature at 55987 is " & xlatstring );
</bx:script>

Create a java class with specified bundle and version

createObject filesystem

POIFSFileSystem = createObject( "java", "org.apache.poi.poifs.filesystem.POIFSFileSystem", "apache.poi", "3.11.0" );

Additional Examples

Run Example

dump( label="CreateObject in java", var=createObject( "java", "java.util.HashMap" ) );
dump( label="CreateObject with init()", var=createObject( "java", "java.lang.StringBuffer" ).init() );

dump( var=createObject( "class", "com.my.bx.class" ), expand=false );
// but even "class" is optional for bx
dump( var=createObject( "com.my.bx.class" ), expand=false );
// the modern new Object() syntax is also dynamic
dump( var=new "com.my.bx.class"(), expand=false );
dump( var=new com.my.bx.class(), expand=false );
myClass = "com.my.bx.class";
dump( var=new "#myClass#"(), expand=false );

PreviousCreateGUID NextCreateUUID

Last updated 21 days ago

Was this helpful?

Method Signature

Arguments

Examples

Create a BX / Component Instance

Create a SOAP WebService Instance

Create a java class with specified bundle and version

Additional Examples

Related