wx.Build.CollectionOfBuildActions Class Reference

Inheritance diagram for wx.Build.CollectionOfBuildActions:

List of all members.

Public Member Functions
delegate bool	ActionSelector (IBuildAction action)
void	Add (ActionPriority p, IBuildAction item)
void	Add (IBuildAction item)
void	AddRange (ActionPriority p, ICollection< IBuildAction > actions)
void	AddRange (ICollection< IBuildAction > actions)
void	Clear ()
	CollectionOfBuildActions ()
bool	Contains (IBuildAction item)
bool	ContainsPrerequisite (IBuildProduct prereq)
void	CopyTo (IBuildAction[] array, int arrayIndex)
ICollection < IBuildAction >	GetActions ()
IEnumerator < IBuildAction >	GetEnumerator ()
IBuildAction	GetOneAction ()
ICollection < IBuildProduct >	GetPrerequisites ()
bool	Remove (IBuildAction item)
void	Remove (ActionSelector selector)
void	SetReadOnly ()
override string	ToString ()
Properties
ICollection < ActionPriority >	ActionPriorities [get]
int	Count [get]
bool	IsReadOnly [get]
ActionPriority	LeastImportantPriority [get]
ActionPriority	MostImportantPriority [get]
ICollection < IBuildAction >	this [ActionPriority p] [get]

---

Detailed Description

This is a collection of actions sorted by priority.

---

Constructor & Destructor Documentation

wx.Build.CollectionOfBuildActions.CollectionOfBuildActions

(

)

---

Member Function Documentation

delegate bool wx.Build.CollectionOfBuildActions.ActionSelector

(

IBuildAction

action

)

This will be used to define subsets of actions.

void wx.Build.CollectionOfBuildActions.Add	(	ActionPriority	p,
		IBuildAction	item
	)

This will explicitely add the item to the actions of priority p . Regardless of wx .Build.IBuildAction.Priority.

void wx.Build.CollectionOfBuildActions.Add

(

IBuildAction

item

)

Adds the provided actions. This will read the wx .Build.IBuildAction.Priority of item to determine its priority.

void wx.Build.CollectionOfBuildActions.AddRange	(	ActionPriority	p,
		ICollection< IBuildAction >	actions
	)

This will add all actions in actions with the provided priority.

void wx.Build.CollectionOfBuildActions.AddRange

(

ICollection< IBuildAction >

actions

)

This will add all actions in actions with default priority.

void wx.Build.CollectionOfBuildActions.Clear

(

)

bool wx.Build.CollectionOfBuildActions.Contains

(

IBuildAction

item

)

bool wx.Build.CollectionOfBuildActions.ContainsPrerequisite

(

IBuildProduct

prereq

)

void wx.Build.CollectionOfBuildActions.CopyTo	(	IBuildAction[]	array,
		int	arrayIndex
	)

ICollection<IBuildAction> wx.Build.CollectionOfBuildActions.GetActions

(

)

Returns a collection of actions. If you enumerate this, this will be in the order according to the priority.

IEnumerator<IBuildAction> wx.Build.CollectionOfBuildActions.GetEnumerator

(

)

IBuildAction wx.Build.CollectionOfBuildActions.GetOneAction

(

)

Returns one of the most prioritized actions if there are any or null if this is null.

ICollection<IBuildProduct> wx.Build.CollectionOfBuildActions.GetPrerequisites

(

)

bool wx.Build.CollectionOfBuildActions.Remove

(

IBuildAction

item

)

void wx.Build.CollectionOfBuildActions.Remove

(

ActionSelector

selector

)

This will remove those actions where selector returns true.

void wx.Build.CollectionOfBuildActions.SetReadOnly

(

)

After calling this method all modifiers will throw an exception.

override string wx.Build.CollectionOfBuildActions.ToString

(

)

---

Property Documentation

ICollection<ActionPriority> wx.Build.CollectionOfBuildActions.ActionPriorities [get]

This is a collection of priorities that this instance actially maps to at least one action. The priorities will be sorted. So, you may use this method in cooperation with the indexer to enumerate all actions w.r.t. their assigned priority.

            CollectionOfBuildActions c=...;
            foreach(ActionPriority p in c.ActionPriorities)
               foreach(IBuildAction action in c[0])
                  System.Console.WriteLine("Action {0} has priority {1}.", action.Name, p);

int wx.Build.CollectionOfBuildActions.Count [get]

bool wx.Build.CollectionOfBuildActions.IsReadOnly [get]

ActionPriority wx.Build.CollectionOfBuildActions.LeastImportantPriority [get]

Returns the least important priority of a contained action. If this is empty, the result is ActionPriority.PreferredByUserInput.

ActionPriority wx.Build.CollectionOfBuildActions.MostImportantPriority [get]

Returns the most important priority of a contained action. If this is empty, the result is ActionPriority.Fallback.

ICollection<IBuildAction> wx.Build.CollectionOfBuildActions.this[ActionPriority p]

(

)

[get]

Returns the collection of actions stored for the secified priority. Return null if this does not hold an action of this priority.

See also:

ActionPriorities

---