org.jahia.services.render

Class BundleView

java.lang.Object

org.jahia.services.render.BaseView

org.jahia.services.render.BundleView

All Implemented Interfaces:

Comparable<View>, View

public class BundleView
extends BaseView

Implementation of a view, located in an OSGi bundle.

Field Summary

Fields inherited from interface org.jahia.services.render.View

DEFAULT_VIEW_KEY, TYPE_KEY, VISIBLE_FALSE, VISIBLE_KEY, VISIBLE_STUDIO_ONLY

Constructor Summary

Constructors

Constructor and Description
BundleView(String resource, String key, JahiaTemplatesPackage module, String displayName) Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
org.osgi.framework.Bundle	getBundle()
BundleSourceResourceResolver	getBundleSourceResourceResolver()
InputStream	getInputStream() Returns an input stream for the view resource or null if the resource does not exist.
protected InputStream	getInputStream(String resource) Returns an input stream for the specified resource or null if the resource does not exist.
String	getPath()
String	getResource()
protected URL	getResource(String resource)
protected String	getResourcePath(String resource) Obtains the path for the specified resource which can be used to read it using corresponding script, e.g.
int	hashCode()

Methods inherited from class org.jahia.services.render.BaseView

compareTo, getDefaultProperties, getDisplayName, getFileExtension, getInfo, getKey, getModule, getModuleVersion, getProperties, loadProperties, setDefaultProperties, setProperties, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BundleView

public BundleView(String resource,
                  String key,
                  JahiaTemplatesPackage module,
                  String displayName)

Initializes an instance of this class.

Parameters:

resource - the resource path in the underlying OSGi bundle

key - the key of the view

module - corresponding JahiaTemplatesPackage instance

displayName - the display name for this view

Method Detail

getPath

public String getPath()

Specified by:

getPath in interface View

Overrides:

getPath in class BaseView

equals

public boolean equals(Object o)

Overrides:

equals in class BaseView

getBundle

public org.osgi.framework.Bundle getBundle()

getBundleSourceResourceResolver

public BundleSourceResourceResolver getBundleSourceResourceResolver()

getInputStream

public InputStream getInputStream()
                           throws IOException

Returns an input stream for the view resource or null if the resource does not exist.

Returns:

an input stream for the view resource or null if the resource does not exist

Throws:

IOException - in case of an I/O errors

getInputStream

protected InputStream getInputStream(String resource)
                              throws IOException

Description copied from class: BaseView

Returns an input stream for the specified resource or null if the resource does not exist.

Specified by:

getInputStream in class BaseView

Parameters:

resource - the resource path to obtain input stream for

Returns:

an input stream for the specified resource or null if the resource does not exist

Throws:

IOException - in case of an I/O errors

getResource

public String getResource()

getResource

protected URL getResource(String resource)

Specified by:

getResource in class BaseView

getResourcePath

protected String getResourcePath(String resource)

Description copied from class: BaseView

Obtains the path for the specified resource which can be used to read it using corresponding script, e.g. request dispatcher. If the resource does not exist, return null.

Specified by:

getResourcePath in class BaseView

Parameters:

resource - the resource to get the path for

Returns:

the path for the specified resource which can be used to read it using corresponding script, e.g. request dispatcher. If the resource does not exist, return null

hashCode

public int hashCode()

Overrides:

hashCode in class BaseView