net.openhft.posix

Enum MclFlag

java.lang.Object

java.lang.Enum<MclFlag>

net.openhft.posix.MclFlag

All Implemented Interfaces:

Serializable, Comparable<MclFlag>

public enum MclFlag
extends Enum<MclFlag>

This enum represents the different flags for memory locking (mlockall) operations. It defines the flags used to control how pages are locked in memory.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MclCurrent
MclCurrentOnFault
MclFuture
MclFutureOnFault

Method Summary

Modifier and Type	Method and Description
int	code() This method is a getter for the code instance variable.
static MclFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static MclFlag[]	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

MclCurrent

public static final MclFlag MclCurrent

MclFuture

public static final MclFlag MclFuture

MclCurrentOnFault

public static final MclFlag MclCurrentOnFault

MclFutureOnFault

public static final MclFlag MclFutureOnFault

Method Detail

values

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

Returns:

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

valueOf

public static MclFlag valueOf(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:

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

NullPointerException - if the argument is null

code

public int code()

This method is a getter for the code instance variable. It returns the current integer code of this MclFlag object.

Returns:

The current integer code of this MclFlag object