sample/java.util.concurrent.atomic.AtomicLongFieldUpdater.txt

   1 *java.util.concurrent.atomic.AtomicLongFieldUpdater* *AtomicLongFieldUpdater* A
   2
   3 public abstract class AtomicLongFieldUpdater
   4   extends    |java.lang.Object|
   5
   6 |java.util.concurrent.atomic.AtomicLongFieldUpdater_Description|
   7 |java.util.concurrent.atomic.AtomicLongFieldUpdater_Fields|
   8 |java.util.concurrent.atomic.AtomicLongFieldUpdater_Constructors|
   9 |java.util.concurrent.atomic.AtomicLongFieldUpdater_Methods|
  10
  11 ================================================================================
  12
  13 *java.util.concurrent.atomic.AtomicLongFieldUpdater_Constructors*
  14 |java.util.concurrent.atomic.AtomicLongFieldUpdater()|Protected do-nothing cons
  15
  16 *java.util.concurrent.atomic.AtomicLongFieldUpdater_Methods*
  17 |java.util.concurrent.atomic.AtomicLongFieldUpdater.addAndGet(T,long)|Atomicall
  18 |java.util.concurrent.atomic.AtomicLongFieldUpdater.compareAndSet(T,long,long)|
  19 |java.util.concurrent.atomic.AtomicLongFieldUpdater.decrementAndGet(T)|Atomical
  20 |java.util.concurrent.atomic.AtomicLongFieldUpdater.get(T)|Get the current valu
  21 |java.util.concurrent.atomic.AtomicLongFieldUpdater.getAndAdd(T,long)|Atomicall
  22 |java.util.concurrent.atomic.AtomicLongFieldUpdater.getAndDecrement(T)|Atomical
  23 |java.util.concurrent.atomic.AtomicLongFieldUpdater.getAndIncrement(T)|Atomical
  24 |java.util.concurrent.atomic.AtomicLongFieldUpdater.getAndSet(T,long)|Set to th
  25 |java.util.concurrent.atomic.AtomicLongFieldUpdater.incrementAndGet(T)|Atomical
  26 |java.util.concurrent.atomic.AtomicLongFieldUpdater.newUpdater(Class,String)|Cr
  27 |java.util.concurrent.atomic.AtomicLongFieldUpdater.set(T,long)|Set the field o
  28 |java.util.concurrent.atomic.AtomicLongFieldUpdater.weakCompareAndSet(T,long,long)|
  29
  30 *java.util.concurrent.atomic.AtomicLongFieldUpdater_Description*
  31
  32 A reflection-based utility that enables atomic updates to designated volatile
  33 long fields of designated classes. This class is designed for use in atomic
  34 data structures in which several fields of the same node are independently
  35 subject to atomic updates.
  36
  37 Note that the guarantees of the compareAndSet method in this class are weaker
  38 than in other atomic classes. Because this class cannot ensure that all uses of
  39 the field are appropriate for purposes of atomic access, it can guarantee
  40 atomicity and volatile semantics only with respect to other invocations of
  41 compareAndSet and set.
  42
  43
  44 *java.util.concurrent.atomic.AtomicLongFieldUpdater()*
  45
  46 protected AtomicLongFieldUpdater()
  47
  48 Protected do-nothing constructor for use by subclasses.
  49
  50
  51 *java.util.concurrent.atomic.AtomicLongFieldUpdater.addAndGet(T,long)*
  52
  53 public long addAndGet(
  54   java.lang.Object obj,
  55   long delta)
  56
  57 Atomically add the given value to current value.
  58
  59     obj - An object whose field to get and set
  60     delta - the value to add
  61
  62     Returns: the updated value;
  63 *java.util.concurrent.atomic.AtomicLongFieldUpdater.compareAndSet(T,long,long)*
  64
  65 public abstract boolean compareAndSet(
  66   java.lang.Object obj,
  67   long expect,
  68   long update)
  69
  70 Atomically set the value of the field of the given object managed by this
  71 Updater to the given updated value if the current value == the expected value.
  72 This method is guaranteed to be atomic with respect to other calls to
  73 compareAndSet and set, but not necessarily with respect to other changes in the
  74 field.
  75
  76     obj - An object whose field to conditionally set
  77     expect - the expected value
  78     update - the new value
  79
  80     Returns: true if successful.
  81 *java.util.concurrent.atomic.AtomicLongFieldUpdater.decrementAndGet(T)*
  82
  83 public long decrementAndGet(java.lang.Object obj)
  84
  85 Atomically decrement by one the current value.
  86
  87     obj - An object whose field to get and set
  88
  89     Returns: the updated value;
  90 *java.util.concurrent.atomic.AtomicLongFieldUpdater.get(T)*
  91
  92 public abstract long get(java.lang.Object obj)
  93
  94 Get the current value held in the field by the given object.
  95
  96     obj - An object whose field to get
  97
  98     Returns: the current value
  99 *java.util.concurrent.atomic.AtomicLongFieldUpdater.getAndAdd(T,long)*
 100
 101 public long getAndAdd(
 102   java.lang.Object obj,
 103   long delta)
 104
 105 Atomically add the given value to current value.
 106
 107     obj - An object whose field to get and set
 108     delta - the value to add
 109
 110     Returns: the previous value;
 111 *java.util.concurrent.atomic.AtomicLongFieldUpdater.getAndDecrement(T)*
 112
 113 public long getAndDecrement(java.lang.Object obj)
 114
 115 Atomically decrement by one the current value.
 116
 117     obj - An object whose field to get and set
 118
 119     Returns: the previous value;
 120 *java.util.concurrent.atomic.AtomicLongFieldUpdater.getAndIncrement(T)*
 121
 122 public long getAndIncrement(java.lang.Object obj)
 123
 124 Atomically increment by one the current value.
 125
 126     obj - An object whose field to get and set
 127
 128     Returns: the previous value;
 129 *java.util.concurrent.atomic.AtomicLongFieldUpdater.getAndSet(T,long)*
 130
 131 public long getAndSet(
 132   java.lang.Object obj,
 133   long newValue)
 134
 135 Set to the given value and return the old value.
 136
 137     obj - An object whose field to get and set
 138     newValue - the new value
 139
 140     Returns: the previous value
 141 *java.util.concurrent.atomic.AtomicLongFieldUpdater.incrementAndGet(T)*
 142
 143 public long incrementAndGet(java.lang.Object obj)
 144
 145 Atomically increment by one the current value.
 146
 147     obj - An object whose field to get and set
 148
 149     Returns: the updated value;
 150 *java.util.concurrent.atomic.AtomicLongFieldUpdater.newUpdater(Class,String)*
 151
 152 public static |java.util.concurrent.atomic.AtomicLongFieldUpdater| newUpdater(
 153   java.lang.Class tclass,
 154   java.lang.String fieldName)
 155
 156 Creates an updater for objects with the given field. The Class argument is
 157 needed to check that reflective types and generic types match.
 158
 159     tclass - the class of the objects holding the field
 160     fieldName - the name of the field to be updated.
 161
 162     Returns:
 163 *java.util.concurrent.atomic.AtomicLongFieldUpdater.set(T,long)*
 164
 165 public abstract void set(
 166   java.lang.Object obj,
 167   long newValue)
 168
 169 Set the field of the given object managed by this updater. This operation is
 170 guaranteed to act as a volatile store with respect to subsequent invocations of
 171 compareAndSet.
 172
 173     obj - An object whose field to set
 174     newValue - the new value
 175
 176 *java.util.concurrent.atomic.AtomicLongFieldUpdater.weakCompareAndSet(T,long,long)*
 177
 178 public abstract boolean weakCompareAndSet(
 179   java.lang.Object obj,
 180   long expect,
 181   long update)
 182
 183 Atomically set the value of the field of the given object managed by this
 184 Updater to the given updated value if the current value == the expected value.
 185 This method is guaranteed to be atomic with respect to other calls to
 186 compareAndSet and set, but not necessarily with respect to other changes in the
 187 field, and may fail spuriously.
 188
 189     obj - An object whose field to conditionally set
 190     expect - the expected value
 191     update - the new value
 192
 193     Returns: true if successful.
 194