io.etcd.jetcd.options.PutOption Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jetcd-core Show documentation
The newest version!
/**
 * Copyright 2017 The jetcd authors
 *
 * 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 io.etcd.jetcd.options;

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

/**
 * The options for put operation.
 */
public final class PutOption {

  public static final PutOption DEFAULT = newBuilder().build();

  public static Builder newBuilder() {
    return new Builder();
  }

  /**
   * Builder to construct a put option.
   */
  public static class Builder {

    private long leaseId = 0L;
    private boolean prevKV = false;

    private Builder() {
    }

    /**
     * Assign a leaseId for a put operation. Zero means no lease.
     *
     * @param leaseId lease id to apply to a put operation
     * @return builder
     * @throws IllegalArgumentException if lease is less than zero.
     */
    public Builder withLeaseId(long leaseId) {
      checkArgument(leaseId >= 0, "leaseId should greater than or equal to zero: leaseId=%s",
          leaseId);
      this.leaseId = leaseId;
      return this;
    }

    /**
     * When withPrevKV is set, put response contains previous key-value pair.
     *
     * @return builder
     */
    public Builder withPrevKV() {
      this.prevKV = true;
      return this;
    }

    /**
     * build the put option.
     *
     * @return the put option
     */
    public PutOption build() {
      return new PutOption(this.leaseId, this.prevKV);
    }

  }

  private final long leaseId;
  private final boolean prevKV;

  private PutOption(long leaseId, boolean prevKV) {
    this.leaseId = leaseId;
    this.prevKV = prevKV;
  }

  /**
   * Get the lease id.
   *
   * @return the lease id
   */
  public long getLeaseId() {
    return this.leaseId;
  }

  /**
   * Get the previous KV.
   *
   * @return the prevKV
   */
  public boolean getPrevKV() {
    return this.prevKV;
  }
}