Towards a Declarative SAX Framework : Part 1 - A Simple SAX-to-C#-Mapping

#region Copyright
/*********************************************************************************
 * Copyright (c) 2004 by Martin Friedrich										 *
 * Permission to freely distribute, modify and compile these sources and		 *
 * binaries as long as this copyright notice is included.						 *
 * Use of code on your risk!													 *
 * *******************************************************************************/
#endregion

using System;
using System.Text;
using System.IO;

namespace SaxParserSupport
{
	namespace Impl 
	{
		/// <summary>
		/// Implements <tt>XMLDocument</tt>. This class is abstract because it doesn't
		/// implement method <tt>SaxParserSupport.Impl.XMLElement.getElementClasses</tt>
		/// <seealso cref="XMLDocument"/>
		/// </summary>
		public abstract class XMLDocumentImpl : XMLElementImpl, XMLDocument
		{
			/// <summary>
			/// Constructs an instance of <tt>XMLDocumentImpl</tt>. The XML version is
			/// set to 1.0 and it's encoding is UTF-8 by default.
			/// </summary>
			protected XMLDocumentImpl()
			{
				_encoding = new UTF8Encoding().HeaderName;
				_version = "1.0";
			}

			/// <summary>
			/// Emits this <tt>XMLDocument</tt> instance to <tt>str</tt>
			/// </summary>
			/// <remarks>
			/// <list type="bullet"><item>As of now, only the XML declaration and the root element (and
			/// it's subselement, of course) are emitted.</item>
			/// <item>This method may throw various exceptions related to stream output</item>
			/// </list>
			/// <seealso cref="XMLDocument"/>
			/// </remarks>
			/// <param name="ostr">The output stream</param>
			public override void write( System.IO.StreamWriter ostr )
			{
				ostr.WriteLine( "<?xml version=\"{0}\" encoding=\"{1}\" ?>", _version, getEncoding() );
				base.write( ostr );
				ostr.Close();
			}

			/// <summary>
			/// Returns the name of the encoding to be used for output.
			/// </summary>
			/// <returns>The name of the encoding</returns>
			public string getEncoding()
			{
				return _encoding;
			}

			/// <summary>
			/// Sets the name of the encoding for output.
			/// </summary>
			/// <param name="en">The encoding's name as given by it's <tt>System.Text.Encoding.HeaderName</tt>
			/// property</param>
			public void setEncoding( string en )
			{
				_encoding = en;
			}

			/// <summary>
			/// Returns the XML version.
			/// </summary>
			/// <returns>The XML version in string form</returns>
			public string getVersion()
			{
				return _version;
			}

			/// <summary>
			/// Sets the XML version. The XML version should always be <tt>"1.0"</tt>.
			/// </summary>
			/// <param name="v">the XML version in string form</param>
			public void setVersion( string v )
			{
				_version = v;
			}

			/// <summary>
			/// ***PRIVATE***
			/// </summary>
			private string _encoding;

			/// <summary>
			/// ***PRIVATE***
			/// </summary>
			private string _version;
		}
	}
}