// 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.ExceptionTransition
{
    /// <summary>
    /// exceptionTransition 要素のコレクションを格納する構成要素を表します。
    /// </summary>
    /// <remarks>
    /// <see cref="ExceptionTransitionCollection"/> は、エラー画面遷移設定ファイル内の exceptionTransition 要素のコレクションを表します。 
    /// 詳細については <see cref="ConfigurationElementCollection"/> を参照してください。
    /// </remarks>
    public class ExceptionTransitionCollection : ConfigurationElementCollection
    {
        /// <summary>
        /// <see cref="ILog"/> 実装クラスのインスタンスです。
        /// </summary>
        /// <remarks>
        /// ログ出力に利用します。
        /// </remarks>
        private static ILog _log = LogFactory.GetLogger(typeof(ExceptionTransitionCollection));

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

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

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

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

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

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

        /// <summary>
        /// エラー画面遷移設定ファイル内のこの要素のコレクションを識別するために使用する名前を取得します。
        /// </summary>
        /// <value>
        /// コレクションを識別するために使用する名前。
        /// </value>
        /// <remarks>
        /// コレクションを識別するために使用する名前は、 "exceptionTransition" です。
        /// </remarks>
        protected override string ElementName
        {
            get
            {
                return "exceptionTransition";
            }
        }

        /// <summary>
        /// exceptionTransition 要素の要素キーを取得します。
        /// </summary>
        /// <param name="element">キーを返す <see cref="ExceptionTransitionElement"/> 。</param>
        /// <returns>指定した <see cref="ExceptionTransitionElement"/> のキーとして機能する <see cref="Object"/> 。</returns>
        /// <exception cref="System.ArgumentNullException">
        /// <paramref name="element"/> が null 参照です。
        /// </exception>
        /// <exception cref="ArgumentException">
        /// <paramref name="element"/> が <see cref="ExceptionTransitionElement"/> ではありません。
        /// </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;
            }
            ExceptionTransitionElement exTransElement = element as ExceptionTransitionElement;
            if (exTransElement == 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 exTransElement.ExceptionType;
        }

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

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

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