// Copyright (c) 2008, NTT DATA Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using System;
using System.Configuration;
using TERASOLUNA.Fw.Common.Logging;

namespace TERASOLUNA.Fw.Web.Configuration.RequestController
{
    /// <summary>
    /// Controller 要素のコレクションを格納する構成要素を表します。
    /// </summary>
    public class RequestControllerCollection : ConfigurationElementCollection
    {
        /// <summary>
        /// <see cref="ILog"/> 実装クラスのインスタンスです。
        /// </summary>
        /// <remarks>
        /// ログ出力に利用します。
        /// </remarks>
        private static ILog _log = LogFactory.GetLogger(typeof(RequestControllerCollection));

        /// <summary>
        /// <see cref="RequestControllerCollection"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <remarks>
        /// デフォルトコンストラクタです。
        /// </remarks>
        public RequestControllerCollection()
        {
        }

        /// <summary>
        /// <see cref="RequestControllerCollection"/> の型を取得します。 
        /// </summary>
        /// <remarks>
        /// このコレクションの <see cref="ConfigurationElementCollectionType"/> は <seealso cref="ConfigurationElementCollectionType.BasicMap"/> です。
        /// </remarks>
        public override ConfigurationElementCollectionType CollectionType
        {
            get
            {
                return ConfigurationElementCollectionType.BasicMap;
            }
        }

        /// <summary>
        /// 新しい controller 要素を作成します。
        /// </summary>
        /// <returns>新しい controller 要素。</returns>
        /// <remarks>
        /// 新しい <see cref="RequestControllerElement"/> オブジェクトを作成します。
        /// </remarks>
        protected override ConfigurationElement CreateNewElement()
        {
            return new RequestControllerElement();
        }

        /// <summary>
        /// 指定したインデックス位置にある controller 要素を取得します。
        /// </summary>
        /// <param name="index">取得する <see cref="RequestControllerElement"/> のインデックス位置。</param>
        /// <returns>指定したインデックス位置にある <see cref="RequestControllerElement"/> 。</returns>
        /// <remarks>
        /// <seealso cref="ConfigurationElementCollection.BaseGet(int)"/> メソッドを使用して、<see cref="RequestControllerCollection"/> から <see cref="RequestControllerElement"/> オブジェクトを取得します。
        /// </remarks>
        public RequestControllerElement this[int index]
        {
            get
            {
                return (RequestControllerElement)BaseGet(index);
            }
        }

        /// <summary>
        /// 指定したキーを持つ controller 要素を取得します。
        /// </summary>
        /// <param name="name">取得する controller 要素のキー。例外クラス名を表す文字列。</param>
        /// <returns>指定したキーを持つ <see cref="RequestControllerElement"/> 。それ以外の場合は null 参照。</returns>
        /// <remarks>
        /// <seealso cref="ConfigurationElementCollection.BaseGet(object)"/> メソッドを使用して、<see cref="RequestControllerCollection"/> から <see cref="RequestControllerElement"/> オブジェクトを取得します。
        /// 指定したキーを持つ <see cref="RequestControllerElement"/> オブジェクトがコレクションに存在しない場合、 null 参照を返します。
        /// </remarks>
        public virtual new RequestControllerElement this[string name]
        {
            get
            {
                return (RequestControllerElement)BaseGet(name);
            }
        }

        /// <summary>
        /// <see cref="RequestControllerCollection"/> の要素数を取得します。
        /// </summary>
        /// <value>
        /// <see cref="RequestControllerCollection"/> の要素数。
        /// </value>
        public virtual new int Count
        {
            get
            {
                return base.Count;
            }
        }

        /// <summary>
        /// 要素のコレクションを識別するために使用する名前を取得します。
        /// </summary>
        /// <remarks>
        /// 要素名は "controller" です。
        /// </remarks>
        protected override string ElementName
        {
            get
            {
                return "controller";
            }
        }
        /// <summary>
        /// exceptionTransition 要素の要素キーを取得します。
        /// </summary>
        /// <param name="element">キーを返す <see cref="RequestControllerElement"/> 。</param>
        /// <returns>指定した <see cref="RequestControllerElement"/> のキーとして機能する <see cref="Object"/> 。</returns>
        /// <remarks>特になし。</remarks>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="element"/> が null 参照です。
        /// </exception>
        /// <exception cref="ArgumentException">
        /// <paramref name="element"/> が <see cref="RequestControllerElement"/> ではありません。
        /// </exception>
        protected override Object GetElementKey(ConfigurationElement element)
        {
            if (element == null)
            {
                ArgumentNullException exception = new ArgumentNullException("element");
                if (_log.IsErrorEnabled)
                {
                    _log.Error(string.Format(
                        Web.Properties.Resources.E_NULL_ARGUMENT, "element"), exception);
                }
                throw exception;
            }
            RequestControllerElement controllerElement = element as RequestControllerElement;
            if (controllerElement == null)
            {
                string message = string.Format(Web.Properties.Resources.E_INVALID_TYPE, "element");
                ArgumentException exception = new ArgumentException(message);
                if (_log.IsErrorEnabled)
                {
                    _log.Error(message, exception);
                }
                throw exception;
            }

            return controllerElement.Name;
        }

        /// <summary>
        /// <see cref="RequestControllerCollection"/> に controller 要素を追加します。
        /// </summary>
        /// <param name="element">追加する <see cref="RequestControllerElement"/> 。</param>
        /// <remarks>
        /// <seealso cref="BaseAdd(ConfigurationElement)"/> メソッドを使用して、コレクションに新しい <see cref="RequestControllerElement"/> を追加します。
        /// </remarks>
        public virtual void Add(RequestControllerElement element)
        {
            BaseAdd(element);
        }

        /// <summary>
        /// <see cref="RequestControllerCollection"/> に controller 要素を追加します。
        /// </summary>
        /// <param name="element">追加する <see cref="RequestControllerCollection"/> 。</param>
        /// <remarks>
        /// 指定した <paramref name="element"/> が controller 要素コレクションに既に存在する場合、例外は発生しません。
        /// </remarks>
        protected override void BaseAdd(ConfigurationElement element)
        {
            BaseAdd(element, false);
        }

        /// <summary>
        /// <see cref="RequestControllerCollection"/> オブジェクトが読み取り専用かどうかを示す値を取得します。 
        /// </summary>
        /// <returns>
        /// <see cref="RequestControllerCollection"/> オブジェクトが読み取り専用の場合は true 。それ以外の場合は false 。
        /// </returns>
        /// <remarks>
        /// <see cref="RequestControllerCollection"/> オブジェクトは読み取り専用ではありません。
        /// </remarks>
        public override bool IsReadOnly()
        {
            return false;
        }

    }
}
