001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      https://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.codec;
019
020import java.io.InputStream;
021
022/**
023 * Consider this class package private. Helps load resources.
024 *
025 * @since 1.12
026 */
027public class Resources {
028
029    /**
030     * 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
031     * class's class loader.
032     *
033     * @param name The resource name.
034     * @return An input stream.
035     * @see ClassLoader#getResourceAsStream(String)
036     */
037    public static InputStream getInputStream(final String name) {
038        // Use java.lang.Class.getResourceAsStream(String) to make JPMS happy
039        final InputStream inputStream = Resources.class.getResourceAsStream(name);
040        if (inputStream == null) {
041            throw new IllegalArgumentException("Unable to resolve required resource: " + name);
042        }
043        return inputStream;
044    }
045
046    /**
047     * TODO Make private in 2.0.
048     *
049     * @deprecated TODO Make private in 2.0.
050     */
051    @Deprecated
052    public Resources() {
053        // empty
054    }
055}