AbstractExtension (XWiki Commons - Extension

java.lang.Object
- org.xwiki.extension.AbstractExtension

All Implemented Interfaces:

Comparable<Extension>, Extension, MutableExtension

Direct Known Subclasses:

AbstractRemoteExtension
```
public abstract class AbstractExtension
extends Object
implements MutableExtension
```
Base class for Extension implementations.

Since:

4.0M1

Version:

$Id: 34713608188f356301ceac8af1b9f7e4619333e7 $

Field Summary

Fields
Modifier and Type	Field and Description
`protected Set<String>`	`allowedNamespaces`
`protected List<ExtensionAuthor>`	`authors`
`protected String`	`category`
`protected List<ExtensionDependency>`	`dependencies`
`protected String`	`description`
`protected Set<String>`	`features` Deprecated. since 8.0M1, use `featuresMap` instead
`protected Map<String,ExtensionId>`	`featuresMap`
`protected ExtensionFile`	`file` The file of the extension.
`protected ExtensionId`	`id`
`protected ExtensionIssueManagement`	`issueManagement`
`protected List<ExtensionLicense>`	`licenses`
`protected List<ExtensionDependency>`	`managedDependencies`
`protected String`	`name`
`protected Map<String,Object>`	`properties`
`protected ReentrantLock`	`propertiesLock` Used to protect properties from concurrent write;
`protected List<ExtensionRepositoryDescriptor>`	`repositories`
`protected ExtensionRepository`	`repository`
`protected ExtensionScm`	`scm`
`protected String`	`summary`
`protected String`	`type`
`protected String`	`website`

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

Constructor Summary

Constructors
Constructor and Description
`AbstractExtension(ExtensionRepository repository, Extension extension)` Create new extension descriptor by copying provided one.
`AbstractExtension(ExtensionRepository repository, ExtensionId id, String type)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAllowedNamespace(String namespace)` Add a new allowed namespace to the extension.
`void`	`addAuthor(ExtensionAuthor author)` Add a new author to the extension.
`void`	`addDependency(ExtensionDependency dependency)` Add a new dependency to the extension.
`void`	`addExtensionFeature(ExtensionId feature)` Add a new feature to the extension.
`void`	`addFeature(String feature)` Deprecated.
`void`	`addLicense(ExtensionLicense license)` Add a new license to the extension.
`void`	`addManagedDependency(ExtensionDependency managedDependency)` Add a new managed dependency to the extension.
`void`	`addRepository(ExtensionRepositoryDescriptor repository)` Add a new repository to the extension.
`int`	`compareTo(Extension o)`
`boolean`	`equals(Object obj)`
`<T> T`	`get(String fieldName)` Get an extension field by name.
`Collection<String>`	`getAllowedNamespaces()`
`List<ExtensionAuthor>`	`getAuthors()`
`String`	`getCategory()`
`List<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()`
`List<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()`
`int`	`hashCode()`
`void`	`putProperty(String key, Object value)` Set a property.
`<T> T`	`removeProperty(String key)` Remove the property associated to the passed key and return its value.
`void`	`set(Extension extension)` Update optional informations based on the provided extension.
`void`	`setAllowedNamespaces(Collection<String> namespaces)`
`void`	`setAuthors(Collection<? extends ExtensionAuthor> authors)`
`void`	`setCategory(String categrory)`
`void`	`setDependencies(Collection<? extends ExtensionDependency> dependencies)`
`void`	`setDescription(String description)`
`void`	`setExtensionFeatures(Collection<ExtensionId> features)`
`void`	`setFeatures(Collection<String> features)` Deprecated.
`protected void`	`setFile(ExtensionFile file)`
`protected void`	`setId(ExtensionId id)`
`void`	`setIssueManagement(ExtensionIssueManagement issueManagement)`
`void`	`setLicenses(Collection<ExtensionLicense> licenses)`
`void`	`setManagedDependencies(Collection<? extends ExtensionDependency> managedDependencies)`
`void`	`setName(String name)`
`void`	`setProperties(Map<String,Object> properties)` Replace existing properties with provided properties.
`void`	`setRepositories(Collection<? extends ExtensionRepositoryDescriptor> repositories)`
`protected void`	`setRepository(ExtensionRepository repository)`
`void`	`setScm(ExtensionScm scm)`
`void`	`setSummary(String summary)`
`protected void`	`setType(String type)`
`void`	`setWebsite(String website)`
`String`	`toString()`

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

- Field Detail
  - id
```
protected ExtensionId id
```
    See Also:
    
    getId()
  - features
```
@Deprecated
protected Set<String> features
```
    Deprecated. since 8.0M1, use featuresMap instead
    
    See Also:
    
    getExtensionFeatures()
  - featuresMap
```
protected Map<String,ExtensionId> featuresMap
```
    See Also:
    
    getExtensionFeatures()
  - type
```
protected String type
```
    See Also:
    
    getType()
  - name
```
protected String name
```
    See Also:
    
    getName()
  - licenses
```
protected List<ExtensionLicense> licenses
```
    See Also:
    
    getLicenses()
  - summary
```
protected String summary
```
    See Also:
    
    getSummary()
  - description
```
protected String description
```
    See Also:
    
    getDescription()
  - authors
```
protected List<ExtensionAuthor> authors
```
    See Also:
    
    getAuthors()
  - website
```
protected String website
```
    See Also:
    
    getWebSite()
  - allowedNamespaces
```
protected Set<String> allowedNamespaces
```
    See Also:
    
    getAllowedNamespaces()
  - repository
```
protected ExtensionRepository repository
```
    See Also:
    
    getRepository()
  - properties
```
protected Map<String,Object> properties
```
    See Also:
    
    getProperties()
  - propertiesLock
```
protected ReentrantLock propertiesLock
```
    Used to protect properties from concurrent write;
  - dependencies
```
protected List<ExtensionDependency> dependencies
```
    See Also:
    
    getDependencies()
  - managedDependencies
```
protected List<ExtensionDependency> managedDependencies
```
    Since:
    
    8.1M1
    
    See Also:
    
    getManagedDependencies()
  - scm
```
protected ExtensionScm scm
```
    See Also:
    
    getScm()
  - issueManagement
```
protected ExtensionIssueManagement issueManagement
```
    See Also:
    
    getIssueManagement()
  - category
```
protected String category
```
    See Also:
    
    getCategory()
  - repositories
```
protected List<ExtensionRepositoryDescriptor> repositories
```
    See Also:
    
    getRepositories()
  - file
```
protected ExtensionFile file
```
    The file of the extension.
- Constructor Detail
  - AbstractExtension
```
public AbstractExtension(ExtensionRepository repository,
                         ExtensionId id,
                         String type)
```
    Parameters:
    
    repository - the repository where this extension comes from
    
    id - the extension identifier
    
    type - the extension type
  - AbstractExtension
```
public AbstractExtension(ExtensionRepository repository,
                         Extension extension)
```
    Create new extension descriptor by copying provided one.
    
    Parameters:
    
    repository - the repository where this extension comes from
    
    extension - the extension to copy
- Method Detail
  - set
```
public void set(Extension extension)
```
    Description copied from interface: MutableExtension
    
    Update optional informations based on the provided extension.
    
    Specified by:
    
    set in interface MutableExtension
    
    Parameters:
    
    extension - the extension from which to get informations
  - get
```
public <T> T get(String fieldName)
```
    Get an extension field 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
  - setId
```
protected void setId(ExtensionId id)
```
    Parameters:
    
    id - the extension id
    
    See Also:
    
    getId()
  - 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
  - setFeatures
```
@Deprecated
public void setFeatures(Collection<String> features)
```
    Deprecated.
    
    Specified by:
    
    setFeatures in interface MutableExtension
    
    Parameters:
    
    features - the extension ids also provided by this extension
  - addFeature
```
@Deprecated
public void addFeature(String feature)
```
    Deprecated.
    
    Description copied from interface: MutableExtension
    
    Add a new feature to the extension.
    
    Specified by:
    
    addFeature in interface MutableExtension
    
    Parameters:
    
    feature - a feature name
  - 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
  - setExtensionFeatures
```
public void setExtensionFeatures(Collection<ExtensionId> features)
```
    Specified by:
    
    setExtensionFeatures in interface MutableExtension
    
    Parameters:
    
    features - the ExtensionIds also provided by this extension
    
    Since:
    
    8.0M1
  - addExtensionFeature
```
public void addExtensionFeature(ExtensionId feature)
```
    Description copied from interface: MutableExtension
    
    Add a new feature to the extension.
    
    Specified by:
    
    addExtensionFeature in interface MutableExtension
    
    Parameters:
    
    feature - a feature name
    
    Since:
    
    8.0M1
  - getType
```
public String getType()
```
    Specified by:
    
    getType in interface Extension
    
    Returns:
    
    the type of the extension
  - setType
```
protected void setType(String type)
```
    Parameters:
    
    type - the type of the extension
    
    See Also:
    
    getType()
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface Extension
    
    Returns:
    
    the display name of the extension
  - setName
```
public void setName(String name)
```
    Specified by:
    
    setName in interface MutableExtension
    
    Parameters:
    
    name - 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
  - setLicenses
```
public void setLicenses(Collection<ExtensionLicense> licenses)
```
    Specified by:
    
    setLicenses in interface MutableExtension
    
    Parameters:
    
    licenses - the licenses of the extension
  - addLicense
```
public void addLicense(ExtensionLicense license)
```
    Description copied from interface: MutableExtension
    
    Add a new license to the extension.
    
    Specified by:
    
    addLicense in interface MutableExtension
    
    Parameters:
    
    license - a license
  - getSummary
```
public String getSummary()
```
    Specified by:
    
    getSummary in interface Extension
    
    Returns:
    
    a short description of the extension
  - setSummary
```
public void setSummary(String summary)
```
    Specified by:
    
    setSummary in interface MutableExtension
    
    Parameters:
    
    summary - a short description of the extension
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface Extension
    
    Returns:
    
    a description of the extension
  - setDescription
```
public void setDescription(String description)
```
    Specified by:
    
    setDescription in interface MutableExtension
    
    Parameters:
    
    description - a description of the extension
  - getAuthors
```
public List<ExtensionAuthor> getAuthors()
```
    Specified by:
    
    getAuthors in interface Extension
    
    Returns:
    
    the extension authors, an empty collection if there is none
  - setAuthors
```
public void setAuthors(Collection<? extends ExtensionAuthor> authors)
```
    Specified by:
    
    setAuthors in interface MutableExtension
    
    Parameters:
    
    authors - the authors of the extension
  - addAuthor
```
public void addAuthor(ExtensionAuthor author)
```
    Description copied from interface: MutableExtension
    
    Add a new author to the extension.
    
    Specified by:
    
    addAuthor in interface MutableExtension
    
    Parameters:
    
    author - an author
  - getWebSite
```
public String getWebSite()
```
    Specified by:
    
    getWebSite in interface Extension
    
    Returns:
    
    an URL for the extension website
  - setWebsite
```
public void setWebsite(String website)
```
    Specified by:
    
    setWebsite in interface MutableExtension
    
    Parameters:
    
    website - an URL for the extension website
  - getAllowedNamespaces
```
public Collection<String> getAllowedNamespaces()
```
    Specified by:
    
    getAllowedNamespaces in interface Extension
    
    Returns:
    
    the namespaces where it's allowed to install this extension
  - addAllowedNamespace
```
public void addAllowedNamespace(String namespace)
```
    Description copied from interface: MutableExtension
    
    Add a new allowed namespace to the extension.
    
    Specified by:
    
    addAllowedNamespace in interface MutableExtension
    
    Parameters:
    
    namespace - a namespace
    
    Since:
    
    8.0M1
  - setAllowedNamespaces
```
public void setAllowedNamespaces(Collection<String> namespaces)
```
    Specified by:
    
    setAllowedNamespaces in interface MutableExtension
    
    Parameters:
    
    namespaces - the namespaces where it's allowed to install this extension
    
    Since:
    
    8.0M1
  - addDependency
```
public void addDependency(ExtensionDependency dependency)
```
    Description copied from interface: MutableExtension
    
    Add a new dependency to the extension.
    
    Specified by:
    
    addDependency in interface MutableExtension
    
    Parameters:
    
    dependency - a dependency
  - getDependencies
```
public List<ExtensionDependency> getDependencies()
```
    Specified by:
    
    getDependencies in interface Extension
    
    Returns:
    
    the dependencies of the extension, an empty collection if there is none
  - setDependencies
```
public void setDependencies(Collection<? extends ExtensionDependency> dependencies)
```
    Specified by:
    
    setDependencies in interface MutableExtension
    
    Parameters:
    
    dependencies - the dependencies of the extension
    
    See Also:
    
    Extension.getDependencies()
  - addManagedDependency
```
public void addManagedDependency(ExtensionDependency managedDependency)
```
    Description copied from interface: MutableExtension
    
    Add a new managed dependency to the extension.
    
    Specified by:
    
    addManagedDependency in interface MutableExtension
    
    Parameters:
    
    managedDependency - a managed dependency;
    
    Since:
    
    8.1M1
  - getManagedDependencies
```
public List<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
  - setManagedDependencies
```
public void setManagedDependencies(Collection<? extends ExtensionDependency> managedDependencies)
```
    Specified by:
    
    setManagedDependencies in interface MutableExtension
    
    Parameters:
    
    managedDependencies - the managed dependencies of the extension
    
    See Also:
    
    Extension.getManagedDependencies()
  - getRepository
```
public ExtensionRepository getRepository()
```
    Specified by:
    
    getRepository in interface Extension
    
    Returns:
    
    the repository of the extension
  - setRepository
```
protected void setRepository(ExtensionRepository repository)
```
    Parameters:
    
    repository - the repository of the extension
    
    See Also:
    
    getRepository()
  - getScm
```
public ExtensionScm getScm()
```
    Specified by:
    
    getScm in interface Extension
    
    Returns:
    
    informations related to extensions's source control management
  - setScm
```
public void setScm(ExtensionScm scm)
```
    Specified by:
    
    setScm in interface MutableExtension
    
    Parameters:
    
    scm - informations related to extensions's Source Control Management;
    
    Since:
    
    6.3M1
  - getIssueManagement
```
public ExtensionIssueManagement getIssueManagement()
```
    Specified by:
    
    getIssueManagement in interface Extension
    
    Returns:
    
    informations related to extension's issues management
  - setIssueManagement
```
public void setIssueManagement(ExtensionIssueManagement issueManagement)
```
    Specified by:
    
    setIssueManagement in interface MutableExtension
    
    Parameters:
    
    issueManagement - informations related to extension's issues management
    
    Since:
    
    6.3M1
  - 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
  - setFile
```
protected void setFile(ExtensionFile file)
```
    Parameters:
    
    file - the file of the extension
  - getCategory
```
public String getCategory()
```
    Specified by:
    
    getCategory in interface Extension
    
    Returns:
    
    the category of the extension
  - setCategory
```
public void setCategory(String categrory)
```
    Specified by:
    
    setCategory in interface MutableExtension
    
    Parameters:
    
    categrory - the category of the extension;
    
    Since:
    
    7.0M2
  - getRepositories
```
public Collection<ExtensionRepositoryDescriptor> getRepositories()
```
    Specified by:
    
    getRepositories in interface Extension
    
    Returns:
    
    the custom repositories provided by the extension (usually to resolve dependencies)
  - setRepositories
```
public void setRepositories(Collection<? extends ExtensionRepositoryDescriptor> repositories)
```
    Specified by:
    
    setRepositories in interface MutableExtension
    
    Parameters:
    
    repositories - the custom repositories provided by the extension (usually to resolve dependencies)
    
    Since:
    
    7.3M1
  - addRepository
```
public void addRepository(ExtensionRepositoryDescriptor repository)
```
    Description copied from interface: MutableExtension
    
    Add a new repository to the extension.
    
    Specified by:
    
    addRepository in interface MutableExtension
    
    Parameters:
    
    repository - a repository descriptor;
    
    Since:
    
    7.3M1
  - 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)
  - putProperty
```
public void putProperty(String key,
                        Object value)
```
    Description copied from interface: MutableExtension
    
    Set a property.
    
    Specified by:
    
    putProperty in interface MutableExtension
    
    Parameters:
    
    key - the property key
    
    value - the property value
    
    See Also:
    
    Extension.getProperty(String)
  - setProperties
```
public void setProperties(Map<String,Object> properties)
```
    Description copied from interface: MutableExtension
    
    Replace existing properties with provided properties.
    
    Specified by:
    
    setProperties in interface MutableExtension
    
    Parameters:
    
    properties - the properties
  - removeProperty
```
public <T> T removeProperty(String key)
```
    Description copied from interface: MutableExtension
    
    Remove the property associated to the passed key and return its value.
    
    Specified by:
    
    removeProperty in interface MutableExtension
    
    Type Parameters:
    
    T - type of the property value
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the previous value associated with key, or null if there was no mapping for key;
    
    Since:
    
    8.3M1
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(Extension o)
```
    Specified by:
    
    compareTo in interface Comparable<Extension>

Class AbstractExtension

Field Summary

Fields inherited from interface org.xwiki.extension.Extension

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

features

featuresMap

type

name

licenses

summary

description

authors

website

allowedNamespaces

repository

properties

propertiesLock

dependencies

managedDependencies

scm

issueManagement

category

repositories

file

Constructor Detail

AbstractExtension

AbstractExtension

Method Detail

set

get

getId

setId

getFeatures

setFeatures

addFeature

getExtensionFeatures

getExtensionFeature

setExtensionFeatures

addExtensionFeature

getType

setType

getName

setName

getLicenses

setLicenses

addLicense

getSummary

setSummary

getDescription

setDescription

getAuthors

setAuthors

addAuthor

getWebSite

setWebsite

getAllowedNamespaces

addAllowedNamespace

setAllowedNamespaces

addDependency

getDependencies

setDependencies

addManagedDependency

getManagedDependencies

setManagedDependencies

getRepository

setRepository

getScm

setScm

getIssueManagement

setIssueManagement

getFile

setFile

getCategory

setCategory

getRepositories

setRepositories