com.atlassian.jira.io

Interface ResourceLoader

All Known Implementing Classes:

ClassPathResourceLoader

@ParametersAreNonnullByDefault
public interface ResourceLoader

Provides ability to load resources from JIRA Core or plugins class loader. Use this one whenever you want to be sure that loaded resource is from JIRA Core or given plugin. Paths to resources should always be absolute not relative.

Since:

v6.5

Method Summary

Modifier and Type	Method and Description
io.atlassian.fugue.Option<URL>	getResource(com.atlassian.plugin.Plugin plugin, String resourcePath) Opens URL to given resource from plugin.
io.atlassian.fugue.Option<URL>	getResource(String resourcePath) Opens URL to given resource from JIRA Core.
io.atlassian.fugue.Option<InputStream>	getResourceAsStream(com.atlassian.plugin.Plugin plugin, String resourcePath) Opens stream to given resource from plugin.
io.atlassian.fugue.Option<InputStream>	getResourceAsStream(String resourcePath) Opens stream to given resource from JIRA Core.

Method Detail

getResourceAsStream

io.atlassian.fugue.Option<InputStream> getResourceAsStream(String resourcePath)

Opens stream to given resource from JIRA Core. See Class.getResourceAsStream(String) for exact semantics.

Parameters:

resourcePath - path to resource

Returns:

some of inputStream if resource exists none otherwise.

getResource

io.atlassian.fugue.Option<URL> getResource(String resourcePath)

Opens URL to given resource from JIRA Core. See Class.getResource(String) for exact semantics.

Parameters:

resourcePath - path to resource

Returns:

some of URL if resource exists none otherwise.

getResourceAsStream

io.atlassian.fugue.Option<InputStream> getResourceAsStream(com.atlassian.plugin.Plugin plugin,
                                                           String resourcePath)

Opens stream to given resource from plugin. See Class.getResourceAsStream(String) for exact semantics.

Parameters:

resourcePath - path to resource

Returns:

some of inputStream if resource exists none otherwise.

getResource

io.atlassian.fugue.Option<URL> getResource(com.atlassian.plugin.Plugin plugin,
                                           String resourcePath)

Opens URL to given resource from plugin. See Class.getResource(String) for exact semantics.

Parameters:

resourcePath - path to resource

Returns:

some of URL if resource exists none otherwise.