com.scalar.database.io.TextValue Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of scalardb Show documentation
A universal transaction manager that achieves database-agnostic transactions and distributed transactions that span multiple databases
There is a newer version: 3.14.0-alpha.1
Show newest version
package com.scalar.database.io;

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.common.base.MoreObjects;
import com.google.common.collect.ComparisonChain;
import java.nio.ByteBuffer;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Optional;
import javax.annotation.Nonnull;
import javax.annotation.concurrent.Immutable;

/**
 * A {@code Value} for a string
 *
 * @author Hiroyuki Yamada
 */
@Immutable
public final class TextValue implements Value {
  private static final String ANONYMOUS = "";
  private final String name;
  private final Optional bytes;

  /**
   * Constructs a {@code TextValue} with the specified name and value
   *
   * @param name name of the {@code Value}
   * @param value content of the {@code Value} in byte array
   */
  public TextValue(String name, byte[] value) {
    this.name = checkNotNull(name);
    if (value == null) {
      bytes = Optional.empty();
    } else {
      bytes = Optional.of(ByteBuffer.allocate(value.length));
      set(value);
    }
  }

  /**
   * Constructs a {@code TextValue} with the specified value. The name of this value is anonymous.
   *
   * @param value content of the {@code Value}
   */
  public TextValue(byte[] value) {
    this(ANONYMOUS, value);
  }

  /**
   * Constructs a {@code TextValue} with the specified name and value
   *
   * @param name name of the {@code Value}
   * @param value content of the {@code Value} in {@code String}
   */
  public TextValue(String name, String value) {
    checkNotNull(name);
    this.name = name;
    if (value == null) {
      bytes = Optional.empty();
    } else {
      byte[] byteValue = value.getBytes(StandardCharsets.UTF_8);
      bytes = Optional.of(ByteBuffer.allocate(byteValue.length));
      set(byteValue);
    }
  }

  /**
   * Constructs a {@code TextValue} with the specified value. The name of this value is anonymous.
   *
   * @param value content of the {@code Value}
   */
  public TextValue(String value) {
    this(ANONYMOUS, value);
  }

  /**
   * Sets the specified byte array
   *
   * @param value
   */
  private void set(byte[] value) {
    bytes.ifPresent(
        b -> {
          b.put(value);
          b.flip();
        });
  }

  /**
   * Returns the content of this {@code Value}
   *
   * @return an {@code Optional} of the content of this {@code Value} in byte array
   */
  @Nonnull
  public Optional getBytes() {
    return bytes.map(b -> Arrays.copyOf(b.array(), b.limit()));
  }

  /**
   * Returns the content of this {@code Value}
   *
   * @return an {@code Optional} of the content of this {@code Value} in {@code String}
   */
  @Nonnull
  public Optional getString() {
    return bytes.map(b -> new String(b.array(), StandardCharsets.UTF_8));
  }

  @Override
  @Nonnull
  public String getName() {
    return name;
  }

  @Override
  public TextValue copyWith(String name) {
    if (bytes.isPresent()) {
      return new TextValue(name, bytes.get().array());
    }
    return new TextValue(name, (byte[]) null);
  }

  @Override
  public void accept(ValueVisitor v) {
    v.visit(this);
  }

  @Override
  public int hashCode() {
    return bytes.hashCode();
  }

  /**
   * Indicates whether some other object is "equal to" this object. The other object is considered
   * equal if:
   *
   * 
   *   both super class instances are equal and
   *   
it is also an {@code TextValue} and
   *   
both instances have the same name and value
   * 
   *
   * @param o an object to be tested for equality
   * @return {@code true} if the other object is "equal to" this object otherwise {@code false}
   */
  @Override
  public boolean equals(Object o) {
    if (o == this) {
      return true;
    }
    if (!(o instanceof TextValue)) {
      return false;
    }
    TextValue other = (TextValue) o;
    return this.name.equals(other.name) && bytes.equals(other.bytes);
  }

  @Override
  public String toString() {
    return MoreObjects.toStringHelper(this).add("name", name).add("value", getString()).toString();
  }

  @Override
  public int compareTo(TextValue o) {
    if (bytes.isPresent() && o.bytes.isPresent()) {
      return ComparisonChain.start()
          .compare(bytes.get(), o.bytes.get())
          .compare(this.name, o.name)
          .result();
    } else {
      // either bytes or o.bytes is empty
      if (bytes.isPresent()) {
        return 1;
      } else if (o.bytes.isPresent()) {
        return -1;
      } else {
        return 0;
      }
    }
  }
}