Class StringDocument

  • All Implemented Interfaces:
    Document<String>, Serializable

    public class StringDocument
    extends AbstractDocument<String>
    implements Serializable
    Handles a raw string as the document value. This document differs from 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.
    Since:
    2.0
    Author:
    Michael Nitschinger
    See Also:
    Serialized Form
    • Method Detail

      • create

        public static StringDocument create​(String id,
                                            String content,
                                            long cas)
        Creates a StringDocument which the document id, content and the CAS value.
        Parameters:
        id - the per-bucket unique document id.
        content - the content of the document.
        cas - the CAS (compare and swap) value for optimistic concurrency.
        Returns:
        a StringDocument.
      • create

        public static StringDocument create​(String id,
                                            int expiry,
                                            String content)
        Creates a StringDocument which the document id, content and the expiration time.
        Parameters:
        id - the per-bucket unique document id.
        content - the content of the document.
        expiry - the expiration time of the document.
        Returns:
        a StringDocument.
      • create

        public static StringDocument create​(String id,
                                            int expiry,
                                            String content,
                                            long cas)
        Creates a 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.
        Parameters:
        id - the per-bucket unique document id.
        content - the content of the document.
        cas - the CAS (compare and swap) value for optimistic concurrency.
        expiry - the expiration time of the document.
        Returns:
        a StringDocument.
      • create

        public static StringDocument create​(String id,
                                            int expiry,
                                            String content,
                                            long cas,
                                            MutationToken mutationToken)
        Creates a 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.
        Parameters:
        id - the per-bucket unique document id.
        content - the content of the document.
        cas - the CAS (compare and swap) value for optimistic concurrency.
        expiry - the expiration time of the document.
        Returns:
        a StringDocument.