com.hotels.avro.compatibility

Enum Compatibility.Mode

java.lang.Object

java.lang.Enum<Compatibility.Mode>

com.hotels.avro.compatibility.Compatibility.Mode

All Implemented Interfaces:

Serializable, Comparable<Compatibility.Mode>

Enclosing class:

Compatibility

public static enum Compatibility.Mode
extends Enum<Compatibility.Mode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CAN_BE_READ_BY_ALL Also known as 'forwards transitive'.
CAN_BE_READ_BY_LATEST Also known as 'forwards'.
CAN_READ_ALL Also known as 'backwards transitive'.
CAN_READ_LATEST Also known as 'backwards'.
MUTUAL_READ_WITH_ALL Also known as 'full transitive'.
MUTUAL_READ_WITH_LATEST Also known as 'full'.

Method Summary

Modifier and Type	Method and Description
ChronologyCompatibilityCheckResult	check(org.apache.avro.Schema toValidate, Iterable<org.apache.avro.Schema> schemasInOrder)
static Compatibility.Mode	valueOf(String name) Returns the enum constant of this type with the specified name.
static Compatibility.Mode[]	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

CAN_READ_LATEST

public static final Compatibility.Mode CAN_READ_LATEST

Also known as 'backwards'. Can read the data written by the most recent previous schema.

CAN_READ_ALL

public static final Compatibility.Mode CAN_READ_ALL

Also known as 'backwards transitive'. Can read the data written by all earlier schemas.

CAN_BE_READ_BY_LATEST

public static final Compatibility.Mode CAN_BE_READ_BY_LATEST

Also known as 'forwards'. The data written by this schema can be read by the most recent previous schema.

CAN_BE_READ_BY_ALL

public static final Compatibility.Mode CAN_BE_READ_BY_ALL

Also known as 'forwards transitive'. The data written by this schema can be read by all earlier schemas.

MUTUAL_READ_WITH_LATEST

public static final Compatibility.Mode MUTUAL_READ_WITH_LATEST

Also known as 'full'. Can read the data written by, a write data readable by the most recent previous schema.

MUTUAL_READ_WITH_ALL

public static final Compatibility.Mode MUTUAL_READ_WITH_ALL

Also known as 'full transitive'. Can read the data written by, a write data readable by all earlier schemas.

Method Detail

values

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

Returns:

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

valueOf

public static Compatibility.Mode valueOf(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:

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

NullPointerException - if the argument is null

check

public ChronologyCompatibilityCheckResult check(org.apache.avro.Schema toValidate,
                                                Iterable<org.apache.avro.Schema> schemasInOrder)

Parameters:

schemasInOrder - existing schemas, latest last.