Every (Punch Common Core Library 6.4.5 API)

java.lang.Object
- org.thales.punch.libraries.utils.api.Every

public class Every
extends Object

A very simple facility to be notified periodically: Here is the usage :


 Every every = new Every();
 ..
 if (every()) {
  // do something for example publish a metric or log an important info message
  // by default this is called once an hour.
 }

You can change the default every period using -Dpunch.every=30 for example, to have all every users call that every 30 seconds.

Author:: dimi

- Constructor Summary
  
  Constructors
  Constructor and Description
  
  Every()
  Get an every instance to shoot by default every hour.
  
  Every(int periodSec)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method and Description
  
  boolean fire()
  
  long getPeriod()
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors
Constructor and Description
`Every()` Get an every instance to shoot by default every hour.
`Every(int periodSec)`

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`fire()`
`long`	`getPeriod()`

- Constructor Detail
  - Every
```
public Every(int periodSec)
```
    Parameters:
    
    periodSec - the period in seconds between two logs.
  - Every
```
public Every()
```
    Get an every instance to shoot by default every hour. Can be changed using -Dpunch.every=30 on the command line of your apps.
- Method Detail
  - getPeriod
```
public long getPeriod()
```
  - fire
```
public boolean fire()
```

Class Every

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Every

Every

Method Detail

getPeriod

fire