ChainableReader Class

Summary

Functions as a chainable TextReader
Assembly
NAnt.Core.dll
Namespace
NAnt.Core.Filters
Interfaces
  • IDisposable
Base Types
Derived Types
graph BT Type-->Base0["Element"] click Base0 "/api/NAnt.Core/Element" Base0-->Base1["Object"] Type-.->Interface0["IDisposable"] Type["ChainableReader"] class Type type-node Derived0["Filter"]-->Type click Derived0 "/api/NAnt.Core.Filters/Filter"

Syntax

public abstract class ChainableReader : Element, IDisposable

Remarks

Implements a abstraction over a TextReader that allows the class to represent either a TextReader or another ChainableReader to which it is chained. By passing a ChainableReader as a constructor parameter it is possible to chain many ChainableReaders together. The last ChainableReader in the chain must be based on a TextReader.

Properties

Name Value Summary
Base bool
Gets a value indicating if the reader is backed by a stream in the chain.
CustomXmlProcessing bool
Gets a value indicating whether the element is performing additional processing using the NAnt.Core.Element.XmlNode that was used to initialize the element.
Inherited from Element
Location Location
Gets or sets the location in the build file where the element is defined.
Inherited from Element
Name string
Gets the name of the XML element used to initialize this element.
Inherited from Element
NamespaceManager XmlNamespaceManager
Gets or sets the System.Xml.XmlNamespaceManager.
Inherited from Element
Parent Object
Gets or sets the parent of the element.
Inherited from Element
Project Project
Gets or sets the NAnt.Core.Element.Project to which this element belongs.
Inherited from Element
Properties PropertyDictionary
Gets the properties local to this NAnt.Core.Element and the NAnt.Core.Element.Project.
Inherited from Element
XmlNode XmlNode
Gets or sets the XML node of the element.
Inherited from Element

Methods

Name Value Summary
Chain(ChainableReader) void
Makes it so all calls to Read and Peek are passed the ChainableReader passed as a parameter.
Chain(TextReader) void
Makes it so all calls to Read and Peek are passed the TextReader passed as a parameter.
Close() void
Closes the reader.
CopyTo(Element) void
Copies all instance data of the NAnt.Core.Element to a given NAnt.Core.Element.
Inherited from Element
Dispose() void
Calls close and suppresses the finalizer for the object.
GetAttributeConfigurationNode(FrameworkInfo, string) XmlNode
Locates the XML node for the specified attribute in the project configuration node.
Inherited from Element
GetAttributeConfigurationNode(XmlNode, FrameworkInfo, string) XmlNode
Inherited from Element
GetLocation() Location
Retrieves the location in the build file where the element is defined.
Inherited from Element
Initialize() void
Derived classes should override to this method to provide extra initialization and validation not covered by the base class.
Inherited from Element
Initialize(XmlNode) void
Performs default initialization.
Inherited from Element
InitializeBuildElement(Element, XmlNode, Element, Type) Element
Initializes the build element.
Inherited from Element
static
InitializeElement(XmlNode) void
Derived classes should override to this method to provide extra initialization and validation not covered by the base class.
Inherited from Element
InitializeXml(XmlNode, PropertyDictionary, FrameworkInfo) void
Initializes all build attributes and child elements.
Inherited from Element
Log(Level, string) void
Logs a message with the given priority.
Inherited from Element
Log(Level, string, Object[]) void
Logs a message with the given priority.
Inherited from Element
Peek() int
Forwards Peek calls to the TextReader or ChainableReader passed in the corresponding constructor.
Read() int
Forwards Read calls to the TextReader or ChainableReader passed in the corresponding constructor.