//
// NodeElement.cs
//
// Author:
//   Lluis Sanchez Gual
//
// Copyright (C) 2007 Novell, Inc (http://www.novell.com)
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//


using System;
using System.Collections;

namespace Mono.Addins
{
	/// <summary>
	/// An extension node element.
	/// </summary>
	/// <remarks>
	/// A raw representation of an extension node. Contains the basic information
	/// needed to create ExtensionNode instances.
	/// </remarks>
	public interface NodeElement
	{
		/// <summary>
		/// Name of the node element.
		/// </summary>
		string NodeName { get; }
		
		/// <summary>
		/// Gets element attributes.
		/// </summary>
		/// <param name="key">
		/// Name of the attribute
		/// </param>
		/// <returns>
		/// The value of the attribute
		/// </returns>
		string GetAttribute (string key);
		
		/// <summary>
		/// Gets all attributes defined in the element.
		/// </summary>
		NodeAttribute[] Attributes { get; }
		
		/// <summary>
		/// Gets child nodes of this node
		/// </summary>
		NodeElementCollection ChildNodes { get; }
	}
	
	/// <summary>
	/// Attribute of a NodeElement.
	/// </summary>
	public class NodeAttribute
	{
		internal string name;
		internal string value;
		
		internal NodeAttribute ()
		{
		}
		
		/// <summary>
		/// Name of the attribute.
		/// </summary>
		public string Name {
			get { return name; }
		}
		
		/// <summary>
		/// Value of the attribute.
		/// </summary>
		public string Value {
			get { return value; }
		}
	}
	
	/// <summary>
	/// A collection of NodeElement objects
	/// </summary>
	public interface NodeElementCollection: IList, ICollection, IEnumerable
	{
		/// <summary>
		/// Gets the <see cref="Mono.Addins.NodeElement"/> at the specified index
		/// </summary>
		/// <param name='n'>
		/// Index
		/// </param>
		new NodeElement this [int n] { get; }
	}
}
