Medical Imaging Interaction Toolkit  2018.4.99-87d68d9f
Medical Imaging Interaction Toolkit
berry::IExtensionPoint Struct Referenceabstract

#include <berryIExtensionPoint.h>

Inheritance diagram for berry::IExtensionPoint:
Collaboration diagram for berry::IExtensionPoint:

Public Member Functions

 berryObjectMacro (berry::IExtensionPoint)
 
 ~IExtensionPoint () override
 
virtual QList< SmartPointer< IConfigurationElement > > GetConfigurationElements () const =0
 
virtual QString GetNamespaceIdentifier () const =0
 
virtual SmartPointer< IContributorGetContributor () const =0
 
virtual SmartPointer< IExtensionGetExtension (const QString &extensionId) const =0
 
virtual QList< SmartPointer< IExtension > > GetExtensions () const =0
 
virtual QString GetLabel () const =0
 
virtual QString GetSimpleIdentifier () const =0
 
virtual QString GetUniqueIdentifier () const =0
 
virtual bool IsValid () const =0
 
- Public Member Functions inherited from berry::Object
virtual QString GetClassName () const
 
virtual Reflection::TypeInfo GetTypeInfo () const
 
virtual QList< Reflection::TypeInfoGetSuperclasses () const
 
virtual void Delete ()
 
QDebug Print (QDebug os, Indent Indent=0) const
 
virtual QString ToString () const
 
virtual uint HashCode () const
 
virtual bool operator< (const Object *) const
 
void Register () const
 
void UnRegister (bool del=true) const
 
int GetReferenceCount () const
 
void SetReferenceCount (int)
 
void AddDestroyListener (const MessageAbstractDelegate<> &delegate) const
 
void RemoveDestroyListener (const MessageAbstractDelegate<> &delegate) const
 
virtual bool operator== (const Object *) const
 

Additional Inherited Members

- Public Types inherited from berry::Object
typedef Object Self
 
typedef berry::SmartPointer< SelfPointer
 
typedef berry::SmartPointer< const SelfConstPointer
 
typedef berry::WeakPointer< SelfWeakPtr
 
typedef berry::WeakPointer< const SelfConstWeakPtr
 
- Static Public Member Functions inherited from berry::Object
static const char * GetStaticClassName ()
 
static Reflection::TypeInfo GetStaticTypeInfo ()
 
static QList< Reflection::TypeInfoGetStaticSuperclasses ()
 
- Protected Member Functions inherited from berry::Object
 Object ()
 
virtual ~Object ()
 
virtual QDebug PrintSelf (QDebug os, Indent indent) const
 
virtual QDebug PrintHeader (QDebug os, Indent indent) const
 
virtual QDebug PrintTrailer (QDebug os, Indent indent) const
 
- Protected Attributes inherited from berry::Object
QAtomicInt m_ReferenceCount
 
QMutex m_ReferenceCountLock
 

Detailed Description

An extension point declared in a plug-in. Except for the list of extensions plugged in to it, the information available for an extension point is obtained from the declaring plug-in's manifest (plugin.xml) file.

These registry objects are intended for relatively short-term use. Clients that deal with these objects must be aware that they may become invalid if the declaring plug-in is updated or uninstalled. If this happens, all methods except isValid() will throw InvalidRegistryObjectException. For extension point objects, the most common case is code in a plug-in dealing with one of the extension points it declares. These extension point objects are guaranteed to be valid while the plug-in is active. Code in a plug-in that has declared that it is not dynamic aware (or not declared anything) can also safely ignore this issue, since the registry would not be modified while it is active. However, code in a plug-in that declares that it is dynamic aware must be careful if it access the extension point object of a different plug-in, because it's at risk if that other plug-in is removed. Similarly, tools that analyze or display the extension registry are vulnerable. Client code can pre-test for invalid objects by calling isValid(), which never throws this exception. However, pre-tests are usually not sufficient because of the possibility of the extension point object becoming invalid as a result of a concurrent activity. At-risk clients must treat InvalidRegistryObjectException as if it were a checked exception. Also, such clients should probably register a listener with the extension registry so that they receive notification of any changes to the registry.

This interface is not intended to be implemented by clients.

This interface is not intended to be implemented by clients.

Definition at line 56 of file berryIExtensionPoint.h.

Constructor & Destructor Documentation

◆ ~IExtensionPoint()

berry::IExtensionPoint::~IExtensionPoint ( )
override

Definition at line 17 of file berryIExtensionPoint.cpp.

Member Function Documentation

◆ berryObjectMacro()

berry::IExtensionPoint::berryObjectMacro ( berry::IExtensionPoint  )

◆ GetConfigurationElements()

virtual QList<SmartPointer<IConfigurationElement> > berry::IExtensionPoint::GetConfigurationElements ( ) const
pure virtual

Returns all configuration elements from all extensions configured into this extension point. Returns an empty array if this extension point has no extensions configured, or none of the extensions contain configuration elements.

Returns
the configuration elements for all extension configured into this extension point
Exceptions
InvalidRegistryObjectExceptionif this extension point is no longer valid

◆ GetContributor()

virtual SmartPointer<IContributor> berry::IExtensionPoint::GetContributor ( ) const
pure virtual

Returns the contributor of this extension point.

Returns
the contributor for this extension point
Exceptions
InvalidRegistryObjectExceptionif this extension point is no longer valid

◆ GetExtension()

virtual SmartPointer<IExtension> berry::IExtensionPoint::GetExtension ( const QString &  extensionId) const
pure virtual

Returns the extension with the given unique identifier configured into this extension point, or null if there is no such extension. Since an extension might not have an identifier, some extensions can only be found via the getExtensions method.

Parameters
extensionIdthe unique identifier of an extension (e.g. "com.example.acme.main").
Returns
an extension, or null
Exceptions
InvalidRegistryObjectExceptionif this extension point is no longer valid

◆ GetExtensions()

virtual QList<SmartPointer<IExtension> > berry::IExtensionPoint::GetExtensions ( ) const
pure virtual

Returns all extensions configured into this extension point. Returns an empty array if this extension point has no extensions.

Returns
the extensions configured into this extension point
Exceptions
InvalidRegistryObjectExceptionif this extension point is no longer valid

◆ GetLabel()

virtual QString berry::IExtensionPoint::GetLabel ( ) const
pure virtual

Returns a displayable label for this extension point. Returns the empty string if no label for this extension point is specified in the plug-in manifest file.

Note that any translation specified in the plug-in manifest file is automatically applied.

Returns
a displayable string label for this extension point, possibly the empty string
Exceptions
InvalidRegistryObjectExceptionif this extension point is no longer valid

◆ GetNamespaceIdentifier()

virtual QString berry::IExtensionPoint::GetNamespaceIdentifier ( ) const
pure virtual

Returns the namespace name for this extension point.

Returns
the namespace name for this extension point
Exceptions
InvalidRegistryObjectExceptionif this extension point is no longer valid

Referenced by berry::ExtensionTracker::CreateNamespaceFilter().

◆ GetSimpleIdentifier()

virtual QString berry::IExtensionPoint::GetSimpleIdentifier ( ) const
pure virtual

Returns the simple identifier of this extension point. This identifier is a non-empty string containing no period characters ('.') and is guaranteed to be unique within the defining plug-in.

Returns
the simple identifier of the extension point (e.g. "builders")
Exceptions
InvalidRegistryObjectExceptionif this extension point is no longer valid

◆ GetUniqueIdentifier()

virtual QString berry::IExtensionPoint::GetUniqueIdentifier ( ) const
pure virtual

Returns the unique identifier of this extension point. This identifier is unique within the plug-in registry, and is composed of the namespace for this extension point and this extension point's simple identifier.

Returns
the unique identifier of the extension point (e.g. "org.blueberry.core.resources.builders")
Exceptions
InvalidRegistryObjectExceptionif this extension point is no longer valid

◆ IsValid()

virtual bool berry::IExtensionPoint::IsValid ( ) const
pure virtual

Returns whether this extension point object is valid.

Returns
true if the object is valid, and false if it is no longer valid

The documentation for this struct was generated from the following files: