com.communote.server.web.commons.resource

Class ResourceCategoryDefinition

java.lang.Object

com.communote.server.web.commons.resource.ResourceCategoryDefinition

public class ResourceCategoryDefinition
extends Object

Object that defines a JavaScript or CSS category with initial resources.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
ResourceCategoryDefinition(String categoryName, List<String> coreResources, List<String> pluginResources) Create a new category definition.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCategoryName()
List<String>	getCoreResources() Return a collection of resources which are delivered with the application and should be added first when rendering the resources of this category.
List<String>	getPluginResources() Return the initial resources of this category that are provided by the plugin and should be included after the coreResources when rendering the category's resources.
String	getPropertyResourceFallback() Return a fallback plugin resource to be used if hasPropertyResource() returns true but the PluginProperty does not exist.
int	hashCode()
boolean	hasPropertyResource() Whether the category definition supports providing a resource with the help of a PluginProperty.
void	setPropertyResource(boolean propertyResource) Set whether there can be a PluginProperty providing a resource
void	setPropertyResourceFallback(String propertyResourceFallback) Set a fallback plugin resource to be used if hasPropertyResource() returns true but the PluginProperty does not exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceCategoryDefinition

public ResourceCategoryDefinition(String categoryName,
                                  List<String> coreResources,
                                  List<String> pluginResources)

Create a new category definition.

Parameters:

categoryName - the name of the category. This can be the name of an existing built-in category or a new one.

coreResources - a collection of resources which are delivered with the application and should be added first when rendering the resources of this category. Each entry of the collection refers to the relative location of a resource under which it can be downloaded. Can be null if the category needs no core resources.

pluginResources - the initial resources of this category that are provided by the plugin and should be included after the coreResources when rendering the category's resources. The resources are expected to be list of file paths relative to the 'static' directory within the plugin resources directory. Can be null if the category needs no plugin resources.

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getCategoryName

public String getCategoryName()

Returns:

the name of the category defined by this object. This can be the name of an existing built-in category or a new one.

getCoreResources

public List<String> getCoreResources()

Return a collection of resources which are delivered with the application and should be added first when rendering the resources of this category. Each entry of the collection refers to the relative location of a resource under which it can be downloaded.

Returns:

the initial resources of the category that are delivered with the application. Can be null if the category needs no core resources.

getPluginResources

public List<String> getPluginResources()

Return the initial resources of this category that are provided by the plugin and should be included after the coreResources when rendering the category's resources. The resources are expected to be list of file paths relative to the 'static' directory within the plugin resources directory. Can be null if the category needs no plugin resources.

Returns:

the initial plugin resources

getPropertyResourceFallback

public String getPropertyResourceFallback()

Return a fallback plugin resource to be used if hasPropertyResource() returns true but the PluginProperty does not exist.

Returns:

a file path relative to the 'static' directory within the plugin resources directory or null if there is no fallback

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasPropertyResource

public boolean hasPropertyResource()

Whether the category definition supports providing a resource with the help of a PluginProperty. The PluginProperty that holds the resource has the property key 'cssCategoryResource.[categoryName of this definiton]'. In case there is a property resource it will be included after the pluginResources.

Returns:

true if there can be a PluginProperty, false by default

setPropertyResource

public void setPropertyResource(boolean propertyResource)

Set whether there can be a PluginProperty providing a resource

Parameters:

propertyResource - true if there can be a PluginProperty

See Also:

hasPropertyResource()

setPropertyResourceFallback

public void setPropertyResourceFallback(String propertyResourceFallback)

Set a fallback plugin resource to be used if hasPropertyResource() returns true but the PluginProperty does not exist.

Parameters:

propertyResourceFallback - a file path relative to the 'static' directory within the plugin resources directory