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

Go to download

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

A driver for Apache Cassandra 1.2+ that works exclusively with the Cassandra Query Language version 3 (CQL3) and Cassandra's binary protocol.

There is a newer version: 4.0.0

Show newest version

/*
 * Copyright DataStax, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.datastax.driver.core;

import com.datastax.driver.core.exceptions.DriverInternalError;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableMap.Builder;
import java.util.Map;

/** Versions of the native protocol supported by the driver. */
public enum ProtocolVersion {
  V1("1.2.0", 1, null),
  V2("2.0.0", 2, V1),
  V3("2.1.0", 3, V2),
  V4("2.2.0", 4, V3),
  V5("4.0.0", 5, V4),
  V6("4.0.0", 6, V5);

  /** The most recent protocol version supported by the driver. */
  public static final ProtocolVersion NEWEST_SUPPORTED = V5;

  /** The most recent beta protocol version supported by the driver. */
  public static final ProtocolVersion NEWEST_BETA = V6;

  private final VersionNumber minCassandraVersion;

  private final int asInt;

  private final ProtocolVersion lowerSupported;

  private ProtocolVersion(String minCassandraVersion, int asInt, ProtocolVersion lowerSupported) {
    this.minCassandraVersion = VersionNumber.parse(minCassandraVersion);
    this.asInt = asInt;
    this.lowerSupported = lowerSupported;
  }

  VersionNumber minCassandraVersion() {
    return minCassandraVersion;
  }

  DriverInternalError unsupported() {
    return new DriverInternalError("Unsupported protocol version " + this);
  }

  /**
   * Returns the version as an integer.
   *
   * @return the integer representation.
   */
  public int toInt() {
    return asInt;
  }

  /**
   * Returns the highest supported version that is lower than this version. Returns {@code null} if
   * there isn't such a version.
   *
   * @return the highest supported version that is lower than this version.
   */
  public ProtocolVersion getLowerSupported() {
    return lowerSupported;
  }

  private static final Map INT_TO_VERSION;

  static {
    Builder builder = ImmutableMap.builder();
    for (ProtocolVersion version : values()) {
      builder.put(version.asInt, version);
    }
    INT_TO_VERSION = builder.build();
  }

  /**
   * Returns the value matching an integer version.
   *
   * @param i the version as an integer.
   * @return the matching enum value.
   * @throws IllegalArgumentException if the argument doesn't match any known version.
   */
  public static ProtocolVersion fromInt(int i) {
    ProtocolVersion version = INT_TO_VERSION.get(i);
    if (version == null)
      throw new IllegalArgumentException("No protocol version matching integer version " + i);
    return version;
  }
}