com.cloudant.sync.replication

Enum PushAttachmentsInline

java.lang.Object

java.lang.Enum<PushAttachmentsInline>

com.cloudant.sync.replication.PushAttachmentsInline

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PushAttachmentsInline>

public enum PushAttachmentsInline
extends java.lang.Enum<PushAttachmentsInline>

Strategy to decide whether to push attachments inline:

• False: Always push attachments separately from JSON body, via multipart/related
• Small: Push small attachments inline, and large attachments separately. Uses SavedAttachment.isLarge() to determine whether attachment is small or large.
• True: Always push attachments inline in JSON body, as a base64-encoded string.

Note that all attachments belonging to a pushed revision are either sent via multipart/related, or all inline in JSON body, as a base64-encoded string. Further details of this can be found at RevisionHistoryHelper.shouldInline(List, PushAttachmentsInline, int)

See Also:

RevisionHistoryHelper

API Status: Public

Enum Constant Summary

Enum Constants

Enum Constant and Description
False
Small
True

Method Summary

Modifier and Type	Method and Description
static PushAttachmentsInline	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PushAttachmentsInline[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

False

public static final PushAttachmentsInline False

Small

public static final PushAttachmentsInline Small

True

public static final PushAttachmentsInline True

Method Detail

values

public static PushAttachmentsInline[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PushAttachmentsInline c : PushAttachmentsInline.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PushAttachmentsInline valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null