org.xwiki.extension.wrap

Class WrappingInstalledExtension<E extends InstalledExtension>

java.lang.Object

org.xwiki.extension.wrap.AbstractWrappingObject<E>

org.xwiki.extension.wrap.WrappingExtension<T>

org.xwiki.extension.wrap.WrappingLocalExtension<E>

org.xwiki.extension.wrap.WrappingInstalledExtension<E>

Type Parameters:

E - the extension type

All Implemented Interfaces:

Extension, InstalledExtension, LocalExtension

public class WrappingInstalledExtension<E extends InstalledExtension>
extends WrappingLocalExtension<E>
implements InstalledExtension

Wrap a local extension.

Since:

4.0M2

Version:

$Id: 55994a5c8e5306ec437e70b71a8b25b3fcf67f4f $

Field Summary

Fields inherited from interface org.xwiki.extension.InstalledExtension

PKEY_DEPENDENCY, PKEY_INSTALLED, PKEY_NAMESPACES, PKEY_NAMESPACES_DEPENDENCY, PKEY_NAMESPACES_NAMESPACE

Fields inherited from interface org.xwiki.extension.LocalExtension

PKEY_FILE

Constructor Summary

Constructors

Constructor and Description
WrappingInstalledExtension(E localExtension)

Method Summary

Methods

Modifier and Type	Method and Description
LocalExtension	getLocalExtension()
Collection<String>	getNamespaces()
boolean	isDependency() Indicate if the extension as been installed as a dependency of another one.
boolean	isDependency(String namespace) Indicate if the extension as been installed as a dependency of another one.
boolean	isInstalled()
boolean	isInstalled(String namespace) Indicate if the extension is installed in the provided namespace.
boolean	isValid(String namespace) Indicate if the extension is working.

Methods inherited from class org.xwiki.extension.wrap.WrappingLocalExtension

getFile

Methods inherited from class org.xwiki.extension.wrap.WrappingExtension

getAuthors, getDependencies, getDescription, getFeatures, getId, getIssueManagement, getLicenses, getName, getProperties, getProperty, getProperty, getRepository, getScm, getSummary, getType, getWebSite

Methods inherited from class org.xwiki.extension.wrap.AbstractWrappingObject

equals, getWrapped, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.extension.LocalExtension

getFile

Methods inherited from interface org.xwiki.extension.Extension

getAuthors, getDependencies, getDescription, getFeatures, getId, getIssueManagement, getLicenses, getName, getProperties, getProperty, getProperty, getRepository, getScm, getSummary, getType, getWebSite

Constructor Detail

WrappingInstalledExtension

public WrappingInstalledExtension(E localExtension)

Parameters:

localExtension - the wrapped local extension

Method Detail

getLocalExtension

public LocalExtension getLocalExtension()

Specified by:

getLocalExtension in interface InstalledExtension

Returns:

the actual extension

isInstalled

public boolean isInstalled()

Specified by:

isInstalled in interface InstalledExtension

Returns:

indicate if the extension is installed

isValid

public boolean isValid(String namespace)

Description copied from interface: InstalledExtension

Indicate if the extension is working.

An installed extension can be invalid for example when one of the core extensions has been changed and is now incompatible with this installed extension.

Specified by:

isValid in interface InstalledExtension

Parameters:

namespace - the namespace to look at, if null it means the extension is installed on the root namespace

Returns:

true is valid

isInstalled

public boolean isInstalled(String namespace)

Description copied from interface: InstalledExtension

Indicate if the extension is installed in the provided namespace.

Specified by:

isInstalled in interface InstalledExtension

Parameters:

namespace - the namespace to look at, if null it means the extension is installed on the root namespace

Returns:

true if the extension is installed in the provided namespace

getNamespaces

public Collection<String> getNamespaces()

Specified by:

getNamespaces in interface InstalledExtension

Returns:

the namespaces in which this extension is enabled. null means root namespace (i.e all namespaces).

isDependency

public boolean isDependency()

Description copied from interface: InstalledExtension

Indicate if the extension as been installed as a dependency of another one.

The idea is to be able to make the difference between extension specifically installed by a user so that it's possible to know which extension are not really required anymore.

Specified by:

isDependency in interface InstalledExtension

Returns:

true if the the extension has been installed only because it was a dependency of another extension

isDependency

public boolean isDependency(String namespace)

Description copied from interface: InstalledExtension

Indicate if the extension as been installed as a dependency of another one.

The idea is to be able to make the difference between extension specifically installed by a user so that it's possible to know which extension are not really required anymore.

Specified by:

isDependency in interface InstalledExtension

Parameters:

namespace - the namespace to look at, null indicate the root namespace

Returns:

true if the the extension has been installed only because it was a dependency of another extension