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

   1 *java.util.concurrent.atomic.AtomicReferenceArray* *AtomicReferenceArray* An arr
   2
   3 public class AtomicReferenceArray<E>
   4   extends    |java.lang.Object|
   5   implements |java.io.Serializable|
   6
   7 |java.util.concurrent.atomic.AtomicReferenceArray_Description|
   8 |java.util.concurrent.atomic.AtomicReferenceArray_Fields|
   9 |java.util.concurrent.atomic.AtomicReferenceArray_Constructors|
  10 |java.util.concurrent.atomic.AtomicReferenceArray_Methods|
  11
  12 ================================================================================
  13
  14 *java.util.concurrent.atomic.AtomicReferenceArray_Constructors*
  15 |java.util.concurrent.atomic.AtomicReferenceArray(E[])|Creates a new AtomicRefe
  16 |java.util.concurrent.atomic.AtomicReferenceArray(int)|Creates a new AtomicRefe
  17
  18 *java.util.concurrent.atomic.AtomicReferenceArray_Methods*
  19 |java.util.concurrent.atomic.AtomicReferenceArray.compareAndSet(int,E,E)|Atomic
  20 |java.util.concurrent.atomic.AtomicReferenceArray.get(int)|Gets the current val
  21 |java.util.concurrent.atomic.AtomicReferenceArray.getAndSet(int,E)|Atomically s
  22 |java.util.concurrent.atomic.AtomicReferenceArray.lazySet(int,E)|Eventually set
  23 |java.util.concurrent.atomic.AtomicReferenceArray.length()|Returns the length o
  24 |java.util.concurrent.atomic.AtomicReferenceArray.set(int,E)|Sets the element a
  25 |java.util.concurrent.atomic.AtomicReferenceArray.toString()|Returns the String
  26 |java.util.concurrent.atomic.AtomicReferenceArray.weakCompareAndSet(int,E,E)|At
  27
  28 *java.util.concurrent.atomic.AtomicReferenceArray_Description*
  29
  30 An array of object references in which elements may be updated atomically. See
  31 the (|java.util.concurrent.atomic|) package specification for description of
  32 the properties of atomic variables.
  33
  34
  35
  36 *java.util.concurrent.atomic.AtomicReferenceArray(E[])*
  37
  38 public AtomicReferenceArray(E[] array)
  39
  40 Creates a new AtomicReferenceArray with the same length as, and all elements
  41 copied from, the given array.
  42
  43     array - the array to copy elements from
  44
  45 *java.util.concurrent.atomic.AtomicReferenceArray(int)*
  46
  47 public AtomicReferenceArray(int length)
  48
  49 Creates a new AtomicReferenceArray of given length.
  50
  51     length - the length of the array
  52
  53 *java.util.concurrent.atomic.AtomicReferenceArray.compareAndSet(int,E,E)*
  54
  55 public final boolean compareAndSet(
  56   int i,
  57   E expect,
  58   E update)
  59
  60 Atomically sets the element at positionito the given updated value if the
  61 current value==the expected value.
  62
  63
  64     i - the index
  65     expect - the expected value
  66     update - the new value
  67
  68     Returns: true if successful. False return indicates that the actual value was not equal
  69              to the expected value.
  70
  71 *java.util.concurrent.atomic.AtomicReferenceArray.get(int)*
  72
  73 public final |E| get(int i)
  74
  75 Gets the current value at positioni.
  76
  77
  78     i - the index
  79
  80     Returns: the current value
  81
  82 *java.util.concurrent.atomic.AtomicReferenceArray.getAndSet(int,E)*
  83
  84 public final |E| getAndSet(
  85   int i,
  86   E newValue)
  87
  88 Atomically sets the element at positionito the given value and returns the old
  89 value.
  90
  91
  92     i - the index
  93     newValue - the new value
  94
  95     Returns: the previous value
  96
  97 *java.util.concurrent.atomic.AtomicReferenceArray.lazySet(int,E)*
  98
  99 public final void lazySet(
 100   int i,
 101   E newValue)
 102
 103 Eventually sets the element at positionito the given value.
 104
 105
 106     i - the index
 107     newValue - the new value
 108
 109 *java.util.concurrent.atomic.AtomicReferenceArray.length()*
 110
 111 public final int length()
 112
 113 Returns the length of the array.
 114
 115
 116
 117     Returns: the length of the array
 118
 119 *java.util.concurrent.atomic.AtomicReferenceArray.set(int,E)*
 120
 121 public final void set(
 122   int i,
 123   E newValue)
 124
 125 Sets the element at positionito the given value.
 126
 127
 128     i - the index
 129     newValue - the new value
 130
 131 *java.util.concurrent.atomic.AtomicReferenceArray.toString()*
 132
 133 public |java.lang.String| toString()
 134
 135 Returns the String representation of the current values of array.
 136
 137
 138
 139     Returns: the String representation of the current values of array.
 140
 141 *java.util.concurrent.atomic.AtomicReferenceArray.weakCompareAndSet(int,E,E)*
 142
 143 public final boolean weakCompareAndSet(
 144   int i,
 145   E expect,
 146   E update)
 147
 148 Atomically sets the element at positionito the given updated value if the
 149 current value==the expected value.
 150
 151 May fail spuriously and does not provide ordering guarantees, so is only rarely
 152 an appropriate alternative tocompareAndSet.
 153
 154
 155     i - the index
 156     expect - the expected value
 157     update - the new value
 158
 159     Returns: true if successful.
 160
 161