Extension (XWiki Commons - Extension

All Known Subinterfaces:

CoreExtension, InstalledExtension, LocalExtension, RatingExtension

All Known Implementing Classes:

AbstractExtension, WrappingCoreExtension, WrappingExtension, WrappingInstalledExtension, WrappingLocalExtension, WrappingRatingExtension
```
public interface Extension
```
Represent an extension.

Since:

4.0M1

Version:

$Id: 5a30afcc099ac5c1cb90c840985dcf60b74fb3e3 $

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FIELD_AUTHOR`
`static String`	`FIELD_AUTHORS`
`static String`	`FIELD_CATEGORY`
`static String`	`FIELD_DESCRIPTION`
`static String`	`FIELD_FEATURE`
`static String`	`FIELD_FEATURES`
`static String`	`FIELD_ID`
`static String`	`FIELD_LICENSE`
`static String`	`FIELD_LICENSES`
`static String`	`FIELD_NAME`
`static String`	`FIELD_REPOSITORY`
`static String`	`FIELD_SCM`
`static String`	`FIELD_SUMMARY`
`static String`	`FIELD_TYPE`
`static String`	`FIELD_VERSION`
`static String`	`FIELD_WEBSITE`

Method Summary

Methods
Modifier and Type	Method and Description
`<T> T`	`get(String fieldName)` Get an extension field (name, summary, id, etc.) by name.
`Collection<ExtensionAuthor>`	`getAuthors()`
`String`	`getCategory()`
`Collection<? extends ExtensionDependency>`	`getDependencies()`
`String`	`getDescription()`
`Collection<String>`	`getFeatures()` The idea is to indicate in an extension a list of provided "functionalities".
`ExtensionFile`	`getFile()` Return extension file descriptor.
`ExtensionId`	`getId()`
`ExtensionIssueManagement`	`getIssueManagement()`
`Collection<ExtensionLicense>`	`getLicenses()`
`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.
`ExtensionRepository`	`getRepository()`
`ExtensionScm`	`getScm()`
`String`	`getSummary()`
`String`	`getType()`
`String`	`getWebSite()`

- Field Detail
  - FIELD_REPOSITORY
```
static final String FIELD_REPOSITORY
```
    Since:
    
    7.0RC1
    
    See Also:
    getRepository(), Constant Field Values
  - FIELD_ID
```
static final String FIELD_ID
```
    Since:
    
    7.0RC1
    
    See Also:
    getId(), Constant Field Values
  - FIELD_VERSION
```
static final String FIELD_VERSION
```
    Since:
    
    7.0RC1
    
    See Also:
    getId(), Constant Field Values
  - FIELD_FEATURE
```
static final String FIELD_FEATURE
```
    Since:
    
    7.0RC1
    
    See Also:
    getFeatures(), Constant Field Values
  - FIELD_FEATURES
```
static final String FIELD_FEATURES
```
    Since:
    
    7.0RC1
    
    See Also:
    getFeatures(), Constant Field Values
  - FIELD_SUMMARY
```
static final String FIELD_SUMMARY
```
    Since:
    
    7.0RC1
    
    See Also:
    getSummary(), Constant Field Values
  - FIELD_DESCRIPTION
```
static final String FIELD_DESCRIPTION
```
    Since:
    
    7.0RC1
    
    See Also:
    getDescription(), Constant Field Values
  - FIELD_AUTHOR
```
static final String FIELD_AUTHOR
```
    Since:
    
    7.0RC1
    
    See Also:
    getAuthors(), Constant Field Values
  - FIELD_AUTHORS
```
static final String FIELD_AUTHORS
```
    Since:
    
    7.0RC1
    
    See Also:
    getAuthors(), Constant Field Values
  - FIELD_CATEGORY
```
static final String FIELD_CATEGORY
```
    Since:
    
    7.0RC1
    
    See Also:
    getCategory(), Constant Field Values
  - FIELD_LICENSE
```
static final String FIELD_LICENSE
```
    Since:
    
    7.0RC1
    
    See Also:
    getLicenses(), Constant Field Values
  - FIELD_LICENSES
```
static final String FIELD_LICENSES
```
    Since:
    
    7.0RC1
    
    See Also:
    getLicenses(), Constant Field Values
  - FIELD_NAME
```
static final String FIELD_NAME
```
    Since:
    
    7.0RC1
    
    See Also:
    getName(), Constant Field Values
  - FIELD_TYPE
```
static final String FIELD_TYPE
```
    Since:
    
    7.0RC1
    
    See Also:
    getType(), Constant Field Values
  - FIELD_WEBSITE
```
static final String FIELD_WEBSITE
```
    Since:
    
    7.0RC1
    
    See Also:
    getWebSite(), Constant Field Values
  - FIELD_SCM
```
static final String FIELD_SCM
```
    Since:
    
    7.0RC1
    
    See Also:
    getScm(), Constant Field Values
- Method Detail
  - get
```
@Unstable
<T> T get(String fieldName)
```
    Get an extension field (name, summary, id, etc.) by name. Fallback on properties.
    
    Type Parameters:
    T - type of the field value
    Parameters:
    fieldName - the field name;
    
    Returns:
    the field value or null if none could be found
    Since:
    
    7.0RC1
  - getId
```
ExtensionId getId()
```
    Returns:
    the id/version combination which makes the extension unique
  - getFeatures
```
Collection<String> getFeatures()
```
    The idea is to indicate in an extension a list of provided "functionalities". Then when resolving extensions dependencies the dependencies id could be matched in this list.
    
    Returns:
    the extension ids also provided by this extension, an empty collection if there is none
  - getType
```
String getType()
```
    Returns:
    the type of the extension
  - getName
```
String getName()
```
    Returns:
    the display name of the extension
  - getLicenses
```
Collection<ExtensionLicense> getLicenses()
```
    Returns:
    the license of the extension, an empty collection if there is none
  - getSummary
```
String getSummary()
```
    Returns:
    a short description of the extension
  - getDescription
```
String getDescription()
```
    Returns:
    a description of the extension
  - getWebSite
```
String getWebSite()
```
    Returns:
    an URL for the extension website
  - getAuthors
```
Collection<ExtensionAuthor> getAuthors()
```
    Returns:
    the extension authors, an empty collection if there is none
  - getDependencies
```
Collection<? extends ExtensionDependency> getDependencies()
```
    Returns:
    the dependencies of the extension, an empty collection if there is none
  - getFile
```
ExtensionFile getFile()
```
    Return extension file descriptor. Also allows to get the content of the file.
    
    Returns:
    the file of the extension
  - getRepository
```
ExtensionRepository getRepository()
```
    Returns:
    the repository of the extension
  - getScm
```
ExtensionScm getScm()
```
    Returns:
    informations related to extensions's source control management
    Since:
    
    6.3M1
  - getIssueManagement
```
ExtensionIssueManagement getIssueManagement()
```
    Returns:
    informations related to extension's issues management
    Since:
    
    6.3M1
  - getCategory
```
@Unstable
String getCategory()
```
    Returns:
    the category of the extension
    Since:
    
    7.0M2
  - getProperties
```
Map<String,Object> getProperties()
```
    Extends Extension standard properties.
    Theses are generally provided by specific repositories. For example a maven repository will provide group and artifacts ids.
    
    Returns:
    the properties
  - getProperty
```
<T> T getProperty(String key)
```
    Type Parameters:
    T - type of the property value
    Parameters:
    key - the property key
    
    Returns:
    the property value
  - getProperty
```
<T> T getProperty(String key,
                T def)
```
    Get a property.
    
    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:
    getProperty(String)

Interface Extension

Field Summary

Method Summary

Field Detail

FIELD_REPOSITORY

FIELD_ID

FIELD_VERSION

FIELD_FEATURE

FIELD_FEATURES

FIELD_SUMMARY

FIELD_DESCRIPTION

FIELD_AUTHOR

FIELD_AUTHORS

FIELD_CATEGORY

FIELD_LICENSE

FIELD_LICENSES

FIELD_NAME

FIELD_TYPE

FIELD_WEBSITE

FIELD_SCM

Method Detail

get

getId

getFeatures

getType

getName

getLicenses

getSummary

getDescription

getWebSite

getAuthors

getDependencies

getFile

getRepository

getScm

getIssueManagement

getCategory

getProperties

getProperty

getProperty