com.whitestein.lsps.stdlib.function

Class ObjectFunctions

java.lang.Object

com.whitestein.lsps.stdlib.function.ObjectFunctions

public class ObjectFunctions
extends java.lang.Object

Various utils.

Author:

bhl

Constructor Summary

Constructors

Constructor and Description
ObjectFunctions()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	cast(ExecutionContext ctx, java.lang.Object object, Type type) If the type of the object is compatible with the specified type, the function returns the object casted to the type.
java.lang.Object	clone(ExecutionContext ctx, java.lang.Object object) If the object is RecordHolder a copy is created otherwise the same object is returned.
java.lang.Object	error(ExecutionContext ctx, java.lang.String code) Throws an error with the specified code.
java.lang.Object	error(ExecutionContext ctx, java.lang.String code, java.lang.String message) Throws an error with the specified code.
java.lang.Object	ifNotNull(ExecutionContext ctx, java.lang.Object objToCheck, java.lang.String objToCheckName, java.lang.Object object) Returns object if the objToCheck is not Null.
java.lang.Boolean	isInstance(ExecutionContext ctx, java.lang.Object object, Type type) Returns True, if the specified object is assignment-compatible with (is kind of) type.
java.lang.Boolean	isSubtype(ExecutionContext ctx, Type subtype, Type supertype) Returns True, if sub type is a sub type of super type.
Type	typeOf(java.lang.Object object) Returns the type of object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectFunctions

public ObjectFunctions()

Method Detail

clone

public java.lang.Object clone(ExecutionContext ctx,
                              java.lang.Object object)

If the object is RecordHolder a copy is created otherwise the same object is returned.

Parameters:

ctx -

object -

Returns:

a clone of the object

ifNotNull

public java.lang.Object ifNotNull(ExecutionContext ctx,
                                  java.lang.Object objToCheck,
                                  java.lang.String objToCheckName,
                                  java.lang.Object object)
                           throws ErrorException

Returns object if the objToCheck is not Null. Otherwise, the function throws a runtime exception in which the objToCheckName is used to identify the object.

Parameters:

ctx -

objToCheck -

objToCheckName -

object -

Returns:

object if objToCheck is not null

Throws:

ErrorException

isSubtype

public java.lang.Boolean isSubtype(ExecutionContext ctx,
                                   Type subtype,
                                   Type supertype)
                            throws ErrorException

Returns True, if sub type is a sub type of super type.

Parameters:

ctx -

subtype -

supertype -

Returns:

True, if sub type is a sub type of super type.

Throws:

ErrorException

typeOf

public Type typeOf(java.lang.Object object)

Returns the type of object.

Parameters:

object -

Returns:

type of object.

isInstance

public java.lang.Boolean isInstance(ExecutionContext ctx,
                                    java.lang.Object object,
                                    Type type)
                             throws ErrorException

Returns True, if the specified object is assignment-compatible with (is kind of) type.

Parameters:

ctx -

object -

type -

Returns:

True, if the specified object is assignment-compatible with (is kind of) type.

Throws:

ErrorException

cast

public java.lang.Object cast(ExecutionContext ctx,
                             java.lang.Object object,
                             Type type)
                      throws ErrorException

If the type of the object is compatible with the specified type, the function returns the object casted to the type. If not possible, the function throws a runtime exception.

Parameters:

ctx -

object -

type -

Returns:

the object casted to the type. If not possible, the function throws a runtime exception

Throws:

ErrorException

error

public java.lang.Object error(ExecutionContext ctx,
                              java.lang.String code)
                       throws ErrorException

Throws an error with the specified code.

Parameters:

ctx -

code -

Returns:

nothing, always throw error exception

Throws:

ErrorException - always

error

public java.lang.Object error(ExecutionContext ctx,
                              java.lang.String code,
                              java.lang.String message)
                       throws ErrorException

Throws an error with the specified code.

Parameters:

ctx -

code -

message -

Returns:

nothing, always throw error exception

Throws:

ErrorException - always