org.apache.brooklyn.ui.modularity.module.api.internal

Class UiModuleImpl

java.lang.Object

org.apache.brooklyn.ui.modularity.module.api.internal.UiModuleImpl

All Implemented Interfaces:

UiModule

public class UiModuleImpl
extends java.lang.Object
implements UiModule

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.ui.modularity.module.api.UiModule

UiModule.Utils

Field Summary

Fields inherited from interface org.apache.brooklyn.ui.modularity.module.api.UiModule

DEFAULT_ICON

Constructor Summary

Constructors

Constructor and Description
UiModuleImpl()

Method Summary

Modifier and Type	Method and Description
UiModuleImpl	action(UiModuleAction action)
static UiModuleImpl	copyOf(UiModule src)
static UiModuleImpl	createFromMap(java.util.Map<java.lang.String,?> incomingMap)
java.util.List<UiModuleAction>	getActions()
java.lang.String	getIcon()
java.lang.String	getId()
java.lang.String	getName()
java.lang.String	getPath()
java.lang.String	getSlug()
boolean	getStopExisting()
java.util.Set<java.lang.String>	getSupersedesBundles()
java.util.Set<java.lang.String>	getTypes()
UiModuleImpl	icon(java.lang.String icon)
UiModuleImpl	id(java.lang.String id)
UiModuleImpl	name(java.lang.String name)
UiModuleImpl	path(java.lang.String path)
void	setActions(java.util.List<UiModuleAction> actions)
void	setIcon(java.lang.String icon)
void	setId(java.lang.String id)
void	setName(java.lang.String name)
void	setPath(java.lang.String path)
void	setSlug(java.lang.String slug)
void	setStopExisting(boolean stopExisting)
void	setSupersedesBundles(java.util.Set<java.lang.String> supersedesBundles)
void	setTypes(java.util.Set<java.lang.String> types)
UiModuleImpl	slug(java.lang.String slug)
UiModuleImpl	types(java.util.Set<java.lang.String> types)

Methods inherited from class java.lang.Object

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

Constructor Detail

UiModuleImpl

public UiModuleImpl()

Method Detail

copyOf

public static UiModuleImpl copyOf(UiModule src)

createFromMap

public static UiModuleImpl createFromMap(java.util.Map<java.lang.String,?> incomingMap)

getId

public java.lang.String getId()

Specified by:

getId in interface UiModule

Returns:

The unique ID of the module

getIcon

public java.lang.String getIcon()

Specified by:

getIcon in interface UiModule

Returns:

The icon to be used for the module

getName

public java.lang.String getName()

Specified by:

getName in interface UiModule

Returns:

The module name

getSlug

public java.lang.String getSlug()

Specified by:

getSlug in interface UiModule

Returns:

The human readable id in form (part1-part2-part3...)

getTypes

public java.util.Set<java.lang.String> getTypes()

Specified by:

getTypes in interface UiModule

Returns:

The module types eg single-page-app, external-ui

getSupersedesBundles

public java.util.Set<java.lang.String> getSupersedesBundles()

Specified by:

getSupersedesBundles in interface UiModule

Returns:

List of "bundle-regex" or "bundle-regex:version-regex" of bundles that should be stopped when this is installed. Useful if supplying a bundle to replace other bundles.

getStopExisting

public boolean getStopExisting()

Specified by:

getStopExisting in interface UiModule

Returns:

Whether to web-stop any bundles listening on the same endpoint.

getPath

public java.lang.String getPath()

Specified by:

getPath in interface UiModule

Returns:

The module path

getActions

public java.util.List<UiModuleAction> getActions()

Specified by:

getActions in interface UiModule

Returns:

Registered module actions

setId

public void setId(java.lang.String id)

setIcon

public void setIcon(java.lang.String icon)

setName

public void setName(java.lang.String name)

setSlug

public void setSlug(java.lang.String slug)

setTypes

public void setTypes(java.util.Set<java.lang.String> types)

setSupersedesBundles

public void setSupersedesBundles(java.util.Set<java.lang.String> supersedesBundles)

setStopExisting

public void setStopExisting(boolean stopExisting)

setPath

public void setPath(java.lang.String path)

setActions

public void setActions(java.util.List<UiModuleAction> actions)

id

public UiModuleImpl id(java.lang.String id)

icon

public UiModuleImpl icon(java.lang.String icon)

name

public UiModuleImpl name(java.lang.String name)

slug

public UiModuleImpl slug(java.lang.String slug)

types

public UiModuleImpl types(java.util.Set<java.lang.String> types)

path

public UiModuleImpl path(java.lang.String path)

action

public UiModuleImpl action(UiModuleAction action)