io.atomix.storage.journal

Class JournalSegment<E>

java.lang.Object

io.atomix.storage.journal.JournalSegment<E>

All Implemented Interfaces:

AutoCloseable

public class JournalSegment<E>
extends Object
implements AutoCloseable

Log segment.

Author:

Constructor Summary

Constructors

Constructor and Description
JournalSegment(JournalSegmentFile file, JournalSegmentDescriptor descriptor, io.atomix.utils.serializer.Serializer serializer)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the segment.
void	delete() Deletes the segment.
JournalSegmentDescriptor	descriptor() Returns the segment descriptor.
JournalSegmentFile	file() Returns the segment file.
long	id() Returns the segment ID.
long	index() Returns the segment's starting index.
boolean	isEmpty() Returns a boolean value indicating whether the segment is empty.
boolean	isFull() Returns a boolean indicating whether the segment is full.
boolean	isOpen() Returns a boolean indicating whether the segment is open.
long	lastIndex() Returns the last index in the segment.
long	length() Returns the segment length.
long	size() Returns the segment size.
String	toString()
long	version() Returns the segment version.
JournalSegmentWriter<E>	writer() Returns the segment writer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JournalSegment

public JournalSegment(JournalSegmentFile file,
                      JournalSegmentDescriptor descriptor,
                      io.atomix.utils.serializer.Serializer serializer)

Method Detail

id

public long id()

Returns the segment ID.

Returns:

The segment ID.

version

public long version()

Returns the segment version.

Returns:

The segment version.

index

public long index()

Returns the segment's starting index.

Returns:

The segment's starting index.

lastIndex

public long lastIndex()

Returns the last index in the segment.

Returns:

The last index in the segment.

file

public JournalSegmentFile file()

Returns the segment file.

Returns:

The segment file.

descriptor

public JournalSegmentDescriptor descriptor()

Returns the segment descriptor.

Returns:

The segment descriptor.

size

public long size()

Returns the segment size.

Returns:

The segment size.

isEmpty

public boolean isEmpty()

Returns a boolean value indicating whether the segment is empty.

Returns:

Indicates whether the segment is empty.

isFull

public boolean isFull()

Returns a boolean indicating whether the segment is full.

Returns:

Indicates whether the segment is full.

length

public long length()

Returns the segment length.

Returns:

The segment length.

writer

public JournalSegmentWriter<E> writer()

Returns the segment writer.

Returns:

The segment writer.

isOpen

public boolean isOpen()

Returns a boolean indicating whether the segment is open.

Returns:

indicates whether the segment is open

close

public void close()

Closes the segment.

Specified by:

close in interface AutoCloseable

delete

public void delete()

Deletes the segment.

toString

public String toString()

Overrides:

toString in class Object