org.oddjob.jobs.structural

Class JobFolder

java.lang.Object

org.oddjob.jobs.structural.JobFolder

All Implemented Interfaces:

Iconic, Structural

public class JobFolder
extends java.lang.Object
implements Structural, Iconic

Description

Holds a collection of jobs but does not execute them. Used to collect and organise jobs. The jobs can either be scheduled by a scheduler or run manually.

A folder has no state, it can't be run and it can't be stopped.

Example

A folder of jobs.

<folder name="My Jobs">
    <jobs>
        <exec name="Morning Job">echo "Good Morning"</exec>
        <exec name="Afternoon Job">echo "Good Afternoon"</exec>
        <exec name="Evening Job">echo "Good Evening"</exec>
    </jobs>
</folder>

Author:

Rob Gordon

Field Summary

Fields

Modifier and Type	Field and Description
protected ChildHelper<java.lang.Object>	childHelper Child helper.
protected boolean	destroyed This flag is set once the object is destroyed Methods in subclass should check this flag.

Constructor Summary

Constructors

Constructor and Description
JobFolder()

Method Summary

Modifier and Type	Method and Description
void	addIconListener(IconListener listener) Add an icon listener.
void	addStructuralListener(StructuralListener listener) Add a listener.
void	configured()
void	destroy() Destroy this component.
java.lang.String	getName() Get the job name.
ImageData	iconForId(java.lang.String iconId) Return an icon tip for a given id.
void	initialised()
void	removeIconListener(IconListener listener) Remove an icon listener.
void	removeStructuralListener(StructuralListener listener) Remove a listener.
void	setJobs(int index, java.lang.Object child) Add a child.
void	setName(java.lang.String name) Set the job name.
java.lang.String	toString() Override toString.

Methods inherited from class java.lang.Object

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

Field Detail

childHelper

protected ChildHelper<java.lang.Object> childHelper

Child helper.

destroyed

protected transient volatile boolean destroyed

This flag is set once the object is destroyed Methods in subclass should check this flag.

Constructor Detail

JobFolder

public JobFolder()

Method Detail

setName

public void setName(java.lang.String name)

Set the job name. Used by subclasses to set the job name.

Parameters:

name - The name of the job.

getName

public java.lang.String getName()

Get the job name.

Returns:

The job name.

setJobs

public void setJobs(int index,
                    java.lang.Object child)

Add a child.

Property: jobs

Description: The jobs.

Required: No.

Parameters:

child - A child

addStructuralListener

public void addStructuralListener(StructuralListener listener)

Add a listener. The listener will immediately receive add notifications for all existing children.

Specified by:

addStructuralListener in interface Structural

Parameters:

listener - The listener.

removeStructuralListener

public void removeStructuralListener(StructuralListener listener)

Remove a listener.

Specified by:

removeStructuralListener in interface Structural

Parameters:

listener - The listener.

toString

public java.lang.String toString()

Override toString.

Overrides:

toString in class java.lang.Object

iconForId

public ImageData iconForId(java.lang.String iconId)

Return an icon tip for a given id. Part of the Iconic interface.

Specified by:

iconForId in interface Iconic

Parameters:

iconId - The icon id.

Returns:

The Icon Image Data or null if it doesn't exist.

addIconListener

public void addIconListener(IconListener listener)

Add an icon listener. Part of the Iconic interface.

Specified by:

addIconListener in interface Iconic

Parameters:

listener - The listener.

removeIconListener

public void removeIconListener(IconListener listener)

Remove an icon listener. Part of the Iconic interface.

Specified by:

removeIconListener in interface Iconic

Parameters:

listener - The listener.

initialised

public void initialised()

configured

public void configured()

destroy

public void destroy()

Destroy this component.