com.tibco.cep.runtime.model.element

## Interface PropertyArrayContainedConcept

- All Superinterfaces:
    PropertyArrayConcept

      public interface PropertyArrayContainedConcept
      extends PropertyArrayConcept

  Property that contains zero, one, or multiple `PropertyAtomContainedConcept`.
  Since:
    2.0.0

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `add(ContainedConcept instance)` Creates a `PropertyAtomContainedConcept` with the given `ContainedConcept` and appends it to the array.
    `void` | `add(int index, ContainedConcept instance)` Creates a `PropertyAtomContainedConcept` with the given `ContainedConcept` and inserts it into the array at the specified position.
    `PropertyAtomContainedConcept` | `getPropertyAtomContainedConcept(ContainedConcept instance)` Finds the first `PropertyAtomContainedConcept` with the given instance in this array.
    `int` | `getPropertyAtomContainedConceptIndex(ContainedConcept instance)` Finds the first `PropertyAtomContainedConcept` with the given instance in this array.
    `int` | `put(ContainedConcept instance)` Returns the index of the `PropertyAtomContainedConcept` in this array that has the given `ContainedConcept`, if any, otherwise creates a `PropertyAtomContainedConcept` that refers to the instance and appends it to the end of the array.
    `PropertyAtomContainedConcept` | `remove(ContainedConcept instance)` Removes the first `PropertyAtomContainedConcept` with the given instance that is found in this array.
    `PropertyAtomContainedConcept` | `removePropertyAtom(ContainedConcept instance)` Removes the first occurrence of `PropertyContainedConcept` which has the given instance, and returns it.
    `void` | `set(int index, ContainedConcept value)` Sets the `PropertyContainedConcept` at the given index to the given `ContainedConcept`.

- - ### Method Detail

    - #### add

          int add(ContainedConcept instance)

      Creates a `PropertyAtomContainedConcept` with the given `ContainedConcept` and appends it to the array.
      Parameters:
        `instance` - the `ContainedConcept` to add.
      Returns:
        the index at which the instance was inserted.
      Throws:
        `ContainedConceptException` - if the `ContainedConcept` instance already belongs to a different parent.
      Since:
        2.0.0

    - #### add

          void add(int index,
                   ContainedConcept instance)

      Creates a `PropertyAtomContainedConcept` with the given `ContainedConcept` and inserts it into the array at the specified position. This method shifts the `PropertyAtomContainedConcept` currently at that position (if any) and any subsequent `PropertyAtomContainedConcept` to the right (i.e. adds one to their indices).
      Parameters:
        `index` - the position at which to insert.
        `instance` - the `ContainedConcept` to add.
      Throws:
        `ContainedConceptException` - if the `ContainedConcept` instance already belongs to a different parent.
      Since:
        2.0.0

    - #### put

          int put(ContainedConcept instance)

      Returns the index of the `PropertyAtomContainedConcept` in this array that has the given `ContainedConcept`, if any, otherwise creates a `PropertyAtomContainedConcept` that refers to the instance and appends it to the end of the array.
      Parameters:
        `instance` - the `ContainedConcept` to search for in this array, or which will be added.
      Returns:
        the index at which the instance is found or inserted.
      Throws:
        `ContainedConceptException` - - if the `ContainedConcept` instance already belongs to a different parent.
      Since:
        2.0.0

    - #### remove

          PropertyAtomContainedConcept remove(ContainedConcept instance)

      Removes the first `PropertyAtomContainedConcept` with the given instance that is found in this array. This method shifts all the subsequent array elements to the left (i.e. substracts one to their indices).
      Parameters:
        `instance` - the `ContainedConcept`to search for in the array.
      Returns:
        the removed `PropertyAtomDateTime`, or null if none matched.
      Since:
        2.0.0

    - #### getPropertyAtomContainedConceptIndex

          int getPropertyAtomContainedConceptIndex(ContainedConcept instance)

      Finds the first `PropertyAtomContainedConcept` with the given instance in this array.
      Parameters:
        `instance` - the `ContainedConcept` instance to search for in the array.
      Returns:
        the index at which the instance was found, or -1 if it was not found.
      Since:
        2.0.0

    - #### getPropertyAtomContainedConcept

          PropertyAtomContainedConcept getPropertyAtomContainedConcept(ContainedConcept instance)

      Finds the first `PropertyAtomContainedConcept` with the given instance in this array.
      Parameters:
        `instance` - the `ContainedConcept` instance to search for in the array.
      Returns:
        the `PropertyAtomContainedConcept` that was found, or null if none was not found.
      Since:
        2.0.0

    - #### set

          void set(int index,
                   ContainedConcept value)

      Sets the `PropertyContainedConcept` at the given index to the given `ContainedConcept`. If `index == length`, this method will call `add(index, value)` instead.
      Parameters:
        `index` - the index at which the concept is to be set.
        `value` - the `ContainedConcept` to set at the index.
      Throws:
        `java.lang.IndexOutOfBoundsException` - - if the index is less than zero or more than the current size of the array.
      Since:
        2.0.0

    - #### removePropertyAtom

          PropertyAtomContainedConcept removePropertyAtom(ContainedConcept instance)

      Removes the first occurrence of `PropertyContainedConcept` which has the given instance, and returns it. This method shifts all the subsequent array elements to the left (i.e. substracts one to their indices). It returns null if no matching `PropertyContainedConcept` is found.
      Parameters:
        `instance` - the instance to search for.
      Returns:
        the removed `PropertyContainedConcept` if any, else null.
      Since:
        2.0.0