com.couchbase.client.java.transactions.config.TransactionGetOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation

The official Couchbase Java SDK

There is a newer version: 3.7.5

/*
 * Copyright 2024 Couchbase, 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.couchbase.client.java.transactions.config;

import com.couchbase.client.core.annotation.SinceCouchbase;
import com.couchbase.client.core.annotation.Stability;
import com.couchbase.client.java.codec.Transcoder;
import reactor.util.annotation.Nullable;

/**
 * Operations controlling a transactional get.
 */
@Stability.Volatile
public class TransactionGetOptions {
    public static final TransactionGetOptions DEFAULT = new TransactionGetOptions();

    private @Nullable Transcoder transcoder;

    private TransactionGetOptions() {
    }

    public static TransactionGetOptions transactionGetOptions() {
        return new TransactionGetOptions();
    }

    /**
     * Specify a custom {@link Transcoder} that is used to decode the content of the result.
     * 
     * If not-specified, the {@link com.couchbase.client.java.env.ClusterEnvironment}'s {@link com.couchbase.client.java.codec.JsonSerializer}
     * (NOT transcoder) is used.
     * 
     * It is marked as being available from 7.6.2 because prior to this, only JSON documents were supported in transactions.  This release added
     * support for binary documents.
     *
     * @param transcoder the custom transcoder that should be used for decoding.
     * @return this to allow method chaining.
     */
    @SinceCouchbase("7.6.2")
    public TransactionGetOptions transcoder(Transcoder transcoder) {
        this.transcoder = transcoder;
        return this;
    }

    @Stability.Internal
    public TransactionGetOptions.Built build() {
        return new TransactionGetOptions.Built();
    }

    @Stability.Internal
    public class Built {
        Built() {
        }

        public Transcoder transcoder() {
            return transcoder;
        }
    }
}