com.couchbase.client.java.document.StringDocument 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.7
/*
 * Copyright (c) 2016 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.document;

import com.couchbase.client.core.message.kv.MutationToken;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;

/**
 * Handles a raw string as the document value.
 *
 * This document differs from {@link JsonStringDocument} in that it is not automatically quoted and stored as-is on
 * the server side. The server will potentially not identify it is as a string if manual quotes are not added by the
 * application itself. It is compatible with legacy strings stored.
 *
 * @author Michael Nitschinger
 * @since 2.0
 */
public class StringDocument extends AbstractDocument implements Serializable {

    private static final long serialVersionUID = -8616443474645911439L;

    /**
     * Creates a {@link StringDocument} which the document id.
     *
     * @param id the per-bucket unique document id.
     * @return a {@link StringDocument}.
     */
    public static StringDocument create(String id) {
        return new StringDocument(id, 0, null, 0, null);
    }

    /**
     * Creates a {@link StringDocument} which the document id and content.
     *
     * @param id the per-bucket unique document id.
     * @param content the content of the document.
     * @return a {@link StringDocument}.
     */
    public static StringDocument create(String id, String content) {
        return new StringDocument(id, 0, content, 0, null);
    }

    /**
     * Creates a {@link StringDocument} which the document id, content and the CAS value.
     *
     * @param id the per-bucket unique document id.
     * @param content the content of the document.
     * @param cas the CAS (compare and swap) value for optimistic concurrency.
     * @return a {@link StringDocument}.
     */
    public static StringDocument create(String id, String content, long cas) {
        return new StringDocument(id, 0, content, cas, null);
    }

    /**
     * Creates a {@link StringDocument} which the document id, content and the expiration time.
     *
     * @param id the per-bucket unique document id.
     * @param content the content of the document.
     * @param expiry the expiration time of the document.
     * @return a {@link StringDocument}.
     */
    public static StringDocument create(String id, int expiry, String content) {
        return new StringDocument(id, expiry, content, 0, null);
    }

    /**
     * Creates a {@link StringDocument} which the document id, content, CAS value, expiration time and status code.
     *
     * This factory method is normally only called within the client library when a response is analyzed and a document
     * is returned which is enriched with the status code. It does not make sense to pre populate the status field from
     * the user level code.
     *
     * @param id the per-bucket unique document id.
     * @param content the content of the document.
     * @param cas the CAS (compare and swap) value for optimistic concurrency.
     * @param expiry the expiration time of the document.
     * @return a {@link StringDocument}.
     */
    public static StringDocument create(String id, int expiry, String content, long cas) {
        return new StringDocument(id, expiry, content, cas, null);
    }

    /**
     * Creates a {@link StringDocument} which the document id, content, CAS value, expiration time and status code.
     *
     * This factory method is normally only called within the client library when a response is analyzed and a document
     * is returned which is enriched with the status code. It does not make sense to pre populate the status field from
     * the user level code.
     *
     * @param id the per-bucket unique document id.
     * @param content the content of the document.
     * @param cas the CAS (compare and swap) value for optimistic concurrency.
     * @param expiry the expiration time of the document.
     * @return a {@link StringDocument}.
     */
    public static StringDocument create(String id, int expiry, String content, long cas, MutationToken mutationToken) {
        return new StringDocument(id, expiry, content, cas, mutationToken);
    }

    /**
     * Creates a copy from a different {@link StringDocument}, but changes the document ID and content.
     *
     * @param doc the original {@link StringDocument} to copy.
     * @param id the per-bucket unique document id.
     * @param content the content of the document.
     * @return a copied {@link StringDocument} with the changed properties.
     */
    public static StringDocument from(StringDocument doc, String id, String content) {
        return StringDocument.create(id, doc.expiry(), content, doc.cas(), doc.mutationToken());
    }

    /**
     * Creates a copy from a different {@link StringDocument}, but changes the CAS value.
     *
     * @param doc the original {@link StringDocument} to copy.
     * @param cas the CAS (compare and swap) value for optimistic concurrency.
     * @return a copied {@link StringDocument} with the changed properties.
     */
    public static StringDocument from(StringDocument doc, long cas) {
        return StringDocument.create(doc.id(), doc.expiry(), doc.content(), cas, doc.mutationToken());
    }

    /**
     * Private constructor which is called by the static factory methods eventually.
     *
     * @param id the per-bucket unique document id.
     * @param content the content of the document.
     * @param cas the CAS (compare and swap) value for optimistic concurrency.
     * @param expiry the expiration time of the document.
     */
    private StringDocument(String id, int expiry, String content, long cas, MutationToken mutationToken) {
        super(id, expiry, content, cas, mutationToken);
    }

    private void writeObject(ObjectOutputStream stream) throws IOException {
        writeToSerializedStream(stream);
    }

    private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException {
        readFromSerializedStream(stream);
    }
}