org.ballerinalang.model.values

Class BStruct

java.lang.Object

org.ballerinalang.model.values.BStruct

All Implemented Interfaces:

BRefType, BValue, LockableStructureType, StructureType

public final class BStruct
extends Object
implements BRefType, LockableStructureType

The BStruct represents the value of a user defined struct in Ballerina.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
BStruct(BStructType structType) Creates a struct with a single memory block.

Method Summary

Modifier and Type	Method and Description
void	addNativeData(String key, Object data) Add natively accessible data to a struct.
BValue	copy() Deep copy BValue.
byte[]	getBlobField(int index)
int	getBooleanField(int index)
double	getFloatField(int index)
long	getIntField(int index)
Object	getNativeData(String key) Get natively accessible data from struct.
BRefType	getRefField(int index)
String	getStringField(int index)
BStructType	getType()
boolean	lockBlobField(WorkerExecutionContext ctx, int index)
boolean	lockBooleanField(WorkerExecutionContext ctx, int index)
boolean	lockFloatField(WorkerExecutionContext ctx, int index)
boolean	lockIntField(WorkerExecutionContext ctx, int index)
boolean	lockRefField(WorkerExecutionContext ctx, int index)
boolean	lockStringField(WorkerExecutionContext ctx, int index)
void	setBlobField(int index, byte[] value)
void	setBooleanField(int index, int value)
void	setFloatField(int index, double value)
void	setIntField(int index, long value)
void	setRefField(int index, BRefType value)
void	setStringField(int index, String value)
String	stringValue()
String	toString()
void	unlockBlobField(int index)
void	unlockBooleanField(int index)
void	unlockFloatField(int index)
void	unlockIntField(int index)
void	unlockRefField(int index)
void	unlockStringField(int index)
BStruct	value()

Methods inherited from class java.lang.Object

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

Constructor Detail

BStruct

public BStruct(BStructType structType)

Creates a struct with a single memory block.

Parameters:

structType - type of the struct

Method Detail

value

public BStruct value()

Specified by:

value in interface BRefType

stringValue

public String stringValue()

Specified by:

stringValue in interface BValue

getType

public BStructType getType()

Specified by:

getType in interface BValue

getIntField

public long getIntField(int index)

Specified by:

getIntField in interface StructureType

setIntField

public void setIntField(int index,
                        long value)

Specified by:

setIntField in interface StructureType

getFloatField

public double getFloatField(int index)

Specified by:

getFloatField in interface StructureType

setFloatField

public void setFloatField(int index,
                          double value)

Specified by:

setFloatField in interface StructureType

getStringField

public String getStringField(int index)

Specified by:

getStringField in interface StructureType

setStringField

public void setStringField(int index,
                           String value)

Specified by:

setStringField in interface StructureType

getBooleanField

public int getBooleanField(int index)

Specified by:

getBooleanField in interface StructureType

getBlobField

public byte[] getBlobField(int index)

Specified by:

getBlobField in interface StructureType

setBlobField

public void setBlobField(int index,
                         byte[] value)

Specified by:

setBlobField in interface StructureType

setBooleanField

public void setBooleanField(int index,
                            int value)

Specified by:

setBooleanField in interface StructureType

getRefField

public BRefType getRefField(int index)

Specified by:

getRefField in interface StructureType

setRefField

public void setRefField(int index,
                        BRefType value)

Specified by:

setRefField in interface StructureType

lockIntField

public boolean lockIntField(WorkerExecutionContext ctx,
                            int index)

Specified by:

lockIntField in interface LockableStructureType

unlockIntField

public void unlockIntField(int index)

Specified by:

unlockIntField in interface LockableStructureType

lockFloatField

public boolean lockFloatField(WorkerExecutionContext ctx,
                              int index)

Specified by:

lockFloatField in interface LockableStructureType

unlockFloatField

public void unlockFloatField(int index)

Specified by:

unlockFloatField in interface LockableStructureType

lockStringField

public boolean lockStringField(WorkerExecutionContext ctx,
                               int index)

Specified by:

lockStringField in interface LockableStructureType

unlockStringField

public void unlockStringField(int index)

Specified by:

unlockStringField in interface LockableStructureType

lockBooleanField

public boolean lockBooleanField(WorkerExecutionContext ctx,
                                int index)

Specified by:

lockBooleanField in interface LockableStructureType

unlockBooleanField

public void unlockBooleanField(int index)

Specified by:

unlockBooleanField in interface LockableStructureType

lockBlobField

public boolean lockBlobField(WorkerExecutionContext ctx,
                             int index)

Specified by:

lockBlobField in interface LockableStructureType

unlockBlobField

public void unlockBlobField(int index)

Specified by:

unlockBlobField in interface LockableStructureType

lockRefField

public boolean lockRefField(WorkerExecutionContext ctx,
                            int index)

Specified by:

lockRefField in interface LockableStructureType

unlockRefField

public void unlockRefField(int index)

Specified by:

unlockRefField in interface LockableStructureType

copy

public BValue copy()

Description copied from interface: BValue

Deep copy BValue.

Specified by:

copy in interface BValue

Returns:

A copy of this BValue

addNativeData

public void addNativeData(String key,
                          Object data)

Add natively accessible data to a struct.

Parameters:

key - key to store data with

data - data to be stored

getNativeData

public Object getNativeData(String key)

Get natively accessible data from struct.

Parameters:

key - key by which data was stored

Returns:

data which was stored with given key or null if no value corresponding to key

toString

public String toString()

Overrides:

toString in class Object