com.datastax.driver.core.ProtocolFeature Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dse-java-driver-core Show documentation

A driver for DataStax Enterprise (DSE) and Apache Cassandra 1.2+ clusters that works exclusively with the Cassandra Query Language version 3 (CQL3) and Cassandra's binary protocol, supporting DSE-specific features such as geospatial types, DSE Graph and DSE authentication.

There is a newer version: 2.4.0

Show newest version

/*
 * Copyright DataStax, Inc.
 *
 * This software can be used solely with DataStax Enterprise. Please consult the license at
 * http://www.datastax.com/terms/datastax-dse-driver-license-terms
 */
package com.datastax.driver.core;

/**
 * A listing of features that may or not apply to a given {@link ProtocolVersion}.
 */
enum ProtocolFeature {

    /**
     * The capability of setting keyspace on a per-query basis.
     */
    KEYSPACE_ON_QUERY,

    /**
     * The capability of updating a prepared statement if the result's metadata changes at runtime (for example, if the
     * query is a {@code SELECT *} and the table is altered).
     */
    PREPARED_METADATA_CHANGES,

    /**
     * The capability of sending or receiving custom payloads.
     */
    CUSTOM_PAYLOADS,

    /**
     * The capability of assigning client-generated timestamps to write requests.
     */
    CLIENT_TIMESTAMPS,

    //
    ;

    /**
     * Determines whether or not the input version supports ths feature.
     *
     * @param version the version to test against.
     * @return true if supported, false otherwise.
     */
    boolean isSupportedBy(ProtocolVersion version) {
        switch (this) {
            case KEYSPACE_ON_QUERY:
                return version == ProtocolVersion.V5 || version == ProtocolVersion.DSE_V2;
            case PREPARED_METADATA_CHANGES:
                return version == ProtocolVersion.V5 || version == ProtocolVersion.DSE_V2;
            case CUSTOM_PAYLOADS:
                return version.compareTo(ProtocolVersion.V4) >= 0;
            case CLIENT_TIMESTAMPS:
                return version.compareTo(ProtocolVersion.V3) >= 0;
            default:
                return false;
        }
    }

}