RollCycles (OpenHFT/Chronicle-Queue 4.6.93 API)

java.lang.Object
- java.lang.Enum<RollCycles>
- - net.openhft.chronicle.queue.RollCycles

All Implemented Interfaces:: Serializable, Comparable<RollCycles>, RollCycle

public enum RollCycles
extends Enum<RollCycles>
implements RollCycle

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DAILY`
`HOURLY`
`HUGE_DAILY`
`HUGE_DAILY_XSPARSE`
`LARGE_DAILY`
`LARGE_HOURLY`
`LARGE_HOURLY_SPARSE`
`LARGE_HOURLY_XSPARSE`
`MINUTELY`
`SMALL_DAILY`
`TEST_DAILY`
`TEST_HOURLY`
`TEST_SECONDLY`
`TEST2_DAILY`
`TEST4_DAILY`
`XLARGE_DAILY`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`current(net.openhft.chronicle.core.time.TimeProvider time, long epoch)`
`int`	`defaultIndexCount()`
`int`	`defaultIndexSpacing()`
`String`	`format()`
`int`	`length()`
`static void`	`main(String[] args)`
`int`	`toCycle(long index)`
`long`	`toIndex(int cycle, long sequenceNumber)`
`long`	`toSequenceNumber(long index)`
`static RollCycles`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static RollCycles[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - TEST_SECONDLY
```
public static final RollCycles TEST_SECONDLY
```
  - MINUTELY
```
public static final RollCycles MINUTELY
```
  - TEST_HOURLY
```
public static final RollCycles TEST_HOURLY
```
  - HOURLY
```
public static final RollCycles HOURLY
```
  - LARGE_HOURLY
```
public static final RollCycles LARGE_HOURLY
```
  - LARGE_HOURLY_SPARSE
```
public static final RollCycles LARGE_HOURLY_SPARSE
```
  - LARGE_HOURLY_XSPARSE
```
public static final RollCycles LARGE_HOURLY_XSPARSE
```
  - TEST_DAILY
```
public static final RollCycles TEST_DAILY
```
  - TEST2_DAILY
```
public static final RollCycles TEST2_DAILY
```
  - TEST4_DAILY
```
public static final RollCycles TEST4_DAILY
```
  - SMALL_DAILY
```
public static final RollCycles SMALL_DAILY
```
  - DAILY
```
public static final RollCycles DAILY
```
  - LARGE_DAILY
```
public static final RollCycles LARGE_DAILY
```
  - XLARGE_DAILY
```
public static final RollCycles XLARGE_DAILY
```
  - HUGE_DAILY
```
public static final RollCycles HUGE_DAILY
```
  - HUGE_DAILY_XSPARSE
```
public static final RollCycles HUGE_DAILY_XSPARSE
```
- Method Detail
  - values
```
public static RollCycles[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (RollCycles c : RollCycles.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static RollCycles valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - format
```
public String format()
```
    Specified by:
    
    format in interface RollCycle
  - length
```
public int length()
```
    Specified by:
    
    length in interface RollCycle
  - defaultIndexCount
```
public int defaultIndexCount()
```
    Specified by:
    
    defaultIndexCount in interface RollCycle
  - defaultIndexSpacing
```
public int defaultIndexSpacing()
```
    Specified by:
    
    defaultIndexSpacing in interface RollCycle
  - current
```
public int current(@NotNull
                   net.openhft.chronicle.core.time.TimeProvider time,
                   long epoch)
```
    Specified by:
    
    current in interface RollCycle
    
    epoch - and EPOCH offset, to all the user to define their own epoch
    
    Returns:
    
    the cycle
  - toIndex
```
public long toIndex(int cycle,
                    long sequenceNumber)
```
    Specified by:
    
    toIndex in interface RollCycle
  - toSequenceNumber
```
public long toSequenceNumber(long index)
```
    Specified by:
    
    toSequenceNumber in interface RollCycle
  - toCycle
```
public int toCycle(long index)
```
    Specified by:
    
    toCycle in interface RollCycle
  - main
```
public static void main(String[] args)
```

Enum RollCycles

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

TEST_SECONDLY

MINUTELY

TEST_HOURLY

HOURLY

LARGE_HOURLY

LARGE_HOURLY_SPARSE

LARGE_HOURLY_XSPARSE

TEST_DAILY

TEST2_DAILY

TEST4_DAILY

SMALL_DAILY

DAILY

LARGE_DAILY

XLARGE_DAILY

HUGE_DAILY

HUGE_DAILY_XSPARSE

Method Detail

values

valueOf

format

length

defaultIndexCount

defaultIndexSpacing

current

toIndex

toSequenceNumber

toCycle

main