Callable

box.system.core.collections.concurrent.Callable interface">

Callable Overview

Class

ColdBox Platform Version 3.1.0

FRAMES

coldbox.system.core.collections
Class BaseDictionary

WEB-INF.cftags.component
        coldbox.system.core.collections.BaseDictionary

public class BaseDictionary
extends WEB-INF.cftags.component
extends WEB-INF.cftags.component

This is a base lookup dictionary

Constructor Summary

init([any name='BaseDictionary'], [any dictionary='[runtime expression]'])
          Constructor

Method Summary

void clearAll()
          Clear all the keys

any clearKey(string key)
          Clear a key from the dictionary, returns true or false if removed

any getDictionary()
          Get Dictionary as struct

any getKey(any key)
          Get a dictionary key, else return a blank

any getName()
          Get dictionary name

any keyExists(any key)
          Check if a key exists: Boolean

void setDictionary(any dictionary)
          Set Dictionary

void setKey(any key, any value)
          Set a new key in the dictionary

void setName(any name)
          Set dictionary name

Methods inherited from class WEB-INF.cftags.component

Constructor Summary
`init([any name='BaseDictionary'], [any dictionary='[runtime expression]'])` Constructor

Method Summary
`void`	`clearAll()` Clear all the keys
`any`	`clearKey(string key)` Clear a key from the dictionary, returns true or false if removed
`any`	`getDictionary()` Get Dictionary as struct
`any`	`getKey(any key)` Get a dictionary key, else return a blank
`any`	`getName()` Get dictionary name
`any`	`keyExists(any key)` Check if a key exists: Boolean
`void`	`setDictionary(any dictionary)` Set Dictionary
`void`	`setKey(any key, any value)` Set a new key in the dictionary
`void`	`setName(any name)` Set dictionary name

Constructor Detail

init

public init([any name='BaseDictionary'], [any dictionary='[runtime expression]'])

Constructor

Parameters:: name - The dictionary name; dictionary - The default dictionary [struct]

Method Detail

clearAll

public void clearAll()

Clear all the keys

clearKey

public any clearKey(string key)

Clear a key from the dictionary, returns true or false if removed

getDictionary

public any getDictionary()

Get Dictionary as struct

getKey

public any getKey(any key)

Get a dictionary key, else return a blank

getName

public any getName()

Get dictionary name

keyExists

public any keyExists(any key)

Check if a key exists: Boolean

setDictionary

public void setDictionary(any dictionary)

Set Dictionary

setKey

public void setKey(any key, any value)

Set a new key in the dictionary

setName

public void setName(any name)

Set dictionary name

Overview

Package