View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software 
12   * distributed under the License is distributed on an "AS IS" BASIS, 
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
14   * See the License for the specific language governing permissions and 
15   * limitations under the License.
16   */
17  
18  package org.apache.jdo.impl.enhancer.util;
19  
20  import java.io.InputStream;
21  
22  
23  /***
24   * Provides a method for searching resources.
25   */
26  public interface ResourceLocator
27  {
28      /***
29       * Finds a resource with a given name.  This method returns
30       * <code>null</code> if no resource with this name is found.
31       * The name of a resource is a "/"-separated path name.
32       */
33      //^olsen: would be better to throw an IOException instead of a
34      // RuntimeException but currently not supported by the JDOModel's
35      // JavaModel interface
36      InputStream getInputStreamForResource(String resourceName);
37  }