com.cloudbees.hudson.plugins.folder.computed

Class ChildObserver<I extends hudson.model.TopLevelItem>

java.lang.Object

com.cloudbees.hudson.plugins.folder.computed.ChildObserver<I>

public abstract class ChildObserver<I extends hudson.model.TopLevelItem>
extends Object

Callback for ComputedFolder. Methods may be called only inside the scope of ComputedFolder.computeChildren(com.cloudbees.hudson.plugins.folder.computed.ChildObserver<I>, hudson.model.TaskListener).

Method Summary

Modifier and Type	Method and Description
abstract void	created(I child) Notify the observer that you did create a new child.
abstract boolean	mayCreate(String name) Checks whether we may create a new child of the given name.
abstract I	shouldUpdate(String name) Checks whether there is an existing child which should be updated.

Methods inherited from class java.lang.Object

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

Method Detail

shouldUpdate

@CheckForNull
public abstract I shouldUpdate(String name)

Checks whether there is an existing child which should be updated.

Parameters:

name - a proposed Item.getName()

Returns:

the existing child to update, if there is one (in which case go ahead and update it as needed); else null, in which case continue by checking mayCreate(java.lang.String)

mayCreate

public abstract boolean mayCreate(String name)

Checks whether we may create a new child of the given name.

Parameters:

name - a proposed Item.getName()

Returns:

true if you may go ahead and call created(I) (though you are not obliged to do so); false if you may not

created

public abstract void created(I child)

Notify the observer that you did create a new child.

Parameters:

child - a newly constructed child item; do not call Item.onCreatedFromScratch() and try to avoid calls to Item.save()