CrontabEvent (Wowza Streaming Engine 4 API)

Object
- com.wowza.wms.util.crontab.CrontabEvent

All Implemented Interfaces:

Comparable<CrontabEvent>
```
public class CrontabEvent
extends Object
implements Comparable<CrontabEvent>
```
Holds an event's schedule and is responsible for calculating event activation.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DAY`
`static org.joda.time.format.DateTimeFormatter`	`DT_FORMAT`
`static int`	`HOUR`
`static int`	`MINUTE`
`static int`	`MONTH`
`static int`	`WEEKDAY`
`static int`	`YEAR`

Constructor Summary

Constructors
Constructor and Description

CrontabEvent()

Constructors
Constructor and Description
`CrontabEvent()`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(CrontabEvent o)` Allows CronEvents to be sorted via Java Sort Class.
`void`	`dump()` dumps this event's information to the console
`String`	`getError()`
`int`	`getErrorField()`
`ICrontabEventHandler`	`getEventHandler()`
`String`	`getEventStr()`
`com.wowza.wms.util.crontab.CrontabField`	`getField(int whichField)`
`org.joda.time.MutableDateTime`	`getLastRun()`
`org.joda.time.MutableDateTime`	`getNextRun()`
`String`	`getTarget()`
`boolean`	`isDebugOn()`
`boolean`	`isExpired()` Indicates whether or not all execution dates for this event occur in the past
`boolean`	`isMatch(org.joda.time.MutableDateTime date)` Determines if this event will fire on the date passed in
`void`	`setDebug(boolean debug)` turns on/off debug logging
`void`	`setError(String error)`
`void`	`setErrorField(int errorField)`
`void`	`setEventHandler(ICrontabEventHandler handler)`
`void`	`setEventStr(String entry)`
`void`	`setField(int whichField, com.wowza.wms.util.crontab.CrontabField field)`
`void`	`setLastRun()` Sets the last run time to now
`void`	`setLastRun(org.joda.time.MutableDateTime date)`
`void`	`setTarget(String target)`
`boolean`	`start()` Starts this events timer
`void`	`stop()` stops this events timer

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DAY
```
public static final int DAY
```
    See Also:
    Constant Field Values
  - DT_FORMAT
```
public static org.joda.time.format.DateTimeFormatter DT_FORMAT
```
  - HOUR
```
public static final int HOUR
```
    See Also:
    Constant Field Values
  - MINUTE
```
public static final int MINUTE
```
    See Also:
    Constant Field Values
  - MONTH
```
public static final int MONTH
```
    See Also:
    Constant Field Values
  - WEEKDAY
```
public static final int WEEKDAY
```
    See Also:
    Constant Field Values
  - YEAR
```
public static final int YEAR
```
    See Also:
    Constant Field Values
- Constructor Detail
  - CrontabEvent
```
public CrontabEvent()
```
- Method Detail
  - compareTo
```
public int compareTo(CrontabEvent o)
```
    Allows CronEvents to be sorted via Java Sort Class. Compares nextRun dates of two CronEvents where earlier events are considered "less" than later events, (e.g. today < tomorrow) and nulls are "greater" than events with dates (e.g. tomorrow < null) This provides the logic to sort events by soonest to latest with nulls at the end
    
    Specified by:
    
    compareTo in interface Comparable<CrontabEvent>
    
    Parameters:
    o - - CronEvent to compare this event to
    
    Returns:
    -1,0,1 - if equal, if this event is greater than
  - dump
```
public void dump()
```
    dumps this event's information to the console
  - getError
```
public String getError()
```
  - getErrorField
```
public int getErrorField()
```
  - getEventHandler
```
public ICrontabEventHandler getEventHandler()
```
  - getEventStr
```
public String getEventStr()
```
  - getField
```
public com.wowza.wms.util.crontab.CrontabField getField(int whichField)
```
  - getLastRun
```
public org.joda.time.MutableDateTime getLastRun()
```
  - getNextRun
```
public org.joda.time.MutableDateTime getNextRun()
```
  - getTarget
```
public String getTarget()
```
  - isDebugOn
```
public boolean isDebugOn()
```
  - isExpired
```
public boolean isExpired()
```
    Indicates whether or not all execution dates for this event occur in the past
    
    Returns:
    true/false
  - isMatch
```
public boolean isMatch(org.joda.time.MutableDateTime date)
```
    Determines if this event will fire on the date passed in
    
    Parameters:
    date -
    
    Returns:
    boolean
  - setDebug
```
public void setDebug(boolean debug)
```
    turns on/off debug logging
    
    Parameters:
    debug - - true/false
  - setError
```
public void setError(String error)
```
  - setErrorField
```
public void setErrorField(int errorField)
```
  - setEventHandler
```
public void setEventHandler(ICrontabEventHandler handler)
```
  - setEventStr
```
public void setEventStr(String entry)
```
  - setField
```
public void setField(int whichField,
            com.wowza.wms.util.crontab.CrontabField field)
```
  - setLastRun
```
public void setLastRun()
```
    Sets the last run time to now
  - setLastRun
```
public void setLastRun(org.joda.time.MutableDateTime date)
```
  - setTarget
```
public void setTarget(String target)
```
  - start
```
public boolean start()
```
    Starts this events timer
    
    Returns:
    true - if timer is started, else false
  - stop
```
public void stop()
```
    stops this events timer

Class CrontabEvent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

DAY

DT_FORMAT

HOUR

MINUTE

MONTH

WEEKDAY

YEAR

Constructor Detail

CrontabEvent

Method Detail

compareTo

dump

getError

getErrorField

getEventHandler

getEventStr

getField

getLastRun

getNextRun

getTarget

isDebugOn

isExpired

isMatch

setDebug

setError

setErrorField

setEventHandler

setEventStr

setField

setLastRun

setLastRun

setTarget

start

stop