nz.net.ultraq.groovy.extensions.ResourceExtensions.groovy Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of groovy-extensions Show documentation

A collection of extensions for Groovy projects that I almost wish were a part of the GDK

The newest version!

/*
 * Copyright 2020, Emanuel Rabina (http://www.ultraq.net.nz/)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package nz.net.ultraq.groovy.extensions

/**
 * Extensions to classes to be able to read resources more easily.
 *
 * @author Emanuel Rabina
 */
class ResourceExtensions {

	/**
	 * A shortcut to {@code new File(ClassLoader.getResource.toURI())}.
	 *
	 * @param self
	 * @param resourcePath
	 * @return
	 */
	static File getResourceAsFile(Object self, String resourcePath) {

		var resource = self.class.classLoader.getResource(resourcePath)
		if (resource) {
			return new File(resource.toURI())
		}
		throw new IllegalArgumentException("Resource not found: ${resourcePath}")
	}

	/**
	 * A shortcut to {@code ClassLoader.getResourceAsStream}.
	 *
	 * @param self
	 * @param resourcePath
	 * @return
	 */
	static InputStream getResourceAsStream(Object self, String resourcePath) {

		def inputStream = self.class.classLoader.getResourceAsStream(resourcePath)
		if (inputStream) {
			return inputStream
		}
		throw new IllegalArgumentException("Resource not found: ${resourcePath}")
	}

	/**
	 * A combination {@link #getResourceAsStream} followed by a {@code .getText()}
	 * call.
	 *
	 * @param self
	 * @param resourcePath
	 * @return
	 */
	static String getResourceAsText(Object self, String resourcePath) {

		return getResourceAsStream(self, resourcePath).withCloseable { it.text }
	}
}