Package com.adobe.granite.contexthub.api

Class Module

java.lang.Object

com.adobe.granite.contexthub.api.Module

public class Module
extends Object

Constructor Summary

Constructors

Constructor	Description
Module(Resource resource)	Constructs a module with properties from the given resource.

Method Summary

Modifier and Type	Method	Description
List<String>	getCategories()	Get the clientlib categories that should be included for this module.
String	getName()	Get the name of this module.
String	getPath()	Get the path where this module is defined.
ValueMap	getProperties()	Get all properties of this module.
Resource	getResource()	Get the resource which describes this module.
String	getResourceType()	Get the resourceType of this module.
Set<String>	getRunModes()	Returns list of run modes in which module should be available.
String	getTheme()	Get the theme this module uses.
boolean	isEnabled()	Whether this module should be enabled or not.

Methods inherited from class java.lang.Object

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

Constructor Details

Module

public Module(Resource resource)

Constructs a module with properties from the given resource.

Parameters:

resource - the resource used to construct a module from

Method Details

getRunModes

public Set<String> getRunModes()

Returns list of run modes in which module should be available.

Returns:

list of run modes

isEnabled

public boolean isEnabled()

Whether this module should be enabled or not.

Returns:

true if this module should be enabled

getTheme

public String getTheme()

Get the theme this module uses.

Returns:

the theme

getName

public String getName()

Get the name of this module.

Returns:

the name

getResourceType

public String getResourceType()

Get the resourceType of this module.

Returns:

the resourceType

getProperties

public ValueMap getProperties()

Get all properties of this module.

Returns:

the properties

getResource

public Resource getResource()

Get the resource which describes this module.

Returns:

the resource

getPath

public String getPath()

Get the path where this module is defined.

Returns:

the path

getCategories

public List<String> getCategories()

Get the clientlib categories that should be included for this module.

Returns:

the clientlib categories