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.commons.codec;
19  
20  import java.io.InputStream;
21  
22  /**
23   * Consider this class package private. Helps load resources.
24   *
25   * @since 1.12
26   */
27  public class Resources {
28  
29      /**
30       * Opens the given named resource from the given class.
31       *
32       * @param name The resource name.
33       * @return An input stream.
34       */
35      public static InputStream getInputStream(final String name) {
36          final InputStream inputStream = Resources.class.getClassLoader().getResourceAsStream(name);
37          if (inputStream == null) {
38              throw new IllegalArgumentException("Unable to resolve required resource: " + name);
39          }
40          return inputStream;
41      }
42  
43      /**
44       * TODO Make private in 2.0.
45       *
46       * @deprecated TODO Make private in 2.0.
47       */
48      @Deprecated
49      public Resources() {
50          // empty
51      }
52  }