Gambas Documentation
Application Repository
Code Snippets
Compilation & Installation
Components
gb
*[]
.Array.Bounds
.Stat.Perm
.Stream.Lines
.Stream.Term
.Symbol
_BoxedString
Application
Args
Array
Boolean[]
Byte[]
Class
Classes
Collection
_get
_new
_next
_put
Add
Clear
Copy
Count
Default
Empty
Exist
First
Key
Keys
Last
Length
Remove
Component
Components
Date[]
Enum
Env
Error
File
Float[]
gb
Integer[]
Jit
Long[]
Object
Object[]
Observer
Param
Pointer[]
Process
Short[]
Single[]
Stat
Stream
String
String[]
System
Task
Timer
User
Variant[]
gb.args
gb.cairo
gb.chart
gb.clipper
gb.complex
gb.compress
gb.crypt
gb.data
gb.db
gb.db.form
gb.db.mysql
gb.db.odbc
gb.db.postgresql
gb.db.sqlite2
gb.db.sqlite3
gb.dbus
gb.dbus.trayicon
gb.debug
gb.desktop
gb.desktop.gnome.keyring
gb.desktop.x11
gb.eval
gb.eval.highlight
gb.form
gb.form.dialog
gb.form.editor
gb.form.htmlview
gb.form.mdi
gb.form.print
gb.form.stock
gb.form.terminal
gb.gmp
gb.gsl
gb.gtk
gb.gtk.opengl
gb.gtk3
gb.gtk3.opengl
gb.gtk3.webview
gb.gui
gb.gui.opengl
gb.gui.qt
gb.gui.qt.ext
gb.gui.qt.opengl
gb.gui.qt.webkit
gb.gui.trayicon
gb.gui.webview
gb.hash
gb.highlight
gb.image
gb.image.effect
gb.image.imlib
gb.image.io
gb.inotify
gb.jit
gb.libxml
gb.logging
gb.map
gb.markdown
gb.media
gb.media.form
gb.memcached
gb.mime
gb.mysql
gb.ncurses
gb.net
gb.net.curl
gb.net.pop3
gb.net.smtp
gb.openal
gb.opengl
gb.opengl.glsl
gb.opengl.glu
gb.opengl.sge
gb.openssl
gb.option
gb.pcre
gb.pdf
gb.poppler
gb.qt4
gb.qt4.ext
gb.qt4.opengl
gb.qt4.webkit
gb.qt4.webview
gb.qt5
gb.qt5.ext
gb.qt5.opengl
gb.qt5.webkit
gb.qt5.webview
gb.qt6
gb.qt6.ext
gb.qt6.opengl
gb.qt6.webview
gb.report
gb.report2
gb.scanner
gb.sdl
gb.sdl.sound
gb.sdl2
gb.sdl2.audio
gb.settings
gb.signal
gb.term
gb.test
gb.util
gb.util.web
gb.v4l
gb.vb
gb.web
gb.web.feed
gb.web.form
gb.web.gui
gb.xml
gb.xml.html
gb.xml.rpc
gb.xml.xslt
Controls pictures
Deprecated components
Developer Documentation
Development Environment Documentation
Documents
Error Messages
Gambas Playground
How To's
Language Index
Language Overviews
Last Changes
Lexicon
README
Search the wiki
To Do
Topics
Tutorials
Wiki License
Wiki Manual

Collection (gb)

This class implements an hash table whose keys are String and values are Variant.

NULL is used when nothing is associated with a given key. Consequently, associating NULL with a key is the same thing as removing it from the collection.

The size of the internal hash table grows dynamically as data is inserted.

This class is creatable.

This class acts like a read / write array.

This class is enumerable with the FOR EACH keyword.

Properties
Count   Returns the number of elements stored in the collection.
Default   Return or set the collection default value that is returned when no value is associated with a key.
Empty   Return if the collection is empty.
First   Returns the key of the first element inserted in the collection, or NULL if the collection is void.
Key   Returns the key of the last read or last enumerated element.
Keys   Return a string array of all collection keys.
Last   Returns the key of the last element inserted in the collection, or NULL if the collection is void.
Length   Returns the number of elements stored in the collection.

Methods
Add   Adds an element to the collection.
Clear   Clears the collection.
Copy   Returns a copy of the collection.
Exist   Returns if something is associated with this key in the collection.
Remove   Removes an element from the collection.

Example

PUBLIC SUB Main()

  DIM cAbbr2Weekday AS Collection = ["mo": "Monday", "tu": "Tuesday", "we": "Wednesday", "th": "Thursday", "fr": "Friday", "sa": "Saturday", "su": "Sunday"]
  DIM cCopy AS Collection
  DIM sAbbr AS String
  
  ' To access the data
  PRINT cAbbr2Weekday["fr"]
  
  ' Print mapping key to value
  FOR EACH sAbbr IN cAbbr2Weekday
    PRINT cAbbr2Weekday.Key & " --> " & sAbbr
  NEXT

  ' Lenght/Count return both 7
  PRINT cAbbr2Weekday.Count
  PRINT cAbbr2Weekday.Length

  ' Add element and remove it again
  cAbbr2Weekday.Add("sat", "Saturday")
  cAbbr2Weekday.Remove("sat")
  
  ' Test if a key is present
  PRINT cAbbr2Weekday.Exist("we")
  
  ' Make a copy and clear the original collection
  cCopy = cAbbr2Weekday.Copy()
  cAbbr2Weekday.Clear()

END