ColdBox Platform Version 2.6.3

coldbox.system.util
Class BaseDictionary

WEB-INF.cftags.component
        extended by coldbox.system.util.BaseDictionary

public class BaseDictionary
extends WEB-INF.cftags.component

This is a base lookup dictionary


Constructor Summary
init([string name='BaseDictionary'], [struct dictionary='[runtime expression]'])
          Constructor
 
Method Summary
 void clearAll()
          Clear all the keys
 boolean clearKey(string key)
          Clear a key from the dictionary
 struct getDictionary()
          Get Dictionary
 any getKey(string key)
          Get a dictionary key, else return a blank
 string getname()
          Get dictionary name
 boolean keyExists(string key)
          Check if a key exists
 void setDictionary(struct Dictionary)
          Set Dictionary
 void setKey(string key, any value)
          Set a new key in the dictionary
 void setname(string name)
          Set dictionary name
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

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

Method Detail

clearAll

public void clearAll()
Clear all the keys


clearKey

public boolean clearKey(string key)
Clear a key from the dictionary

Parameters:
key - The key to remove

getDictionary

public struct getDictionary()
Get Dictionary


getKey

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

Parameters:
key - The key to return

getname

public string getname()
Get dictionary name


keyExists

public boolean keyExists(string key)
Check if a key exists

Parameters:
key - The key to return

setDictionary

public void setDictionary(struct Dictionary)
Set Dictionary

Parameters:
Dictionary

setKey

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

Parameters:
key - The key to return
value - The value of the key

setname

public void setname(string name)
Set dictionary name

Parameters:
name

ColdBox Platform Version 2.6.3