com.datastax.driver.extras.codecs.enums.EnumNameCodec Maven / Gradle / Ivy

Go to download

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

Extended functionality for the Java driver.

The 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.extras.codecs.enums;

import com.datastax.driver.core.TypeCodec;
import com.datastax.driver.extras.codecs.ParsingCodec;

/**
 * A codec that serializes {@link Enum} instances as CQL {@code varchar}s representing their
 * programmatic names as returned by {@link Enum#name()}.
 *
 * Note that this codec relies on the enum constant names; it is therefore vital that
 * enum names never change.
 *
 * @param  The Enum class this codec serializes from and deserializes to.
 */
public class EnumNameCodec> extends ParsingCodec {

  private final Class enumClass;

  public EnumNameCodec(Class enumClass) {
    this(TypeCodec.varchar(), enumClass);
  }

  public EnumNameCodec(TypeCodec innerCodec, Class enumClass) {
    super(innerCodec, enumClass);
    this.enumClass = enumClass;
  }

  @Override
  protected String toString(E value) {
    return value == null ? null : value.name();
  }

  @Override
  protected E fromString(String value) {
    return value == null ? null : Enum.valueOf(enumClass, value);
  }
}