org.ballerinalang.model.values

Class BMap<K,V extends BValue>

java.lang.Object

org.ballerinalang.runtime.message.BallerinaMessageDataSource

org.ballerinalang.model.values.BMap<K,V>

Type Parameters:

K - Key

V - Value

All Implemented Interfaces:

BCollection, BRefType, BValue, MessageDataSource

public class BMap<K,V extends BValue>
extends BallerinaMessageDataSource
implements BRefType, BCollection

MapType represents a map.

Since:

0.8.0

Constructor Summary

Constructors

Constructor and Description
BMap()
BMap(BMapType type)

Method Summary

Modifier and Type	Method and Description
void	clear() Clear map entries.
BValue	copy() Deep copy BValue.
V	get(K key) Retrieve the value for the given key from map.
LinkedHashMap<K,V>	getMap() Retrieve the internal map.
String	getMessageAsString() Returns the entire message as string.
BType	getType()
boolean	hasKey(K key) Check existence of a key of a map.
boolean	isEmpty() Return true if this map is empty.
Set<K>	keySet() Retrieve the set of keys related to this map.
BIterator	newIterator() Create new Iterator for this collection.
void	put(K key, V value) Insert a key value pair into the map.
boolean	remove(K key) Remove an item from the map.
void	serializeData(OutputStream outputStream) Serialize data in to a byte stream.
int	size() Get the size of the map.
String	stringValue()
Object	value()

Methods inherited from class org.ballerinalang.runtime.message.BallerinaMessageDataSource

clone, getContentType, getDataObject, getValue, getValueAsString, getValueAsString, setContentType

Methods inherited from class java.lang.Object

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

Constructor Detail

BMap

public BMap()

BMap

public BMap(BMapType type)

Method Detail

get

public V get(K key)

Retrieve the value for the given key from map.

Parameters:

key - key used to get the value

Returns:

value

put

public void put(K key,
                V value)

Insert a key value pair into the map.

Parameters:

key - key related to the value

value - value related to the key

clear

public void clear()

Clear map entries.

hasKey

public boolean hasKey(K key)

Check existence of a key of a map.

Parameters:

key - key of the map item

Returns:

returns boolean true if key exists

getMap

public LinkedHashMap<K,V> getMap()

Retrieve the internal map.

Returns:

map

size

public int size()

Get the size of the map.

Returns:

returns the size of the map

remove

public boolean remove(K key)

Remove an item from the map.

Parameters:

key - key of the item to be removed

Returns:

boolean to indicate whether given key is removed.

keySet

public Set<K> keySet()

Retrieve the set of keys related to this map.

Returns:

returns the set of keys

isEmpty

public boolean isEmpty()

Return true if this map is empty.

Returns:

Flag indicating whether the map is empty or not

value

public Object value()

Specified by:

value in interface BRefType

stringValue

public String stringValue()

Specified by:

stringValue in interface BValue

getType

public BType getType()

Specified by:

getType in interface BValue

copy

public BValue copy()

Description copied from interface: BValue

Deep copy BValue.

Specified by:

copy in interface BValue

Returns:

A copy of this BValue

getMessageAsString

public String getMessageAsString()

Description copied from interface: MessageDataSource

Returns the entire message as string.

Specified by:

getMessageAsString in interface MessageDataSource

Overrides:

getMessageAsString in class BallerinaMessageDataSource

Returns:

message

serializeData

public void serializeData(OutputStream outputStream)

Description copied from interface: MessageDataSource

Serialize data in to a byte stream.

Specified by:

serializeData in interface MessageDataSource

Overrides:

serializeData in class BallerinaMessageDataSource

newIterator

public BIterator newIterator()

Description copied from interface: BCollection

Create new Iterator for this collection.

Specified by:

newIterator in interface BCollection

Returns:

iterator created.