/**
 * 最初の著者:: トゥイー
 * リポジトリ情報:: $Id: CloseContainer.hpp 11 2011-05-14 02:11:18Z yutaka_at_home $
 * 著作権:: Copyright (C) Ownway.info, 2011. All rights reserved.
 * ライセンス:: CPL(Common Public Licence)
 */

#ifndef _UTILITY_CONTAINER_HPP_
#define _UTILITY_CONTAINER_HPP_

#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>

namespace Utility {

	class CloseContainerElement;
	class CloseRelation;
	typedef boost::shared_ptr<CloseRelation> CloseRelationPtr;

	/**
	 * 全ての密コンテナのルートクラスです。
	 * 密コンテナは、密コンテナ要素と密関連を持つコンテナです。
     * 密コンテナ開発者は、密コンテナが密コンテナ要素と密関連するときに addRelation メソッドを呼び出す必要があります。
	 *
	 * @author トゥイー
	 */
	class CloseContainer : public boost::noncopyable {
	public:
		/**
		 * 密コンテナを破棄します。
		 */
		virtual ~CloseContainer();

	protected:
		/**
         * 密コンテナ要素と密関連します。
         * 子クラスは、密コンテナ要素と密関連するときにこのメソッドを呼び出す必要があります。
         * このメソッドはオーバーライドして使用することを想定していません。
		 *
		 * @param element 密コンテナ要素。
		 * @param relation element との密関連。null 不可。
		 */
		void addRelation(CloseContainerElement& element, const CloseRelationPtr& relation);
	};

}  // namespace Utility

#endif
