Collection

java.lang.Object
- com.madara.MadaraJNI
- - com.madara.containers.BaseContainer
  - - com.madara.containers.Collection

```
public class Collection
extends BaseContainer
```
A facade for a collection of knowledge base containers

Constructor Summary

Constructors
Constructor and Description

Collection()
Default constructor

Collection(Collection input)
Copy constructor

Constructors
Constructor and Description
`Collection()` Default constructor
`Collection(Collection input)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Barrier container)` Adds a Barrier container to the collection
`void`	`add(Counter container)` Adds a Counter container to the collection
`void`	`add(Double container)` Adds a Double container to the collection
`void`	`add(DoubleVector container)` Adds a DoubleVector container to the collection
`void`	`add(FlexMap container)` Adds a FlexMap container to the collection
`void`	`add(Integer container)` Adds a Integer container to the collection
`void`	`add(IntegerVector container)` Adds a IntegerVector container to the collection
`void`	`add(Map container)` Adds a Map container to the collection
`void`	`add(NativeDoubleVector container)` Adds a NativeDoubleVector container to the collection
`void`	`add(NativeIntegerVector container)` Adds a NativeIntegerVector container to the collection
`void`	`add(String container)` Adds a String container to the collection
`void`	`add(StringVector container)` Adds a StringVector container to the collection
`void`	`add(Vector container)` Adds a Vector container to the collection
`protected void`	`finalize()` Cleans up underlying C resources
`void`	`free()` Deletes the C instantiation.
`static Collection`	`fromPointer(long cptr)` Creates a java object instance from a C/C++ pointer
`static Collection`	`fromPointer(long cptr, boolean shouldManage)` Creates a java object instance from a C/C++ pointer
`java.lang.String`	`getDebugInfo()` Reads all debug info for the collection into a string
`boolean`	`isFalse()` Returns true if the container evaluates to false
`boolean`	`isTrue()` Returns true if the container evaluates to true
`void`	`modify()` Mark the value as modified.
`void`	`setSettings(UpdateSettings settings)` Sets the settings for updating variables in the Knowledge Base
`java.lang.String`	`toString()` Reads all debug info for the collection into a string

Methods inherited from class com.madara.containers.BaseContainer
modifyIfFalse, modifyIfTrue

Methods inherited from class com.madara.MadaraJNI
getCPtr, setCPtr

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Collection
```
public Collection()
```
    Default constructor
  - Collection
```
public Collection(Collection input)
```
    Copy constructor
    
    Parameters:
    
    input - instance to copy
- Method Detail
  - fromPointer
```
public static Collection fromPointer(long cptr)
```
    Creates a java object instance from a C/C++ pointer
    
    Parameters:
    
    cptr - C pointer to the object
    
    Returns:
    
    a new java instance of the underlying pointer
  - fromPointer
```
public static Collection fromPointer(long cptr,
                                     boolean shouldManage)
```
    Creates a java object instance from a C/C++ pointer
    
    Parameters:
    
    cptr - C pointer to the object
    
    shouldManage - if true, manage the pointer
    
    Returns:
    
    a new java instance of the underlying pointer
  - setSettings
```
public void setSettings(UpdateSettings settings)
```
    Sets the settings for updating variables in the Knowledge Base
    
    Parameters:
    
    settings - the settings to use for updating the Knowledge Base
  - modify
```
public void modify()
```
    Mark the value as modified. The Collection retains the same value but will resend its value as if it had been modified.
  - isTrue
```
public boolean isTrue()
```
    Returns true if the container evaluates to true
    
    Returns:
    
    true if container has all true values
  - isFalse
```
public boolean isFalse()
```
    Returns true if the container evaluates to false
    
    Returns:
    
    true if container has any false values or is uninitialized
  - toString
```
public java.lang.String toString()
```
    Reads all debug info for the collection into a string
    
    Overrides:
    
    toString in class MadaraJNI
    
    Returns:
    
    aggregate debug information for the collection
    
    See Also:
    
    ()
  - add
```
public void add(Barrier container)
```
    Adds a Barrier container to the collection
    
    Parameters:
    
    container - the container to add to the collection
  - add
```
public void add(Counter container)
```
    Adds a Counter container to the collection
    
    Parameters:
    
    container - the container to add to the collection
  - add
```
public void add(Double container)
```
    Adds a Double container to the collection
    
    Parameters:
    
    container - the container to add to the collection
  - add
```
public void add(DoubleVector container)
```
    Adds a DoubleVector container to the collection
    
    Parameters:
    
    container - the container to add to the collection
  - add
```
public void add(FlexMap container)
```
    Adds a FlexMap container to the collection
    
    Parameters:
    
    container - the container to add to the collection
  - add
```
public void add(Integer container)
```
    Adds a Integer container to the collection
    
    Parameters:
    
    container - the container to add to the collection
  - add
```
public void add(IntegerVector container)
```
    Adds a IntegerVector container to the collection
    
    Parameters:
    
    container - the container to add to the collection
  - add
```
public void add(Map container)
```
    Adds a Map container to the collection
    
    Parameters:
    
    container - the container to add to the collection
  - add
```
public void add(NativeDoubleVector container)
```
    Adds a NativeDoubleVector container to the collection
    
    Parameters:
    
    container - the container to add to the collection
  - add
```
public void add(NativeIntegerVector container)
```
    Adds a NativeIntegerVector container to the collection
    
    Parameters:
    
    container - the container to add to the collection
  - add
```
public void add(String container)
```
    Adds a String container to the collection
    
    Parameters:
    
    container - the container to add to the collection
  - add
```
public void add(StringVector container)
```
    Adds a StringVector container to the collection
    
    Parameters:
    
    container - the container to add to the collection
  - add
```
public void add(Vector container)
```
    Adds a Vector container to the collection
    
    Parameters:
    
    container - the container to add to the collection
  - getDebugInfo
```
public java.lang.String getDebugInfo()
```
    Reads all debug info for the collection into a string
    
    Returns:
    
    aggregate debug information for the collection
  - free
```
public void free()
```
    Deletes the C instantiation. To prevent memory leaks, this must be called before an instance gets garbage collected
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Cleans up underlying C resources
    
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable - necessary for override but unused

Class Collection

Constructor Summary

Method Summary

Methods inherited from class com.madara.containers.BaseContainer

Methods inherited from class com.madara.MadaraJNI

Methods inherited from class java.lang.Object

Constructor Detail

Collection

Collection

Method Detail

fromPointer

fromPointer

setSettings

modify

isTrue

isFalse

toString

add

add

add

add

add

add

add

add

add

add

add

add

add

getDebugInfo

free

finalize