com.google.code.tempusfugit.concurrency.annotations
Enum GuardedBy.Type

java.lang.Object
  java.lang.Enum<GuardedBy.Type>
      com.google.code.tempusfugit.concurrency.annotations.GuardedBy.Type

All Implemented Interfaces:

Serializable, Comparable<GuardedBy.Type>

Enclosing class:

GuardedBy

public static enum GuardedBy.Type
extends Enum<GuardedBy.Type>

Enum Constant Summary

CLASS
A class monitor, qualify with GuardedBy.details()

FIELD
A field, qualify with GuardedBy.details()

INNER_CLASS_THIS
Deprecated.

ITSELF
When members are guarded by themselves (some collection classes for example)

METHOD
The lock object is returned by calling the method, qualify with GuardedBy.details()

STATIC_FIELD
A static field, qualify with GuardedBy.details()

THIS
An intrinsic lock

Method Summary

static GuardedBy.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static GuardedBy.Type[]	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

THIS

public static final GuardedBy.Type THIS

An intrinsic lock

INNER_CLASS_THIS

@Deprecated
public static final GuardedBy.Type INNER_CLASS_THIS

Deprecated.

An inner class disambiguation from GuardedBy.Type.THIS monitor, qualify with @{link GuardedBy#details}

CLASS

public static final GuardedBy.Type CLASS

A class monitor, qualify with GuardedBy.details()

ITSELF

public static final GuardedBy.Type ITSELF

When members are guarded by themselves (some collection classes for example)

FIELD

public static final GuardedBy.Type FIELD

A field, qualify with GuardedBy.details()

STATIC_FIELD

public static final GuardedBy.Type STATIC_FIELD

A static field, qualify with GuardedBy.details()

METHOD

public static final GuardedBy.Type METHOD

The lock object is returned by calling the method, qualify with GuardedBy.details()

Method Detail

values

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

Returns:

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

valueOf

public static GuardedBy.Type 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