org.apache.avalon.cornerstone.blocks.scheduler

Class TimeScheduledEntry

java.lang.Object

org.apache.avalon.cornerstone.blocks.scheduler.TimeScheduledEntry

All Implemented Interfaces:

java.lang.Comparable

public final class TimeScheduledEntry
extends java.lang.Object
implements java.lang.Comparable

Class use internally to package to hold scheduled time entries.

Author:

Avalon Development Team

Field Summary

Fields

Modifier and Type	Field and Description
private static java.text.SimpleDateFormat	DATEFORMAT
private boolean	m_isValid
private java.lang.String	m_name
private org.apache.avalon.cornerstone.services.scheduler.Target	m_target
private long	m_time
private org.apache.avalon.cornerstone.services.scheduler.TimeTrigger	m_trigger

Constructor Summary

Constructors

Constructor and Description
TimeScheduledEntry(java.lang.String name, org.apache.avalon.cornerstone.services.scheduler.TimeTrigger trigger, org.apache.avalon.cornerstone.services.scheduler.Target target)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(java.lang.Object object) Implement comparable interface used to help sort triggers.
java.lang.String	getName() Return name of trigger.
long	getNextTime() Retrieve cached time when trigger should run next.
org.apache.avalon.cornerstone.services.scheduler.Target	getTarget()
org.apache.avalon.cornerstone.services.scheduler.TimeTrigger	getTimeTrigger()
void	invalidate() Invalidate trigger
boolean	isValid() Determine if this entry is valid
void	setNextTime(long time) Set cached time in milliseconds when trigger should run
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DATEFORMAT

private static final java.text.SimpleDateFormat DATEFORMAT

m_name

private final java.lang.String m_name

m_trigger

private final org.apache.avalon.cornerstone.services.scheduler.TimeTrigger m_trigger

m_target

private final org.apache.avalon.cornerstone.services.scheduler.Target m_target

m_time

private long m_time

m_isValid

private boolean m_isValid

Constructor Detail

TimeScheduledEntry

public TimeScheduledEntry(java.lang.String name,
                  org.apache.avalon.cornerstone.services.scheduler.TimeTrigger trigger,
                  org.apache.avalon.cornerstone.services.scheduler.Target target)

Method Detail

getName

public java.lang.String getName()

Return name of trigger.

Returns:

the name of trigger

getTarget

public org.apache.avalon.cornerstone.services.scheduler.Target getTarget()

getTimeTrigger

public org.apache.avalon.cornerstone.services.scheduler.TimeTrigger getTimeTrigger()

isValid

public boolean isValid()

Determine if this entry is valid

Returns:

true if trigger is valid, false otherwise

invalidate

public void invalidate()

Invalidate trigger

getNextTime

public long getNextTime()

Retrieve cached time when trigger should run next.

Returns:

the time in milliseconds when trigger should run

setNextTime

public void setNextTime(long time)

Set cached time in milliseconds when trigger should run

Parameters:

time - the time

compareTo

public int compareTo(java.lang.Object object)

Implement comparable interface used to help sort triggers. Triggers are compared based on next time to run

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

object - the other trigger

Returns:

-'ve value if other trigger occurs before this trigger

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object