WrappingExtension (XWiki Commons - Extension

java.lang.Object
- org.xwiki.script.wrap.AbstractWrappingObject<T>
- - org.xwiki.extension.wrap.AbstractWrappingObject<E>
  - - org.xwiki.extension.wrap.WrappingExtension<E>

Type Parameters:

E - the extension type

All Implemented Interfaces:

Comparable<Extension>, Extension

Direct Known Subclasses:

WrappingCoreExtension, WrappingLocalExtension, WrappingRemoteExtension
```
public class WrappingExtension<E extends Extension>
extends AbstractWrappingObject<E>
implements Extension
```
Wrap an extension.

Since:

4.0M1

Version:

$Id: 2c2b2b6ae4f206d10a1ff1265552a3410d2d198c $

Field Summary

Fields
Modifier and Type Field and Description

protected Map<String,Object> overwrites
- Fields inherited from interface org.xwiki.extension.Extension
  FIELD_ALLOWEDNAMESPACE, FIELD_ALLOWEDNAMESPACES, FIELD_AUTHOR, FIELD_AUTHORS, FIELD_CATEGORY, FIELD_DEPENDENCIES, FIELD_DESCRIPTION, FIELD_EXTENSIONFEATURE, FIELD_EXTENSIONFEATURES, FIELD_FEATURE, FIELD_FEATURES, FIELD_ID, FIELD_ISSUEMANAGEMENT, FIELD_LICENSE, FIELD_LICENSES, FIELD_MANAGEDDEPENDENCIES, FIELD_NAME, FIELD_NAMESPACES, FIELD_PROPERTIES, FIELD_REPOSITORIES, FIELD_REPOSITORY, FIELD_SCM, FIELD_SUMMARY, FIELD_TYPE, FIELD_VERSION, FIELD_WEBSITE, IKEYPREFIX

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`overwrites`

Constructor Summary

Constructors
Constructor and Description

WrappingExtension(E extension)

Constructors
Constructor and Description
`WrappingExtension(E extension)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`compareTo(Extension o)`
`<T> T`	`get(String fieldName)` Get an extension field (name, summary, id, etc.) by name.
`Collection<String>`	`getAllowedNamespaces()`
`Collection<ExtensionAuthor>`	`getAuthors()`
`String`	`getCategory()`
`Collection<ExtensionDependency>`	`getDependencies()`
`String`	`getDescription()`
`ExtensionId`	`getExtensionFeature(String featureId)` Return the `ExtensionId` object that matches the passed feature id.
`Collection<ExtensionId>`	`getExtensionFeatures()` Indicate in an extension a list of provided "functionalities".
`Collection<String>`	`getFeatures()` Deprecated.
`ExtensionFile`	`getFile()` Return extension file descriptor.
`ExtensionId`	`getId()`
`ExtensionIssueManagement`	`getIssueManagement()`
`Collection<ExtensionLicense>`	`getLicenses()`
`Collection<ExtensionDependency>`	`getManagedDependencies()` Managed dependencies are used to override transitive dependencies (usually the version of this transitive dependency).
`String`	`getName()`
`Map<String,Object>`	`getProperties()` Extends `Extension` standard properties.
`<T> T`	`getProperty(String key)`
`<T> T`	`getProperty(String key, T def)` Get a property.
`Collection<ExtensionRepositoryDescriptor>`	`getRepositories()`
`ExtensionRepository`	`getRepository()`
`ExtensionScm`	`getScm()`
`String`	`getSummary()`
`String`	`getType()`
`String`	`getWebSite()`
`void`	`setOverwrite(String key, Object value)`

Methods inherited from class org.xwiki.script.wrap.AbstractWrappingObject
equals, getWrapped, hashCode, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - overwrites
```
protected Map<String,Object> overwrites
```
- Constructor Detail
  - WrappingExtension
```
public WrappingExtension(E extension)
```
    Parameters:
    
    extension - the wrapped extension
- Method Detail
  - setOverwrite
```
public void setOverwrite(String key,
                         Object value)
```
    Parameters:
    
    key - the key associated to the Extension field (usually found in Extension constants) to overwrite
    
    value - the value to overwrite
    
    Since:
    
    9.0RC1, 8.4.2
  - get
```
public <T> T get(String fieldName)
```
    Description copied from interface: Extension
    
    Get an extension field (name, summary, id, etc.) by name. Fallback on properties.
    
    Specified by:
    
    get in interface Extension
    
    Type Parameters:
    
    T - type of the field value
    
    Parameters:
    
    fieldName - the field name;
    
    Returns:
    
    the field value or null if none could be found
  - getId
```
public ExtensionId getId()
```
    Specified by:
    
    getId in interface Extension
    
    Returns:
    
    the id/version combination which makes the extension unique
  - getFeatures
```
@Deprecated
public Collection<String> getFeatures()
```
    Deprecated.
    
    Description copied from interface: Extension
    
    Indicate in an extension a list of provided "functionalities". Then when resolving extensions dependencies they can be matched in this list.
    
    Specified by:
    
    getFeatures in interface Extension
    
    Returns:
    
    the extension ids also provided by this extension, an empty collection if there is none
  - getExtensionFeatures
```
public Collection<ExtensionId> getExtensionFeatures()
```
    Description copied from interface: Extension
    
    Indicate in an extension a list of provided "functionalities". Then when resolving extensions dependencies they can be matched in this list.
    
    Specified by:
    
    getExtensionFeatures in interface Extension
    
    Returns:
    
    the ExtensionIds also provided by this extension, an empty collection if there is none
  - getExtensionFeature
```
public ExtensionId getExtensionFeature(String featureId)
```
    Description copied from interface: Extension
    
    Return the ExtensionId object that matches the passed feature id.
    
    Specified by:
    
    getExtensionFeature in interface Extension
    
    Parameters:
    
    featureId - the id of the feature
    
    Returns:
    
    the ExtensionId associated to the passed id
  - getType
```
public String getType()
```
    Specified by:
    
    getType in interface Extension
    
    Returns:
    
    the type of the extension
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface Extension
    
    Returns:
    
    the display name of the extension
  - getLicenses
```
public Collection<ExtensionLicense> getLicenses()
```
    Specified by:
    
    getLicenses in interface Extension
    
    Returns:
    
    the license of the extension, an empty collection if there is none
  - getSummary
```
public String getSummary()
```
    Specified by:
    
    getSummary in interface Extension
    
    Returns:
    
    a short description of the extension
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface Extension
    
    Returns:
    
    a description of the extension
  - getWebSite
```
public String getWebSite()
```
    Specified by:
    
    getWebSite in interface Extension
    
    Returns:
    
    an URL for the extension website
  - getAuthors
```
public Collection<ExtensionAuthor> getAuthors()
```
    Specified by:
    
    getAuthors in interface Extension
    
    Returns:
    
    the extension authors, an empty collection if there is none
  - getAllowedNamespaces
```
public Collection<String> getAllowedNamespaces()
```
    Specified by:
    
    getAllowedNamespaces in interface Extension
    
    Returns:
    
    the namespaces where it's allowed to install this extension
  - getDependencies
```
public Collection<ExtensionDependency> getDependencies()
```
    Specified by:
    
    getDependencies in interface Extension
    
    Returns:
    
    the dependencies of the extension, an empty collection if there is none
  - getManagedDependencies
```
public Collection<ExtensionDependency> getManagedDependencies()
```
    Description copied from interface: Extension
    
    Managed dependencies are used to override transitive dependencies (usually the version of this transitive dependency).
    
    Specified by:
    
    getManagedDependencies in interface Extension
    
    Returns:
    
    the managed dependencies, empty list if there is none
  - getFile
```
public ExtensionFile getFile()
```
    Description copied from interface: Extension
    
    Return extension file descriptor. Also allows to get the content of the file.
    
    Specified by:
    
    getFile in interface Extension
    
    Returns:
    
    the file of the extension
  - getRepository
```
public ExtensionRepository getRepository()
```
    Specified by:
    
    getRepository in interface Extension
    
    Returns:
    
    the repository of the extension
  - getScm
```
public ExtensionScm getScm()
```
    Specified by:
    
    getScm in interface Extension
    
    Returns:
    
    informations related to extensions's source control management
  - getIssueManagement
```
public ExtensionIssueManagement getIssueManagement()
```
    Specified by:
    
    getIssueManagement in interface Extension
    
    Returns:
    
    informations related to extension's issues management
  - getCategory
```
public String getCategory()
```
    Specified by:
    
    getCategory in interface Extension
    
    Returns:
    
    the category of the extension
  - getRepositories
```
public Collection<ExtensionRepositoryDescriptor> getRepositories()
```
    Specified by:
    
    getRepositories in interface Extension
    
    Returns:
    
    the custom repositories provided by the extension (usually to resolve dependencies)
  - getProperties
```
public Map<String,Object> getProperties()
```
    Description copied from interface: Extension
    
    Extends Extension standard properties.
    Theses are generally provided by specific repositories. For example a maven repository will provide group and artifacts ids.
    
    Specified by:
    
    getProperties in interface Extension
    
    Returns:
    
    the properties
  - getProperty
```
public <T> T getProperty(String key)
```
    Specified by:
    
    getProperty in interface Extension
    
    Type Parameters:
    
    T - type of the property value
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the property value
  - getProperty
```
public <T> T getProperty(String key,
                         T def)
```
    Description copied from interface: Extension
    
    Get a property.
    
    Specified by:
    
    getProperty in interface Extension
    
    Type Parameters:
    
    T - type of the property value
    
    Parameters:
    
    key - the property key
    
    def - the value to return if no property is associated to the provided key
    
    Returns:
    
    the property value or default of the property is not found
    
    See Also:
    
    Extension.getProperty(String)
  - compareTo
```
public int compareTo(Extension o)
```
    Specified by:
    
    compareTo in interface Comparable<Extension>

Class WrappingExtension<E extends Extension>

Field Summary

Fields inherited from interface org.xwiki.extension.Extension

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

overwrites

Constructor Detail

WrappingExtension

Method Detail

setOverwrite

get

getId

getFeatures

getExtensionFeatures

getExtensionFeature

getType

getName

getLicenses

getSummary

getDescription

getWebSite

getAuthors

getAllowedNamespaces

getDependencies

getManagedDependencies

getFile

getRepository

getScm

getIssueManagement

getCategory

getRepositories

getProperties

getProperty

getProperty

compareTo