com.couchbase.client.java.document.JsonDocument 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
Show all versions of java-client Show documentation
The official Couchbase Java SDK
/**
* Copyright (C) 2014 Couchbase, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALING
* IN THE SOFTWARE.
*/
package com.couchbase.client.java.document;
import com.couchbase.client.core.message.kv.MutationToken;
import com.couchbase.client.java.document.json.JsonObject;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
/**
* Represents a {@link Document} that contains a {@link JsonObject} as the content.
*
* The {@link JsonDocument} is one of the most integral parts of the API. It is intended to be used as a canonical
* wrapper around retrieval and mutation operations, abstracting away JSON internals.
*
* Note that there is no public constructor available, but rather a multitude of factory methods that allow you to work
* nicely with this immutable value object. It is possible to construct empty/fresh ones, but also copies will be
* created from passed in documents, allowing you to override specific parts during the copy process.
*
* This document is interoperable with other SDKs.
*
* It can always be the case that some or all fields of a {@link JsonDocument} are not set, depending on the operation
* performed. Here are the accessible fields and their default values:
*
* +---------------+---------+
* | Field | Default |
* +---------------+---------+
* | id | null |
* | content | null |
* | cas | 0 |
* | expiry | 0 |
* | status | null |
* | mutationToken | null |
* +---------------+---------+
*
* @author Michael Nitschinger
* @since 2.0
*/
public class JsonDocument extends AbstractDocument implements Serializable {
private static final long serialVersionUID = 2050104986260610101L;
/**
* Creates a {@link JsonDocument} which the document id.
*
* @param id the per-bucket unique document id.
* @return a {@link JsonDocument}.
*/
public static JsonDocument create(String id) {
return new JsonDocument(id, 0, null, 0, null);
}
/**
* Creates a {@link JsonDocument} which the document id and JSON content.
*
* @param id the per-bucket unique document id.
* @param content the content of the document.
* @return a {@link JsonDocument}.
*/
public static JsonDocument create(String id, JsonObject content) {
return new JsonDocument(id, 0, content, 0, null);
}
/**
* Creates a {@link JsonDocument} which the document id, JSON 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 JsonDocument}.
*/
public static JsonDocument create(String id, JsonObject content, long cas) {
return new JsonDocument(id, 0, content, cas, null);
}
/**
* Creates a {@link JsonDocument} which the document id, JSON 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 JsonDocument}.
*/
public static JsonDocument create(String id, int expiry, JsonObject content) {
return new JsonDocument(id, expiry, content, 0, null);
}
/**
* Creates a {@link JsonDocument} which the document id, JSON 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 JsonDocument}.
*/
public static JsonDocument create(String id, int expiry, JsonObject content, long cas) {
return new JsonDocument(id, expiry, content, cas, null);
}
/**
* Creates a {@link JsonDocument} which the document id, JSON 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 JsonDocument}.
*/
public static JsonDocument create(String id, int expiry, JsonObject content, long cas, MutationToken mutationToken) {
return new JsonDocument(id, expiry, content, cas, mutationToken);
}
/**
* Creates a copy from a different {@link JsonDocument}, but changes the document ID.
*
* @param doc the original {@link JsonDocument} to copy.
* @param id the per-bucket unique document id.
* @return a copied {@link JsonDocument} with the changed properties.
*/
public static JsonDocument from(JsonDocument doc, String id) {
return JsonDocument.create(id, doc.expiry(), doc.content(), doc.cas(), doc.mutationToken());
}
/**
* Creates a copy from a different {@link JsonDocument}, but changes the content.
*
* @param doc the original {@link JsonDocument} to copy.
* @param content the content of the document.
* @return a copied {@link JsonDocument} with the changed properties.
*/
public static JsonDocument from(JsonDocument doc, JsonObject content) {
return JsonDocument.create(doc.id(), doc.expiry(), content, doc.cas(), doc.mutationToken());
}
/**
* Creates a copy from a different {@link JsonDocument}, but changes the document ID and content.
*
* @param doc the original {@link JsonDocument} to copy.
* @param id the per-bucket unique document id.
* @param content the content of the document.
* @return a copied {@link JsonDocument} with the changed properties.
*/
public static JsonDocument from(JsonDocument doc, String id, JsonObject content) {
return JsonDocument.create(id, doc.expiry(), content, doc.cas(), doc.mutationToken());
}
/**
* Creates a copy from a different {@link JsonDocument}, but changes the CAS value.
*
* @param doc the original {@link JsonDocument} to copy.
* @param cas the CAS (compare and swap) value for optimistic concurrency.
* @return a copied {@link JsonDocument} with the changed properties.
*/
public static JsonDocument from(JsonDocument doc, long cas) {
return JsonDocument.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 JsonDocument(String id, int expiry, JsonObject 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);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy