Package hudson.model.listeners

Class SaveableListener

java.lang.Object

hudson.model.listeners.SaveableListener

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

Nodes.ScheduleMaintenanceAfterSavingNode

public abstract class SaveableListener
extends Object
implements ExtensionPoint

Receives notifications about save actions on Saveable objects in Hudson.

This is an abstract class so that methods added in the future won't break existing listeners.

Since:

1.334

Author:

Andrew Bayer

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
SaveableListener()

Method Summary

Modifier and Type	Method	Description
static ExtensionList<SaveableListener>	all()	Returns all the registered SaveableListener descriptors.
static void	fireOnChange(Saveable o, XmlFile file)	Fires the onChange(hudson.model.Saveable, hudson.XmlFile) event.
void	onChange(Saveable o, XmlFile file)	Called when a change is made to a Saveable object.
void	register()	Deprecated. as of 1.281 Put Extension on your class to get it auto-registered.
void	unregister()	Reverse operation of register().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SaveableListener

public SaveableListener()

Method Detail

onChange

public void onChange(Saveable o,
                     XmlFile file)

Called when a change is made to a Saveable object.

Parameters:

o - The saveable object.

file - The XmlFile for this saveable object.

register

@Deprecated
public void register()

Deprecated.

as of 1.281 Put Extension on your class to get it auto-registered.

Registers this object as an active listener so that it can start getting callbacks invoked.

unregister

public void unregister()

Reverse operation of register().

fireOnChange

public static void fireOnChange(Saveable o,
                                XmlFile file)

Fires the onChange(hudson.model.Saveable, hudson.XmlFile) event.

all

public static ExtensionList<SaveableListener> all()

Returns all the registered SaveableListener descriptors.