ClassPathResource (CodeNarc 2.1.0 API)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

org.codenarc.util.io.ClassPathResource

All Implemented Interfaces and Traits:

Resource
```
class ClassPathResource
extends java.lang.Object
```
A Resource implementation for resources available on the classpath.
This class also provides a static InputStream getInputStream(String path) convenience method.
This is an internal class and its API is subject to change.
Authors:
Chris Mair

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`path`

Constructor Summary

Constructors
Constructor and description
`ClassPathResource (java.lang.String path)` Construct a new ClassPathResource path: - the path to the resource (file).

Methods Summary

Methods
Type Params	Return Type	Name and description
	`boolean`	`exists()` @return true only if this resource exists and is accessible
	`static java.io.InputStream`	`getInputStream(java.lang.String path)` Convenience method to open an InputStream on the specified resource path relative the classpath path: - the path to the resource (file).
	`java.io.InputStream`	`getInputStream()` Open an InputStream on the classpath resource path

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - final java.lang.String path
- Constructor Detail
  - ClassPathResource(java.lang.String path)
    
    Construct a new ClassPathResource
    path:
    - the path to the resource (file). The path is relative to the classpath, by default, but may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute path on the filesystem), or "http:". The path must not be empty or null.
- Method Detail
  - @java.lang.Override boolean exists()
    
    Returns:
    true only if this resource exists and is accessible
  - static java.io.InputStream getInputStream(java.lang.String path)
    
    Convenience method to open an InputStream on the specified resource path relative the classpath
    path:
    - the path to the resource (file). The path is relative to the classpath, by default, but may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute path on the filesystem), or "http:". The path must not be empty or null.
    throws:
    IOException - if an error occurs opening the InputStream
  - @java.lang.Override java.io.InputStream getInputStream()
    
    Open an InputStream on the classpath resource path
    throws:
    IOException - if an error occurs opening the InputStream

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation