com.rultor.base

Class Crontab

java.lang.Object

com.rultor.base.Crontab

All Implemented Interfaces:

Instance

@Immutable
@Loggable(value=1)
public final class Crontab
extends Object
implements Instance

Sends pulses through, only on certain time moments.

Use it as an instance wrapper:

 com.rultor.base.Crontab(
   ${0:?}, "A/5 * * * *",
   my-custom-instance
 )

Since:

1.0

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Cron in Wikipedia, Crontab specification

Suppressed Checkstyle violations:

ClassDataAbstractionCoupling (500 lines)

Field Summary

Fields inherited from interface com.rultor.spi.Instance

EMPTY

Constructor Summary

Constructors

Constructor and Description
Crontab(Coordinates wrk, String text, Instance instance) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
long	lag(Time date) Lag in milliseconds (how much time left till the next execution).
void	pulse()
String	rules() Show all encapsulated rules.

Methods inherited from class java.lang.Object

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

Constructor Detail

Crontab

public Crontab(@NotNull(message="work can\'t be NULL")
       Coordinates wrk,
       @NotNull(message="crontab text can\'t be NULL")
       String text,
       @NotNull(message="instance can\'t be NULL")
       Instance instance)

Public ctor.

Parameters:

wrk - Coordinates we're in

text - Mask to use

instance - Original instance

Method Detail

pulse

@Loggable(value=1,
          limit=2147483647,
          ignore=java.io.IOException.class)
public void pulse()
           throws Exception

Specified by:

pulse in interface Instance

Throws:

Exception

rules

public String rules()

Show all encapsulated rules.

Returns:

The text

lag

public long lag(Time date)

Lag in milliseconds (how much time left till the next execution).

The method is public solely for the sake of unit testing. Otherwise it's almost impossible to test the class.

Parameters:

date - The date to start counting from

Returns:

Milliseconds