org.lmdbjava

Enum PutFlags

java.lang.Object

java.lang.Enum<PutFlags>

org.lmdbjava.PutFlags

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PutFlags>, MaskedFlag

public enum PutFlags
extends java.lang.Enum<PutFlags>
implements MaskedFlag

Flags for use when performing a "put".

Enum Constant Summary

Enum Constants

Enum Constant and Description
MDB_APPEND Data is being appended, don't split full pages.
MDB_APPENDDUP Duplicate data is being appended, don't split full pages.
MDB_CURRENT For mdb_cursor_put: overwrite the current key/data pair.
MDB_MULTIPLE Store multiple data items in one call.
MDB_NODUPDATA Only for #MDB_DUPSORT For put: don't write if the key and data pair already exist. For mdb_cursor_del: remove all duplicate data items.
MDB_NOOVERWRITE For put: Don't write if the key already exists.
MDB_RESERVE For put: Just reserve space for data, don't copy it.

Method Summary

Modifier and Type	Method and Description
int	getMask() Obtains the integer value for this enum which can be included in a mask.
static PutFlags	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PutFlags[]	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

Methods inherited from interface org.lmdbjava.MaskedFlag

isSet, mask

Enum Constant Detail

MDB_NOOVERWRITE

public static final PutFlags MDB_NOOVERWRITE

For put: Don't write if the key already exists.

MDB_NODUPDATA

public static final PutFlags MDB_NODUPDATA

Only for #MDB_DUPSORT
For put: don't write if the key and data pair already exist.
For mdb_cursor_del: remove all duplicate data items.

MDB_CURRENT

public static final PutFlags MDB_CURRENT

For mdb_cursor_put: overwrite the current key/data pair.

MDB_RESERVE

public static final PutFlags MDB_RESERVE

For put: Just reserve space for data, don't copy it. Return a pointer to the reserved space.

MDB_APPEND

public static final PutFlags MDB_APPEND

Data is being appended, don't split full pages.

MDB_APPENDDUP

public static final PutFlags MDB_APPENDDUP

Duplicate data is being appended, don't split full pages.

MDB_MULTIPLE

public static final PutFlags MDB_MULTIPLE

Store multiple data items in one call. Only for #MDB_DUPFIXED.

Method Detail

values

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

Returns:

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

valueOf

public static PutFlags 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

getMask

public int getMask()

Description copied from interface: MaskedFlag

Obtains the integer value for this enum which can be included in a mask.

Specified by:

getMask in interface MaskedFlag

Returns:

the integer value for combination into a mask