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 * https://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 * Gets a read-only stream on the contents of the resource specified by resName. The mapping between the resource name and the stream is managed by this
31 * class's class loader.
32 *
33 * @param name The resource name.
34 * @return An input stream.
35 * @see ClassLoader#getResourceAsStream(String)
36 */
37 public static InputStream getInputStream(final String name) {
38 // Use java.lang.Class.getResourceAsStream(String) to make JPMS happy
39 final InputStream inputStream = Resources.class.getResourceAsStream(name);
40 if (inputStream == null) {
41 throw new IllegalArgumentException("Unable to resolve required resource: " + name);
42 }
43 return inputStream;
44 }
45
46 /**
47 * TODO Make private in 2.0.
48 *
49 * @deprecated TODO Make private in 2.0.
50 */
51 @Deprecated
52 public Resources() {
53 // empty
54 }
55 }