org.ballerinalang.model.types

Class BMapType

java.lang.Object

org.ballerinalang.model.types.BType

org.ballerinalang.model.types.BMapType

All Implemented Interfaces:

BLangSymbol, BIndexedType

public class BMapType
extends BType
implements BIndexedType

BMapType represents a type of a map in Ballerina.

Maps are defined using the map keyword as follows: map mapName

All maps are unbounded in length and support key based indexing.

Since:

0.8.0

Field Summary

Fields inherited from class org.ballerinalang.model.types.BType

pkgPath, typeName, valueClass

Constructor Summary

Constructors

Constructor and Description
BMapType(BType constraint)
BMapType(String typeName, BType constraint, String pkgPath) Create a type from the given name.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
BType	getConstrainedType() Returns element types which this map is constrained to.
BType	getElementType() Deprecated. use getConstrainedType() instead.
<V extends BValue> V	getEmptyValue() Get the empty initialized value of this type.
TypeSignature	getSig()
int	getTag()
<V extends BValue> V	getZeroValue() Get the default value of the type.
String	toString()

Methods inherited from class org.ballerinalang.model.types.BType

getName, getPackagePath, getValueClass, hashCode, isNative, isPublic

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BMapType

public BMapType(String typeName,
                BType constraint,
                String pkgPath)

Create a type from the given name.

Parameters:

typeName - string name of the type.

constraint - constraint type which particular map is bound to.

pkgPath - package for the type.

BMapType

public BMapType(BType constraint)

Method Detail

getConstrainedType

public BType getConstrainedType()

Returns element types which this map is constrained to.

Returns:

constraint type.

getElementType

@Deprecated
public BType getElementType()

Deprecated. use getConstrainedType() instead.

Returns element type which this map contains.

Specified by:

getElementType in interface BIndexedType

Returns:

element type.

getZeroValue

public <V extends BValue> V getZeroValue()

Description copied from class: BType

Get the default value of the type. This is the value of an uninitialized variable of this type. For value types, this is same as the value get from BType#getInitValue().

Specified by:

getZeroValue in class BType

Type Parameters:

V - Type of the value

Returns:

Default value of the type

getEmptyValue

public <V extends BValue> V getEmptyValue()

Description copied from class: BType

Get the empty initialized value of this type. For reference types, this is the value of a variable, when initialized with the empty initializer. For value types, this is same as the default value (value get from BType#getDefaultValue()).

Specified by:

getEmptyValue in class BType

Type Parameters:

V - Type of the value

Returns:

Init value of this type

getSig

public TypeSignature getSig()

Specified by:

getSig in class BType

getTag

public int getTag()

Specified by:

getTag in class BType

toString

public String toString()

Overrides:

toString in class BType

equals

public boolean equals(Object obj)

Overrides:

equals in class BType