Crystal.BehaviourCollection Class Reference

A collection of T:Crystal.IBehaviours. More...

Inheritance diagram for Crystal.BehaviourCollection:

Classes
class	OptionCollectionNullException

Public Member Functions
bool	Add (IBehaviour behaviour)
	Adds the given behaviour to this collection. More...
bool	Contains (string behaviourId)
	Determines whether a behaviour with the specified name identifier exists within this collection. More...
void	Clear ()
	Removes all behaviours from this collection. More...
void	ClearAll ()
	Removes all behaviours from this collection. Additionally all options are removed from the T:Crystal.IOptionCollection used in constructing this collection as well as all considerations and actions are removed from their respective collections. More...
IBehaviour	Create (string behaviourId)
	Creates a behaviour with the specified identifier if such a behaviour exists; otherwise returns null. More...
	BehaviourCollection (IOptionCollection optionCollection)
	Initializes a new instance of the BehaviourCollection class. More...

Properties
IOptionCollection	Options [get]
	The T:Crystal.IOptionCollection used to construct this collection. More...
Properties inherited from Crystal.IBehaviourCollection
IOptionCollection	Options [get]
	The T:Crystal.IOptionCollection used to construct this collection. More...

Detailed Description

A collection of T:Crystal.IBehaviours.

See also

T:Crystal.IBehaviourCollection

Constructor & Destructor Documentation

Crystal.BehaviourCollection.BehaviourCollection ( IOptionCollection  optionCollection )

inline

Initializes a new instance of the BehaviourCollection class.

Parameters

optionCollection

The option collection.

Exceptions

Crystal.BehaviourCollection.OptionCollectionNullException

Member Function Documentation

bool Crystal.BehaviourCollection.Add ( IBehaviour  behaviour )

inline

Adds the given behaviour to this collection.

Parameters

behaviour

The behaviour.

Returns

true if the behaviour was added to the collection; otherwise, false.

Implements Crystal.IBehaviourCollection.

void Crystal.BehaviourCollection.Clear ( )

inline

Removes all behaviours from this collection.

Implements Crystal.IBehaviourCollection.

void Crystal.BehaviourCollection.ClearAll ( )

inline

Removes all behaviours from this collection. Additionally all options are removed from the T:Crystal.IOptionCollection used in constructing this collection as well as all considerations and actions are removed from their respective collections.

Implements Crystal.IBehaviourCollection.

bool Crystal.BehaviourCollection.Contains ( string  behaviourId )

inline

Determines whether a behaviour with the specified name identifier exists within this collection.

Parameters

behaviourId

The name identifier.

Returns

true if a behaviour with the specified identifier exists within the collection; otherwise, false.

Implements Crystal.IBehaviourCollection.

IBehaviour Crystal.BehaviourCollection.Create ( string  behaviourId )

inline

Creates a behaviour with the specified identifier if such a behaviour exists; otherwise returns null.

Parameters

behaviourId

The behaviour identifier.

Returns

Implements Crystal.IBehaviourCollection.

Property Documentation

IOptionCollection Crystal.BehaviourCollection.Options

get

The T:Crystal.IOptionCollection used to construct this collection.

---

The documentation for this class was generated from the following file:

• Source/Behaviours/BehaviourCollection.cs