org.xwiki.extension

Class AbstractRemoteExtension

java.lang.Object

org.xwiki.extension.AbstractExtension

org.xwiki.extension.AbstractRemoteExtension

All Implemented Interfaces:

Comparable<Extension>, Extension, MutableExtension, RemoteExtension

Direct Known Subclasses:

AbstractRatingExtension

@Unstable
public abstract class AbstractRemoteExtension
extends AbstractExtension
implements RemoteExtension

Base class for RatingExtension implementations.

Since:

8.3RC1

Version:

$Id: 599e70c80fbfe6514e8fc7d1aa8e6a56d614b42b $

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	recommended

Fields inherited from class org.xwiki.extension.AbstractExtension

allowedNamespaces, authors, category, dependencies, description, features, featuresMap, file, id, issueManagement, licenses, managedDependencies, name, properties, propertiesLock, repositories, repository, scm, summary, type, website

Fields inherited from interface org.xwiki.extension.RemoteExtension

FIELD_RECOMMENDED

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
AbstractRemoteExtension(ExtensionRepository repository, Extension extension) Create new extension descriptor by copying provided one.
AbstractRemoteExtension(ExtensionRepository repository, ExtensionId id, String type)

Method Summary

Modifier and Type	Method and Description
<T> T	get(String fieldName) Get an extension field by name.
boolean	isRecommended() Indicate if the extension is recommended by the repository where it come from.
void	setRecommended(boolean recommended)

Methods inherited from class org.xwiki.extension.AbstractExtension

addAllowedNamespace, addAuthor, addDependency, addExtensionFeature, addFeature, addLicense, addManagedDependency, addRepository, compareTo, equals, getAllowedNamespaces, getAuthors, getCategory, getDependencies, getDescription, getExtensionFeature, getExtensionFeatures, getFeatures, getFile, getId, getIssueManagement, getLicenses, getManagedDependencies, getName, getProperties, getProperty, getProperty, getRepositories, getRepository, getScm, getSummary, getType, getWebSite, hashCode, putProperty, removeProperty, set, setAllowedNamespaces, setAuthors, setCategory, setDependencies, setDescription, setExtensionFeatures, setFeatures, setFile, setId, setIssueManagement, setLicenses, setManagedDependencies, setName, setProperties, setRepositories, setRepository, setScm, setSummary, setType, setWebsite, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.extension.Extension

getAllowedNamespaces, getAuthors, getCategory, getDependencies, getDescription, getExtensionFeature, getExtensionFeatures, getFeatures, getFile, getId, getIssueManagement, getLicenses, getManagedDependencies, getName, getProperties, getProperty, getProperty, getRepositories, getRepository, getScm, getSummary, getType, getWebSite

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

recommended

protected boolean recommended

See Also:

isRecommended()

Constructor Detail

AbstractRemoteExtension

public AbstractRemoteExtension(ExtensionRepository repository,
                               ExtensionId id,
                               String type)

Parameters:

repository - the repository where this extension comes from

id - the extension identifier

type - the extension type

AbstractRemoteExtension

public AbstractRemoteExtension(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

isRecommended

public boolean isRecommended()

Description copied from interface: RemoteExtension

Indicate if the extension is recommended by the repository where it come from.

What "recommended" exactly means depend on the repository giving this information.

For example on http://extensions.xwiki.org the meaning is the extension is known to be of good quality and still officially supported by its author.

Specified by:

isRecommended in interface RemoteExtension

Returns:

true if the extension is recommended

setRecommended

public void setRecommended(boolean recommended)

Parameters:

recommended - true if the extension is recommended

See Also:

isRecommended()

get

public <T> T get(String fieldName)

Description copied from class: AbstractExtension

Get an extension field by name. Fallback on properties.

Specified by:

get in interface Extension

Overrides:

get in class AbstractExtension

Type Parameters:

T - type of the field value

Parameters:

fieldName - the field name;

Returns:

the field value or null if none could be found