wx.Build.FileProducts Class Reference

Inheritance diagram for wx.Build.FileProducts:

List of all members.

Public Member Functions
void	Add (IFileProducts fileDesignator)
object	Clone ()
int	CompareTo (object obj)
bool	Contains (IBuildProduct file)
override bool	Equals (object obj)
	FileProducts (ContentType type, params IFileProducts[] initialProducts)
	FileProducts (FileProducts src)
	FileProducts (ContentType type)
	FileProducts ()
override int	GetHashCode ()
ICollection < RefToProject >	GetProjects ()
System.Xml.Schema.XmlSchema	GetSchema ()
DateTime	GetValidity ()
DateTime	GetValidityDemand ()
void	NormalizeOriginalFileName (string nameOfAValidDirOrFile)
void	ReadXml (System.Xml.XmlReader reader)
IFileProducts	Replace (IFileProducts oldInstance, IFileProducts replacement)
override string	ToString ()
void	WriteXml (System.Xml.XmlWriter writer)
Properties
ICollection < IFileProducts >	Contents [get]
int	Count [get]
ContentFiles	ExplicitFiles [get]
ContentFiles	Files [get]
ContentType	Type [get]

---

Detailed Description

This is a collection of instances of IFileProduct that itself is an implementation of IFileProducts. You will need this class when specifying dependencies of projects that, for instance, on the one hand are content files and on the other hand targets of other projects.

---

Constructor & Destructor Documentation

wx.Build.FileProducts.FileProducts

(

)

Default CTor. Do not use except for the preparation of ReadXml().

wx.Build.FileProducts.FileProducts

(

ContentType

type

)

Creates an instance enumerating files of the provided type.

wx.Build.FileProducts.FileProducts

(

FileProducts

src

)

wx.Build.FileProducts.FileProducts	(	ContentType	type,
		params IFileProducts[]	initialProducts
	)

Creates an instance enumerating files of the provided type.

---

Member Function Documentation

void wx.Build.FileProducts.Add

(

IFileProducts

fileDesignator

)

Adds fileDesignator . Files and GetTargets will also return all files contained by fileDesignator . This will raise an ArgumentException if the content type of the files in fileDesignator is not contained by this type.

object wx.Build.FileProducts.Clone

(

)

int wx.Build.FileProducts.CompareTo

(

object

obj

)

bool wx.Build.FileProducts.Contains

(

IBuildProduct

file

)

True if this equals or the provided build product or the product is among its targets.

Parameters:

arg

The build product that will be searched

Implements wx.Build.IFileProducts.

override bool wx.Build.FileProducts.Equals

(

object

obj

)

override int wx.Build.FileProducts.GetHashCode

(

)

ICollection<RefToProject> wx.Build.FileProducts.GetProjects

(

)

This returns null because this does not imply build projects.

Implements wx.Build.IBuildProduct.

System.Xml.Schema.XmlSchema wx.Build.FileProducts.GetSchema

(

)

DateTime wx.Build.FileProducts.GetValidity

(

)

The earliest validity of a contained file.

Implements wx.Build.IBuildObject.

DateTime wx.Build.FileProducts.GetValidityDemand

(

)

The latest validity of a contained file.

Implements wx.Build.IBuildObject.

void wx.Build.FileProducts.NormalizeOriginalFileName

(

string

nameOfAValidDirOrFile

)

You may use this method to control the form of the file name that will be used to serialize this (the original filename). The argument is a path to an existing file or directory. This will strip a directory information from this path. After that, the original file name will change to something equivalent to the absolute filename (referring to the same file) but now relative to the directory as specified by the argument.

Use this method to prepare content file instance for serialization in such a way that all file names become relative to the same directory.

Parameters:

nameOfAValidDirOrFile

The name of an existing file or directory. This name will - if relative - be expanded using the BuildConfig. If this is null, this method will return without any effect. This may also be the name of a not yet existing file. In that case, however, the directory name shall exist.

See also:

OriginalFileName

Exceptions:

System.ArgumentException

Will be raised if the argument is neither the path to an existing file nor directory.

Implements wx.Build.IFileProducts.

void wx.Build.FileProducts.ReadXml

(

System.Xml.XmlReader

reader

)

IFileProducts wx.Build.FileProducts.Replace	(	IFileProducts	oldInstance,
		IFileProducts	replacement
	)

A helper for those projects that implement IFileProduct.

Parameters:

	oldInstance	This is a file descriptor that shall be replaced.
	replacement	This is a file descriptor that shall be used instead.

Returns:

The replacement if this equals oldInstance or this if otherwise this implements IFileProducts or null.

Implements wx.Build.IFileProducts.

override string wx.Build.FileProducts.ToString

(

)

void wx.Build.FileProducts.WriteXml

(

System.Xml.XmlWriter

writer

)

---

Property Documentation

ICollection<IFileProducts> wx.Build.FileProducts.Contents [get]

int wx.Build.FileProducts.Count [get]

The number of contained files.

Implements wx.Build.IFileProducts.

ContentFiles wx.Build.FileProducts.ExplicitFiles [get]

A collection of contained files that are addressed explicitely as instances of ContentFiles or ContentFile.

Implements wx.Build.IFileProducts.

ContentFiles wx.Build.FileProducts.Files [get]

The collection of files resulting from the bilding step.

Implements wx.Build.IFileProducts.

ContentType wx.Build.FileProducts.Type [get]

The type of the files resulting from this building step.

Implements wx.Build.IFileProducts.

---