com.hazelcast.config

Class BTreeIndexConfig

java.lang.Object

com.hazelcast.config.BTreeIndexConfig

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable

public class BTreeIndexConfig
extends Object
implements IdentifiedDataSerializable

Configuration options specific for B-Tree indexes.

Since:

5.2

Field Summary

Fields

Modifier and Type	Field and Description
static Capacity	DEFAULT_PAGE_SIZE Default value of page size for B-Trees.

Constructor Summary

Constructors

Constructor and Description
BTreeIndexConfig()
BTreeIndexConfig(BTreeIndexConfig other)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getClassId() Returns type identifier for this class.
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
MemoryTierConfig	getMemoryTierConfig() Returns memory tier configuration for this index.
Capacity	getPageSize() Returns the page size of B-Tree index.
int	hashCode()
void	readData(ObjectDataInput in) Reads fields from the input stream
BTreeIndexConfig	setMemoryTierConfig(MemoryTierConfig memoryTierConfig) Sets memory tier configuration for this index to given configuration.
BTreeIndexConfig	setPageSize(Capacity pageSize) Sets index page size to given non-negative value.
String	toString()
void	writeData(ObjectDataOutput out) Writes object fields to output stream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_PAGE_SIZE

public static final Capacity DEFAULT_PAGE_SIZE

Default value of page size for B-Trees.

Constructor Detail

BTreeIndexConfig

public BTreeIndexConfig()

BTreeIndexConfig

public BTreeIndexConfig(BTreeIndexConfig other)

Method Detail

getPageSize

public Capacity getPageSize()

Returns the page size of B-Tree index.

Returns:

index page size.

setPageSize

public BTreeIndexConfig setPageSize(Capacity pageSize)

Sets index page size to given non-negative value.

Parameters:

pageSize - page size of the index

getMemoryTierConfig

@Nonnull
public MemoryTierConfig getMemoryTierConfig()

Returns memory tier configuration for this index.

Returns:

memory tier configuration for this index.

setMemoryTierConfig

public BTreeIndexConfig setMemoryTierConfig(MemoryTierConfig memoryTierConfig)

Sets memory tier configuration for this index to given configuration.

Parameters:

memoryTierConfig - new memory tier configuration to be set.

writeData

public void writeData(ObjectDataOutput out)
               throws IOException

Description copied from interface: DataSerializable

Writes object fields to output stream

Specified by:

writeData in interface DataSerializable

Parameters:

out - output

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

readData

public void readData(ObjectDataInput in)
              throws IOException

Description copied from interface: DataSerializable

Reads fields from the input stream

Specified by:

readData in interface DataSerializable

Parameters:

in - input

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.

getFactoryId

public int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory ID for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Returns:

factory ID

getClassId

public int getClassId()

Description copied from interface: IdentifiedDataSerializable

Returns type identifier for this class. It should be unique per DataSerializableFactory.

Specified by:

getClassId in interface IdentifiedDataSerializable

Returns:

type ID

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object