SequentialOffsetIndex (Copycat API Reference (1.1.4))

Constructors
Constructor and Description
`SequentialOffsetIndex(Buffer buffer)`

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the index.
`boolean`	`contains(long offset)` Returns a boolean value indicating whether the index contains the given offset.
`void`	`delete()` Deletes the index.
`long`	`find(long offset)` Finds the real offset for the given relative offset.
`void`	`flush()` Flushes the index to the underlying storage.
`boolean`	`index(long offset, long position)` Indexes the given offset with the given position.
`boolean`	`isEmpty()` Returns a boolean value indicating whether the index is empty.
`long`	`lastOffset()` Returns the last offset in the index.
`long`	`position(long offset)` Finds the starting position of the given offset.
`int`	`size()` Returns the number of entries active in the index.
`long`	`truncate(long offset)` Truncates the index up to the given offset.

java.lang.Object
- io.atomix.copycat.server.storage.index.SequentialOffsetIndex

All Implemented Interfaces:

OffsetIndex, AutoCloseable
```
public class SequentialOffsetIndex
extends Object
implements OffsetIndex
```
Sequential offset index.
Author:
- Constructor Summary
  
  Constructors
  Constructor and Description
  
  SequentialOffsetIndex(Buffer buffer)
  
  Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method and Description
  
  void close()
  Closes the index.
  
  boolean contains(long offset)
  Returns a boolean value indicating whether the index contains the given offset.
  
  void delete()
  Deletes the index.
  
  long find(long offset)
  Finds the real offset for the given relative offset.
  
  void flush()
  Flushes the index to the underlying storage.
  
  boolean index(long offset, long position)
  Indexes the given offset with the given position.
  
  boolean isEmpty()
  Returns a boolean value indicating whether the index is empty.
  
  long lastOffset()
  Returns the last offset in the index.
  
  long position(long offset)
  Finds the starting position of the given offset.
  
  int size()
  Returns the number of entries active in the index.
  
  long truncate(long offset)
  Truncates the index up to the given offset.
  
  Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  
  Methods inherited from interface io.atomix.copycat.server.storage.index.OffsetIndex
  size

- Constructor Detail
  - SequentialOffsetIndex
```
public SequentialOffsetIndex(Buffer buffer)
```
    Throws:
    
    NullPointerException - if buffer is null
- Method Detail
  - lastOffset
```
public long lastOffset()
```
    Description copied from interface: OffsetIndex
    
    Returns the last offset in the index.
    
    Specified by:
    
    lastOffset in interface OffsetIndex
  - index
```
public boolean index(long offset,
                     long position)
```
    Description copied from interface: OffsetIndex
    
    Indexes the given offset with the given position.
    
    Specified by:
    
    index in interface OffsetIndex
    
    Parameters:
    
    offset - The offset to index.
    
    position - The position of the offset to index.
    
    Returns:
    
    Indicates whether the offset was successfully indexed.
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: OffsetIndex
    
    Returns a boolean value indicating whether the index is empty.
    
    Specified by:
    
    isEmpty in interface OffsetIndex
    
    Returns:
    
    Indicates whether the index is empty.
  - size
```
public int size()
```
    Description copied from interface: OffsetIndex
    
    Returns the number of entries active in the index.
    
    Specified by:
    
    size in interface OffsetIndex
    
    Returns:
    
    The number of entries active in the index.
  - contains
```
public boolean contains(long offset)
```
    Description copied from interface: OffsetIndex
    
    Returns a boolean value indicating whether the index contains the given offset.
    
    Specified by:
    
    contains in interface OffsetIndex
    
    Parameters:
    
    offset - The offset to check.
    
    Returns:
    
    Indicates whether the index contains the given offset.
  - position
```
public long position(long offset)
```
    Description copied from interface: OffsetIndex
    
    Finds the starting position of the given offset.
    
    Specified by:
    
    position in interface OffsetIndex
    
    Parameters:
    
    offset - The offset to look up.
    
    Returns:
    
    The starting position of the given offset.
  - find
```
public long find(long offset)
```
    Description copied from interface: OffsetIndex
    
    Finds the real offset for the given relative offset.
    
    Specified by:
    
    find in interface OffsetIndex
  - truncate
```
public long truncate(long offset)
```
    Description copied from interface: OffsetIndex
    
    Truncates the index up to the given offset.
    This method assumes that the given offset is contained within the index. If the offset is not indexed then the index will not be truncated.
    
    Specified by:
    
    truncate in interface OffsetIndex
    
    Parameters:
    
    offset - The offset after which to truncate the index.
    
    Returns:
    
    The position of the last entry in the index.
  - flush
```
public void flush()
```
    Description copied from interface: OffsetIndex
    
    Flushes the index to the underlying storage.
    
    Specified by:
    
    flush in interface OffsetIndex
  - close
```
public void close()
```
    Description copied from interface: OffsetIndex
    
    Closes the index.
    
    Specified by:
    
    close in interface OffsetIndex
    
    Specified by:
    
    close in interface AutoCloseable
  - delete
```
public void delete()
```
    Description copied from interface: OffsetIndex
    
    Deletes the index.
    
    Specified by:
    
    delete in interface OffsetIndex

Class SequentialOffsetIndex

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.atomix.copycat.server.storage.index.OffsetIndex

Constructor Detail

SequentialOffsetIndex

Method Detail

lastOffset

index

isEmpty

size

contains

position

find

truncate

flush

close

delete