com.hcl.domino.keep.dbrequests

Enum KeepJnxSession.Note2JsonOptions

java.lang.Object

java.lang.Enum<KeepJnxSession.Note2JsonOptions>

com.hcl.domino.keep.dbrequests.KeepJnxSession.Note2JsonOptions

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<KeepJnxSession.Note2JsonOptions>

Enclosing class:

KeepJnxSession

public static enum KeepJnxSession.Note2JsonOptions
extends java.lang.Enum<KeepJnxSession.Note2JsonOptions>

Options available when converting a Note into a Json Structure

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCLUDE_LISTED_FIELDS Use the keys of the parameter map to exclude fields
INCLUDE_RICHTEXT Include fields that are RichText
ONLY_LISTED_FIELDS Only return fields listed as keys in the parameter map
RICHTEXT_AS_MIME Convert RichText into MIME

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INCLUDE_RICHTEXT

public static final KeepJnxSession.Note2JsonOptions INCLUDE_RICHTEXT

Include fields that are RichText

ONLY_LISTED_FIELDS

public static final KeepJnxSession.Note2JsonOptions ONLY_LISTED_FIELDS

Only return fields listed as keys in the parameter map

EXCLUDE_LISTED_FIELDS

public static final KeepJnxSession.Note2JsonOptions EXCLUDE_LISTED_FIELDS

Use the keys of the parameter map to exclude fields

RICHTEXT_AS_MIME

public static final KeepJnxSession.Note2JsonOptions RICHTEXT_AS_MIME

Convert RichText into MIME

Method Detail

values

public static KeepJnxSession.Note2JsonOptions[] 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 (KeepJnxSession.Note2JsonOptions c : KeepJnxSession.Note2JsonOptions.values())
    System.out.println(c);

Returns:

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

valueOf

public static KeepJnxSession.Note2JsonOptions 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