RollCycles (OpenHFT/Chronicle-Queue 5.19.73 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
```
Roll cycles to use with the queue. Sparse indexing roll cycles are useful for improving write performance but they slightly slow random access performance (with no effect for sequential reads)

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DAILY` 4 billion entries per day, indexing every 64th entry
`HOURLY` 256 million entries per hour, indexing every 16th entry
`HUGE_DAILY` 256 trillion entries per day with sparse indexing (every 1024th entry)
`HUGE_DAILY_XSPARSE` 256 trillion entries per day with super-sparse indexing (every (2^20)th entry)
`LARGE_DAILY` 128 billion entries per day, indexing every 128th entry
`LARGE_HOURLY` 2 billion entries per hour, indexing every 64th entry
`LARGE_HOURLY_SPARSE` 16 billion entries per hour with sparse indexing (every 1024th entry)
`LARGE_HOURLY_XSPARSE` 16 billion entries per hour with super-sparse indexing (every (2^20)th entry)
`MINUTELY` 64 million entries per minute
`SMALL_DAILY` 512 million entries per day
`TEST_DAILY` Only good for testing - 63 entries per day
`TEST_HOURLY` 512 entries per hour
`TEST_SECONDLY` Only good for testing
`TEST2_DAILY` Only good for testing
`TEST4_DAILY` Only good for testing
`TEST4_SECONDLY` Only good for testing
`TEST8_DAILY` Only good for testing
`XLARGE_DAILY` 4 trillion entries per day, indexing every 256th entry

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Iterable<RollCycles>`	`all()`
`int`	`current(@NotNull net.openhft.chronicle.core.time.TimeProvider time, long epoch)`
`int`	`defaultIndexCount()`
`int`	`defaultIndexSpacing()` Returns the space between excerpts that are explicitly indexed.
`String`	`format()` Returns the format that is to be applied when file names are calculated for a new roll cycle.
`int`	`length()` Returns the length in milliseconds (i.e.
`int`	`toCycle(long index)` Returns the cycle for the given `index`.
`long`	`toIndex(int cycle, long sequenceNumber)` Returns the index for the given `cycle` and `sequenceNumber`.
`long`	`toSequenceNumber(long index)` Returns the sequence number for the given `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
```
    Only good for testing
  - TEST4_SECONDLY
```
public static final RollCycles TEST4_SECONDLY
```
    Only good for testing
  - MINUTELY
```
public static final RollCycles MINUTELY
```
    64 million entries per minute
  - TEST_HOURLY
```
public static final RollCycles TEST_HOURLY
```
    512 entries per hour
  - HOURLY
```
public static final RollCycles HOURLY
```
    256 million entries per hour, indexing every 16th entry
  - LARGE_HOURLY
```
public static final RollCycles LARGE_HOURLY
```
    2 billion entries per hour, indexing every 64th entry
  - LARGE_HOURLY_SPARSE
```
public static final RollCycles LARGE_HOURLY_SPARSE
```
    16 billion entries per hour with sparse indexing (every 1024th entry)
  - LARGE_HOURLY_XSPARSE
```
public static final RollCycles LARGE_HOURLY_XSPARSE
```
    16 billion entries per hour with super-sparse indexing (every (2^20)th entry)
  - TEST_DAILY
```
public static final RollCycles TEST_DAILY
```
    Only good for testing - 63 entries per day
  - TEST2_DAILY
```
public static final RollCycles TEST2_DAILY
```
    Only good for testing
  - TEST4_DAILY
```
public static final RollCycles TEST4_DAILY
```
    Only good for testing
  - TEST8_DAILY
```
public static final RollCycles TEST8_DAILY
```
    Only good for testing
  - SMALL_DAILY
```
public static final RollCycles SMALL_DAILY
```
    512 million entries per day
  - DAILY
```
public static final RollCycles DAILY
```
    4 billion entries per day, indexing every 64th entry
  - LARGE_DAILY
```
public static final RollCycles LARGE_DAILY
```
    128 billion entries per day, indexing every 128th entry
  - XLARGE_DAILY
```
public static final RollCycles XLARGE_DAILY
```
    4 trillion entries per day, indexing every 256th entry
  - HUGE_DAILY
```
public static final RollCycles HUGE_DAILY
```
    256 trillion entries per day with sparse indexing (every 1024th entry)
  - HUGE_DAILY_XSPARSE
```
public static final RollCycles HUGE_DAILY_XSPARSE
```
    256 trillion entries per day with super-sparse indexing (every (2^20)th entry)
- 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
  - all
```
public static Iterable<RollCycles> all()
```
  - format
```
public String format()
```
    Description copied from interface: RollCycle
    Returns the format that is to be applied when file names are calculated for a new roll cycle.
    For example, the following formats can be returned:
    - "yyyyMMdd-HHmm" (MINUTELY)
    - "yyyyMMdd" (DAILY)
    Specified by:
    
    format in interface RollCycle
    
    Returns:
    
    the format that is to be applied when file names are calculated for a new roll cycle
  - length
```
public int length()
```
    Description copied from interface: RollCycle
    Returns the length in milliseconds (i.e. the maximum duration) for a roll cycle.
    For example, the following lengths can be returned:
    - 60 * 1,000 = 60,000 (MINUTELY)
    - 24 * 60 * 60 * 1,000 = 86,400,000 (DAILY)
    Specified by:
    
    length in interface RollCycle
    
    Returns:
    
    the length in milliseconds (i.e. the maximum duration) for a roll cycle
  - defaultIndexCount
```
public int defaultIndexCount()
```
    Specified by:
    
    defaultIndexCount in interface RollCycle
    
    Returns:
    
    this is the size of each index array, note: indexCount^2 is the maximum number of index queue entries.
  - defaultIndexSpacing
```
public int defaultIndexSpacing()
```
    Description copied from interface: RollCycle
    Returns the space between excerpts that are explicitly indexed.
    A higher number means higher sequential write performance but slower random access read. The sequential read performance is not affected by this property.
    For example, the following default index spacing can be returned:
    - 16 (MINUTELY)
    - 64 (DAILY)
    Specified by:
    
    defaultIndexSpacing in interface RollCycle
    
    Returns:
    
    the space between excerpts that are explicitly indexed
  - current
```
public int current(@NotNull
                   @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)
```
    Description copied from interface: RollCycle
    
    Returns the index for the given cycle and sequenceNumber.
    An index is comprised of both a cycle and a sequence number but the way the index is composed of said properties may vary.
    
    Specified by:
    
    toIndex in interface RollCycle
    
    Parameters:
    
    cycle - to be composed into an index
    
    sequenceNumber - to be composed into an index
    
    Returns:
    
    the index for the given cycle and sequenceNumber
  - toSequenceNumber
```
public long toSequenceNumber(long index)
```
    Description copied from interface: RollCycle
    
    Returns the sequence number for the given index.
    An index is comprised of both a cycle and a sequence number but the way the index is composed of said properties may vary. This method decomposes the provided index and extracts the sequence number.
    
    Specified by:
    
    toSequenceNumber in interface RollCycle
    
    Parameters:
    
    index - to use when extracting the sequence number
    
    Returns:
    
    the sequence number for the given index
  - toCycle
```
public int toCycle(long index)
```
    Description copied from interface: RollCycle
    
    Returns the cycle for the given index.
    An index is comprised of both a cycle and a sequence number but the way the index is composed of said properties may vary. This method decomposes the provided index and extracts the cycle.
    
    Specified by:
    
    toCycle in interface RollCycle
    
    Parameters:
    
    index - to use when extracting the cycle
    
    Returns:
    
    the sequence number for the given index

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

TEST4_SECONDLY

MINUTELY

TEST_HOURLY

HOURLY

LARGE_HOURLY

LARGE_HOURLY_SPARSE

LARGE_HOURLY_XSPARSE

TEST_DAILY

TEST2_DAILY

TEST4_DAILY

TEST8_DAILY

SMALL_DAILY

DAILY

LARGE_DAILY

XLARGE_DAILY

HUGE_DAILY

HUGE_DAILY_XSPARSE

Method Detail

values

valueOf

all

format

length

defaultIndexCount

defaultIndexSpacing

current

toIndex

toSequenceNumber

toCycle