wx.Build.FileSelector Class Reference

Inheritance diagram for wx.Build.FileSelector:

Inheritance graph

List of all members.

Public Member Functions

object Clone ()
int CompareTo (object obj)
bool Contains (IBuildProduct file)
override bool Equals (object obj)
bool Execute (BuildToolFamilyEnv env, DateTime validityOfBuildSystem)
 FileSelector (FileSelector src)
 FileSelector (ContentType type, string directory, string filter, string description)
 FileSelector ()
override int GetHashCode ()
ICollection
< RefToProject
GetProjects ()
System.Xml.Schema.XmlSchema GetSchema ()
ICollection
< IBuildProduct
GetTargets ()
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

int Count [get]
string Description [get]
ContentFiles ExplicitFiles [get]
ContentFiles Files [get]
string Name [get]
ContentType Type [get]


Detailed Description

A simple project selecting the files in a specified directory. Various projects receive all files of a particular file name extension as prerequisites (for instance as source files). Use this sub-project to represent this demand.

Constructor & Destructor Documentation

wx.Build.FileSelector.FileSelector (  ) 

Selector of all executables as .NET programs. Use only to create an instance for ReadXml().

wx.Build.FileSelector.FileSelector ( ContentType  type,
string  directory,
string  filter,
string  description 
)

Creates a selector "producing" all files within a certain directory that comply with the specified filter expression.

Parameters:
type is the content type that will be assumed for the selected files.
directory is the path to a directory. This may be a relative path name. Relative path names will be combined with the path name of the entry assembly's directory.
filter is a file filter expression containing wildcards * and ?. Do not use ".." here. Refer to System .Directory.GetFiles().
description is a descriptive text on the selected files.

wx.Build.FileSelector.FileSelector ( FileSelector  src  ) 

Copy CTor

Parameters:
src The source


Member Function Documentation

object wx.Build.FileSelector.Clone (  ) 

int wx.Build.FileSelector.CompareTo ( object  obj  ) 

bool wx.Build.FileSelector.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.FileSelector.Equals ( object  obj  ) 

bool wx.Build.FileSelector.Execute ( BuildToolFamilyEnv  env,
DateTime  validityOfBuildSystem 
)

This will produce an error if the directory does not exist.

Returns:
true on success and false on failure, that should however also be reported to the error handler.

override int wx.Build.FileSelector.GetHashCode (  ) 

ICollection<RefToProject> wx.Build.FileSelector.GetProjects (  ) 

This returns null because this does not imply build projects.

Implements wx.Build.IBuildProduct.

System.Xml.Schema.XmlSchema wx.Build.FileSelector.GetSchema (  ) 

ICollection<IBuildProduct> wx.Build.FileSelector.GetTargets (  ) 

DateTime wx.Build.FileSelector.GetValidity (  ) 

Returns validity timstamp of this object. Whenever this is equal or later than all prerequisites, this is considered consistent with the prerequisites on rebuilding.

Implements wx.Build.IBuildObject.

DateTime wx.Build.FileSelector.GetValidityDemand (  ) 

This is the counterpart of the Validity . If this occurs as a prerequisite, this shall be compared with the Validity of the target in order to assess whether rebuild is necessary or not.

Implements wx.Build.IBuildObject.

void wx.Build.FileSelector.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.FileSelector.ReadXml ( System.Xml.XmlReader  reader  ) 

IFileProducts wx.Build.FileSelector.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.FileSelector.ToString (  ) 

void wx.Build.FileSelector.WriteXml ( System.Xml.XmlWriter  writer  ) 


Property Documentation

int wx.Build.FileSelector.Count [get]

The number of contained files.

Implements wx.Build.IFileProducts.

string wx.Build.FileSelector.Description [get]

ContentFiles wx.Build.FileSelector.ExplicitFiles [get]

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

Implements wx.Build.IFileProducts.

ContentFiles wx.Build.FileSelector.Files [get]

The collection of files resulting from the bilding step.

Implements wx.Build.IFileProducts.

string wx.Build.FileSelector.Name [get]

Derived from the directory and the filter expression.

ContentType wx.Build.FileSelector.Type [get]

The type of the produced files.

Implements wx.Build.IFileProducts.


The wx.NET Build System.   (c) 2009-2010 Harald Meyer auf'm Hofe