org.xwiki.component.event

Class ComponentDescriptorAddedEvent

java.lang.Object

org.xwiki.component.event.AbstractComponentDescriptorEvent

org.xwiki.component.event.ComponentDescriptorAddedEvent

All Implemented Interfaces:

ComponentDescriptorEvent, Event

public class ComponentDescriptorAddedEvent
extends AbstractComponentDescriptorEvent

Event sent to tell that a new Component Descriptor has been registered.

The event also send the following parameters:

• source: the org.xwiki.component.manager.ComponentManager where the component was registered
• data: the org.xwiki.component.descriptor.ComponentDescriptor instance

Since:

2.6RC2

Version:

$Id: cd27bcf22894c3b051a28b1cb80714747991102d $

Constructor Summary

Constructors

Constructor and Description
ComponentDescriptorAddedEvent() Watches all roles (whenever a component is added it'll trigger this event).
ComponentDescriptorAddedEvent(Class<?> role) Deprecated. since 4.4RC1 use ComponentDescriptorAddedEvent(Type) instead
ComponentDescriptorAddedEvent(Class<?> role, String roleHint) Deprecated. since 4.4RC1 use ComponentDescriptorAddedEvent(Type, String) instead
ComponentDescriptorAddedEvent(Type roleType)
ComponentDescriptorAddedEvent(Type roleType, String roleHint)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	matches(Object otherEvent)

Methods inherited from class org.xwiki.component.event.AbstractComponentDescriptorEvent

equals, getRole, getRoleHint, getRoleType, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentDescriptorAddedEvent

public ComponentDescriptorAddedEvent()

Watches all roles (whenever a component is added it'll trigger this event).

ComponentDescriptorAddedEvent

@Deprecated
public ComponentDescriptorAddedEvent(Class<?> role)

Deprecated. since 4.4RC1 use ComponentDescriptorAddedEvent(Type) instead

Parameters:

role - the component role to watch (all components matching this role will trigger this event)

ComponentDescriptorAddedEvent

public ComponentDescriptorAddedEvent(Type roleType)

Parameters:

roleType - the component role to watch (all components matching this role will trigger this event)

Since:

4.4RC1

ComponentDescriptorAddedEvent

@Deprecated
public ComponentDescriptorAddedEvent(Class<?> role,
                                        String roleHint)

Deprecated. since 4.4RC1 use ComponentDescriptorAddedEvent(Type, String) instead

Parameters:

role - the component role to watch

roleHint - the component role hint to watch

ComponentDescriptorAddedEvent

public ComponentDescriptorAddedEvent(Type roleType,
                             String roleHint)

Parameters:

roleType - the component role to watch

roleHint - the component role hint to watch

Since:

4.4RC1

Method Detail

matches

public boolean matches(Object otherEvent)

Specified by:

matches in interface Event

Overrides:

matches in class AbstractComponentDescriptorEvent