wx.Build.RefToSingleFileProject Class Reference

Inheritance diagram for wx.Build.RefToSingleFileProject:

Inheritance graph

List of all members.

Public Member Functions

override object Clone ()
int CompareTo (object obj)
bool Contains (IBuildProduct file)
override bool Equals (object obj)
override int GetHashCode ()
ICollection
< RefToProject
GetProjects ()
System.Xml.Schema.XmlSchema GetSchema ()
DateTime GetValidity ()
DateTime GetValidityDemand ()
virtual void NormalizeOriginalFileName (string nameOfAValidDirOrFile)
void ReadXml (System.Xml.XmlReader reader)
 RefToSingleFileProject (SingleFileProject aProjectProducingASingleFile)
 RefToSingleFileProject ()
IFileProducts Replace (IFileProducts oldInstance, IFileProducts replacement)
override string ToString ()
void WriteXml (System.Xml.XmlWriter writer)

Static Public Member Functions

static implicit operator RefToFileProject (FileProject p)
static implicit operator RefToProject (BuildProject p)
static operator RefToSingleFileProject (SingleFileProject p)

Properties

int Count [get]
ContentFiles ExplicitFiles [get]
ContentFile File [get]
ContentFiles Files [get]
BuildProject Project [get]
ContentType Type [get]


Detailed Description

This is a wrapper of projects that produce a single file. Projects producing a single file shall return an instance of this class as BuildProject.Ref.

Constructor & Destructor Documentation

wx.Build.RefToSingleFileProject.RefToSingleFileProject (  ) 

Use this only to create an instance for ReadXml().

wx.Build.RefToSingleFileProject.RefToSingleFileProject ( SingleFileProject  aProjectProducingASingleFile  ) 


Member Function Documentation

override object wx.Build.RefToSingleFileProject.Clone (  )  [virtual]

Reimplemented from wx.Build.RefToFileProject.

int wx.Build.RefToProject.CompareTo ( object  obj  )  [inherited]

Compares w.r.t. the encaspulated project if both are of class RefToProject.

Parameters:
obj The object that will be compared
Returns:
-1 if this is smaller than the argument, 0 if both equal, 1 if the argument is larger.

bool wx.Build.RefToFileProject.Contains ( IBuildProduct  file  )  [inherited]

True if the argument equals this (refers to the same project) or the argument is contained by Files.

Parameters:
file The file or project that is searched by the caller.
Returns:

Implements wx.Build.IFileProducts.

override bool wx.Build.RefToProject.Equals ( object  obj  )  [inherited]

override int wx.Build.RefToProject.GetHashCode (  )  [inherited]

This is the hash of the encapsulated project.

Returns:

ICollection<RefToProject> wx.Build.RefToProject.GetProjects (  )  [inherited]

Returns a collection including exclusively the wrapped project.

Returns:

Implements wx.Build.IBuildProduct.

System.Xml.Schema.XmlSchema wx.Build.RefToProject.GetSchema (  )  [inherited]

DateTime wx.Build.RefToProject.GetValidity (  )  [inherited]

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.RefToProject.GetValidityDemand (  )  [inherited]

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.

virtual void wx.Build.RefToFileProject.NormalizeOriginalFileName ( string  nameOfAValidDirOrFile  )  [virtual, inherited]

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.

static implicit wx.Build.RefToFileProject.operator RefToFileProject ( FileProject  p  )  [static, inherited]

Implicit conversion of a project into an instance of this class. This works using BuildProject.CreateRefToFileProject().

Parameters:
p The project that shall be referenced
Returns:
A reference to the project.

static implicit wx.Build.RefToProject.operator RefToProject ( BuildProject  p  )  [static, inherited]

Implicitely converts a project into a ref to a project creating a reference to the project.

Parameters:
p The project that shall be referenced
Returns:
A reference to the project.

static wx.Build.RefToSingleFileProject.operator RefToSingleFileProject ( SingleFileProject  p  )  [explicit, static]

Explicit conversion of a project into an instance of this class. This works using BuildProject.CreateRefToSingleFileProject().

Parameters:
p The project that shall be referenced
Returns:
A reference to the project.

void wx.Build.RefToProject.ReadXml ( System.Xml.XmlReader  reader  )  [inherited]

Will create a project using BuildProject.LoadRefFrom(reader).

Parameters:
reader The source where the XML serialization will be read from.

IFileProducts wx.Build.RefToFileProject.Replace ( IFileProducts  oldInstance,
IFileProducts  replacement 
) [inherited]

Creates a copy where contained file descriptors have been changed. This will be used when projects are transformed e.g. to make a release (c.f. wx.Build.Release.MakeReleaseProject).

A special case occurs if replacement is null. This method can be used in this configuration to remove occurances of a file product term.

Exceptions:
System.Exception May occur, if the replacement is not of the same class as the old instance.
Parameters:
oldInstance The file descriptor that shall be replaced. If the replacement is null, all occurances of this descriptor will be removed.
replacemant The file descriptor that shall be used instead of oldInstance. This may be null. In that case, all occurances of oldInstance will be removed.
Returns:
A copy of this instance where all occurances of oldInstance have been replaced by replacement. The result may be replacement if this instance is equal to oldInstance. The result may be this instance if this is neither equal to oldInstance nor this is a container containing oldInstance.

The result is null if this equals oldInstance and the replacement is null.

Implements wx.Build.IFileProducts.

override string wx.Build.RefToProject.ToString (  )  [inherited]

void wx.Build.RefToProject.WriteXml ( System.Xml.XmlWriter  writer  )  [inherited]

Calls BuildProject.WriteRefXml().

Parameters:
writer the destination where the XML serialization will be written to.


Property Documentation

int wx.Build.RefToFileProject.Count [get, inherited]

The number of contained files.

Implements wx.Build.IFileProducts.

ContentFiles wx.Build.RefToFileProject.ExplicitFiles [get, inherited]

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

Implements wx.Build.IFileProducts.

ContentFile wx.Build.RefToSingleFileProject.File [get]

The file resulting from the bilding step.

Implements wx.Build.ISingleFileProduct.

ContentFiles wx.Build.RefToFileProject.Files [get, inherited]

The collection of files resulting from the bilding step.

Implements wx.Build.IFileProducts.

BuildProject wx.Build.RefToProject.Project [get, inherited]

This is the encapsulated project.

ContentType wx.Build.RefToFileProject.Type [get, inherited]

The type of the files resulting from this building step.

Implements wx.Build.IFileProducts.


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