Public Class IntegersCarrier

Properties Detail

• first (Get)

  Public Property Get first As Integer
  Gets the first element in the carrier

• hasContent (Get)

  Public Property Get hasContent As Boolean
  Flag indicating if the object has content

• JSON (Get)

  Public Property Get JSON As String
  JSON representation of the object

• last (Get)

  Public Property Get last As Integer
  Gets the last element in the carrier

• size (Get)

  Public Property Get size As Long
  Number of elements in the object

• unique (Get)

  Public Property Get unique As Variant
  Unique values carried by the object. Array of Integers containing the values of the object. If the object has no values then an array with a single empty Integer will be returned.

• values (Get)

  Public Property Get values As Variant
  Values carried by the object. Array of Integers containing the values of the object. If the object has no values then an array with a single empty Integer will be returned.

Methods Detail

• contains

  Public Function contains(source As Integer) As Boolean
  Flag indicating if the carrier contains a value
  idx	Argument	Data Type	Attributes	Comments
  1	source	Integer		value for which to check

• joinContent

  Public Function joinContent(delimiter As String) As Single
  Concatenates the content IN FIFO ORDER into a single Integer using specified delimiter.
  idx	Argument	Data Type	Attributes	Comments
  1	delimiter	String		delimiter to use for the concatenated content.

• pop

  Public Function pop() As Integer
  Gets the top (last added) object from the stack, then removes it from the stack.
  Throws Exceptions
  Message	Error Code	Comments
  MSG_OPERATION_PROHIBITED	1003	if called when the Carrier has no content

• writeToFile

  Public Function writeToFile(target As String) As Long
  Writes Contents of object to a Text File. IMPORTANT NOTE: Existing files will be OVERWRITTEN! It is up to the calling code to pre-check for existence of file.
  idx	Argument	Data Type	Attributes	Comments
  1	target	String		Filepath of file to be written.
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if target filepath is blank.
  MSG_OPERATION_FAILED	1000	or other file system exception on failure..

• yank

  Public Function yank(source As Integer) As Boolean
  Removes the first found instnace of an Integer (if it exists) from the carrier.
  idx	Argument	Data Type	Attributes	Comments
  1	source	Integer		Integer to be yanked from the object.

• clear

  Public Sub clear()
  Clears the carrier

• clearDuplicates

  Public Sub clearDuplicates()
  Clears duplicate elements from the object

• load

  Public Sub load(source As Variant)
  Loads the object with content from source
  idx	Argument	Data Type	Attributes	Comments
  1	source	Variant		IntegersCarrier OR Array of Integers.
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_INVALID	1195	if Source is not either a IntegersCarrier or an Array of Integers.

• New

  Public Sub New()

• push

  Public Sub push(source As Integer)
  Adds a Integer to the top of the carrier stack
  idx	Argument	Data Type	Attributes	Comments
  1	source	Integer

• sort

  Public Sub sort()
  Sorts the object's content in ascending order