com.linkedin.paldb.utils

Enum FormatVersion

java.lang.Object

java.lang.Enum<FormatVersion>

com.linkedin.paldb.utils.FormatVersion

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FormatVersion>

public enum FormatVersion
extends java.lang.Enum<FormatVersion>

Enum that represents the version of the data format.

The format version ensures compatibility between the writer and the reader (i.e. should be equal).

Enum Constant Summary

Enum Constants

Enum Constant and Description
PALDB_V1

Method Summary

Modifier and Type	Method and Description
static FormatVersion	fromBytes(byte[] bytes) Get a version based on bytes or return null if not found.
byte[]	getBytes() Return the byte representation of this format version.
static FormatVersion	getLatestVersion() Return the latest version of the format.
static byte[]	getPrefixBytes() Returns the byte representation of the version prefix.
boolean	is(FormatVersion fv) Returns true if fv is equals to this.
static FormatVersion	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FormatVersion[]	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

PALDB_V1

public static final FormatVersion PALDB_V1

Method Detail

values

public static FormatVersion[] 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 (FormatVersion c : FormatVersion.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FormatVersion valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

is

public boolean is(FormatVersion fv)

Returns true if fv is equals to this.

Parameters:

fv - a format version

Returns:

true if fv is equals to this enum

getBytes

public byte[] getBytes()

Return the byte representation of this format version.

Returns:

format version byte representation

fromBytes

public static FormatVersion fromBytes(byte[] bytes)

Get a version based on bytes or return null if not found.

Parameters:

bytes - byte representation

Returns:

format version or null if not found

getPrefixBytes

public static byte[] getPrefixBytes()

Returns the byte representation of the version prefix.

Returns:

prefix byte representation

getLatestVersion

public static FormatVersion getLatestVersion()

Return the latest version of the format.

Returns:

the latest format version