public abstract class SandboxListenerSupport
extends java.lang.Object
Constructor and Description |
---|
SandboxListenerSupport() |
Modifier and Type | Method and Description |
---|---|
void |
notify(java.lang.String type,
SandboxFrameworkEvent e)
Notifies applicable listeners of a sandbox framework event.
|
void |
notifyRepositoryAdded(RepositoryEvent e)
Notifies the listeners that a repository has been successfully branched
in a sandbox.
|
void |
notifyRepositoryChanged(RepositoryEvent e)
Notifies the listeners that a repository in a sandbox has been changed.
|
void |
notifySandboxCreated(SandboxEvent e)
Notifies the listeners that a sandbox has been created successfully.
|
void |
notifySandboxDestroyed(SandboxEvent e)
Notifies the listeners that a sandbox has been destroyed successfully.
|
protected void |
notifySandboxDestroying(SandboxEvent e)
Notifies the listeners that a sandbox is just locked for destroying.
|
void |
notifySandboxPublished(SandboxEvent e)
Notifies the listeners that a sandbox has been published successfully.
|
protected void |
notifySandboxPublishing(SandboxEvent e)
Notifies the listeners that a sandbox is just locked for publishing.
|
void |
notifySandboxRefreshed(SandboxEvent e)
Notifies the listeners that a sandbox has been refreshed successfully.
|
protected void |
uncaughtThrowable(java.lang.Throwable t,
java.lang.String type,
SandboxFrameworkEvent e)
Invoked when any of the
notify methods or
unrecognizedEvent method throws a Throwable . |
protected void |
unrecognizedEvent(java.lang.String type,
SandboxFrameworkEvent e)
Invoked when an event received by
notify method is not
recognized by this class. |
public void notifyRepositoryChanged(RepositoryEvent e)
e
- the repository eventpublic void notifyRepositoryAdded(RepositoryEvent e)
e
- the repository eventpublic void notifySandboxCreated(SandboxEvent e)
e
- the sandbox eventpublic void notifySandboxPublished(SandboxEvent e)
e
- the sandbox eventpublic void notifySandboxRefreshed(SandboxEvent e)
e
- the sandbox eventpublic void notifySandboxDestroyed(SandboxEvent e)
e
- the sandbox eventpublic final void notify(java.lang.String type, SandboxFrameworkEvent e)
SandboxFrameworkEvent
and a String that indicates the
circumstance where the event is fired. When the event type and the type
of SandboxFrameworkEvent
object match one of the
notify
methods in SandboxListenerSupport
,
the method will be invoked. For example, if the event type is
"sandboxPublished" and the event object is a SandboxEvent
,
then notifySandboxPublished
will be invoked. If no matching
notify
method is found in SandboxListenerSupport
,
unrecognizedEvent
method is called. Note that this method
does not use reflection to discover any new methods added to the
subclasses. In other words, subclasses cannot add new notify
methods and expect this method to invoke any of them. In general,
unrecognizedEvent
method will not be called because the
framework will fire events only when they can be delivered through the
listener interfaces defined in this package.
Events without matching notify
methods are intended for the
implementation of this class to either consume the events, or convert them
into events that can be delivered through the existing interfaces.
All errors thrown by the notify
methods or
unrecognizedEvent
method will be redirected to
method uncaughtThrowable
. Errors from
uncaughtThrowable
will be caught and logged.
type
- the type of the event. Event types are method names of the
listeners defined in this package, such as "repositoryChanged",
"sandboxPublished" or "sandboxRefreshing".e
- the event. The class of the event must match the type; otherwise
the event will be treated as an unrecognized event.java.lang.IllegalArgumentException
- if the type or event is nullprotected void unrecognizedEvent(java.lang.String type, SandboxFrameworkEvent e)
notify
method is not
recognized by this class.type
- the type of the evente
- the event objectprotected void uncaughtThrowable(java.lang.Throwable t, java.lang.String type, SandboxFrameworkEvent e)
notify
methods or
unrecognizedEvent
method throws a Throwable
.t
- the errortype
- the type of the event that was to be deliverede
- the event object that was to be deliveredprotected void notifySandboxPublishing(SandboxEvent e)
e
- the sandbox eventprotected void notifySandboxDestroying(SandboxEvent e)
e
- the sandbox event