com.github.nickrm.jflux.domain

Class RetentionPolicy

java.lang.Object

com.github.nickrm.jflux.domain.RetentionPolicy

public final class RetentionPolicy
extends Object

A retention policy specifies how long data is kept for.

Instance of this class are immutable.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RetentionPolicy.Builder Used to create instances of RetentionPolicy.

Method Summary

Modifier and Type	Method and Description
RetentionPolicy	asDefault(boolean isDefault) Creates a copy of this instance with a new value for isDefault.
boolean	equals(Object o)
Duration	getDuration() Gets the duration of this retention policy.
String	getName() Gets the name of this retention policy.
int	getReplication() Gets the replication factor of this retention policy.
Duration	getShardDuration() Gets the shard duration of this retention policy.
int	hashCode()
boolean	isDefault() Gets a value indicating whether this retention policy is the default.
String	toString()
RetentionPolicy	withDuration(Duration duration) Creates a copy of this instance with the specified duration.
RetentionPolicy	withReplication(int replication) Creates a copy of this instance with the specified replication factor.
RetentionPolicy	withShardDuration(Duration shardDuration) Creates a copy of this instance with a new shard duration.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Gets the name of this retention policy.

Returns:

the retention policy name

getDuration

public Duration getDuration()

Gets the duration of this retention policy.

Returns:

the retention policy duration

withDuration

public RetentionPolicy withDuration(Duration duration)

Creates a copy of this instance with the specified duration.

Parameters:

duration - the new duration value

Returns:

a new instance with the new value

getReplication

public int getReplication()

Gets the replication factor of this retention policy.

Returns:

the retention policy replication

withReplication

public RetentionPolicy withReplication(int replication)

Creates a copy of this instance with the specified replication factor.

Parameters:

replication - the new replication value

Returns:

a new instance with the new value

getShardDuration

public Duration getShardDuration()

Gets the shard duration of this retention policy.

Returns:

the shard duration

withShardDuration

public RetentionPolicy withShardDuration(Duration shardDuration)

Creates a copy of this instance with a new shard duration.

Parameters:

shardDuration - the new shard duration value

Returns:

a new instance with the new value

isDefault

public boolean isDefault()

Gets a value indicating whether this retention policy is the default.

Returns:

true if this is the default, false otherwise

asDefault

public RetentionPolicy asDefault(boolean isDefault)

Creates a copy of this instance with a new value for isDefault.

Parameters:

isDefault - true if this retention policy is the default, false otherwise

Returns:

a new instance with the new value

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