org.raml.v2.api.loader

Class ClassPathResourceLoader

java.lang.Object

org.raml.v2.api.loader.ClassPathResourceLoader

All Implemented Interfaces:

ResourceLoader, ResourceLoaderExtended

public class ClassPathResourceLoader
extends Object
implements ResourceLoaderExtended

Constructor Summary

Constructors

Constructor and Description
ClassPathResourceLoader()
ClassPathResourceLoader(String rootRamlPackage) When the root raml is loaded through the classpath allows specifying the package where it is loaded from in order to correctly resolve absolute path includes and libraries

Method Summary

Modifier and Type	Method and Description
InputStream	fetchResource(String resourceName) Returns an input stream for reading the specified resource.
InputStream	fetchResource(String resourceName, ResourceUriCallback callback) Returns an input stream for reading the specified resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClassPathResourceLoader

public ClassPathResourceLoader()

ClassPathResourceLoader

public ClassPathResourceLoader(String rootRamlPackage)

When the root raml is loaded through the classpath allows specifying the package where it is loaded from in order to correctly resolve absolute path includes and libraries

Parameters:

rootRamlPackage - in the classpath

Method Detail

fetchResource

@Nullable
public InputStream fetchResource(String resourceName,
                                           ResourceUriCallback callback)

Description copied from interface: ResourceLoaderExtended

Returns an input stream for reading the specified resource.

Specified by:

fetchResource in interface ResourceLoaderExtended

Parameters:

resourceName - the resource to try to fetch

Returns:

An input stream for reading the resource, or null if the resource could not be found

fetchResource

public InputStream fetchResource(String resourceName)

Description copied from interface: ResourceLoader

Returns an input stream for reading the specified resource.

Specified by:

fetchResource in interface ResourceLoader

Parameters:

resourceName - the resource to try to fetch

Returns:

An input stream for reading the resource, or null if the resource could not be found