Core/Castle.Core/Resource/IResourceFactory.cs

   1 // Copyright 2004-2008 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.Core.Resource
  16 {
  17         using System;
  18
  19         /// <summary>
  20         /// Depicts the contract for resource factories.
  21         /// </summary>
  22         public interface IResourceFactory
  23         {
  24                 /// <summary>
  25                 /// Used to check whether the resource factory
  26                 /// is able to deal with the given resource
  27                 /// identifier.
  28                 /// </summary>
  29                 /// <remarks>
  30                 /// Implementors should return <c>true</c>
  31                 /// only if the given identificator is supported
  32                 /// by the resource factory
  33                 /// </remarks>
  34                 /// <param name="uri"></param>
  35                 /// <returns></returns>
  36                 bool Accept(CustomUri uri);
  37
  38                 /// <summary>
  39                 /// Creates an <see cref="IResource"/> instance
  40                 /// for the given resource identifier
  41                 /// </summary>
  42                 /// <param name="uri"></param>
  43                 /// <returns></returns>
  44                 IResource Create(CustomUri uri);
  45
  46                 /// <summary>
  47                 /// Creates an <see cref="IResource"/> instance
  48                 /// for the given resource identifier
  49                 /// </summary>
  50                 /// <param name="uri"></param>
  51                 /// <param name="basePath"></param>
  52                 /// <returns></returns>
  53                 IResource Create(CustomUri uri, String basePath);
  54         }
  55 }