< prev index next >

src/java.desktop/share/classes/java/awt/image/DataBufferFloat.java

Print this page

        

@@ -26,12 +26,12 @@
 package java.awt.image;
 
 import static sun.java2d.StateTrackable.State.*;
 
 /**
- * This class extends <code>DataBuffer</code> and stores data internally
- * in <code>float</code> form.
+ * This class extends {@code DataBuffer} and stores data internally
+ * in {@code float} form.
  * <p>
  * <a name="optimizations">
  * Note that some implementations may function more efficiently
  * if they can maintain control over how the data for an image is
  * stored.

@@ -56,11 +56,11 @@
 
     /** A reference to the default data bank. */
     float data[];
 
     /**
-     * Constructs a <code>float</code>-based <code>DataBuffer</code>
+     * Constructs a {@code float}-based {@code DataBuffer}
      * with a specified size.
      *
      * @param size The number of elements in the DataBuffer.
      */
     public DataBufferFloat(int size) {

@@ -69,18 +69,18 @@
         bankdata = new float[1][];
         bankdata[0] = data;
     }
 
     /**
-     * Constructs a <code>float</code>-based <code>DataBuffer</code>
+     * Constructs a {@code float}-based {@code DataBuffer}
      * with a specified number of banks, all of which are of a
      * specified size.
      *
      * @param size The number of elements in each bank of the
-     * <code>DataBuffer</code>.
+     * {@code DataBuffer}.
      * @param numBanks The number of banks in the
-     *        <code>DataBuffer</code>.
+     *        {@code DataBuffer}.
      */
     public DataBufferFloat(int size, int numBanks) {
         super(STABLE, TYPE_FLOAT, size, numBanks);
         bankdata = new float[numBanks][];
         for (int i= 0; i < numBanks; i++) {

@@ -88,47 +88,47 @@
         }
         data = bankdata[0];
     }
 
     /**
-     * Constructs a <code>float</code>-based <code>DataBuffer</code>
+     * Constructs a {@code float}-based {@code DataBuffer}
      * with the specified data array.  Only the first
-     * <code>size</code> elements are available for use by this
-     * <code>DataBuffer</code>.  The array must be large enough to
-     * hold <code>size</code> elements.
+     * {@code size} elements are available for use by this
+     * {@code DataBuffer}.  The array must be large enough to
+     * hold {@code size} elements.
      * <p>
      * Note that {@code DataBuffer} objects created by this constructor
      * may be incompatible with <a href="#optimizations">performance
      * optimizations</a> used by some implementations (such as caching
      * an associated image in video memory).
      *
-     * @param dataArray An array of <code>float</code>s to be used as the
-     *                  first and only bank of this <code>DataBuffer</code>.
+     * @param dataArray An array of {@code float}s to be used as the
+     *                  first and only bank of this {@code DataBuffer}.
      * @param size The number of elements of the array to be used.
      */
     public DataBufferFloat(float dataArray[], int size) {
         super(UNTRACKABLE, TYPE_FLOAT, size);
         data = dataArray;
         bankdata = new float[1][];
         bankdata[0] = data;
     }
 
     /**
-     * Constructs a <code>float</code>-based <code>DataBuffer</code>
+     * Constructs a {@code float}-based {@code DataBuffer}
      * with the specified data array.  Only the elements between
-     * <code>offset</code> and <code>offset + size - 1</code> are
-     * available for use by this <code>DataBuffer</code>.  The array
-     * must be large enough to hold <code>offset + size</code>
+     * {@code offset} and {@code offset + size - 1} are
+     * available for use by this {@code DataBuffer}.  The array
+     * must be large enough to hold {@code offset + size}
      * elements.
      * <p>
      * Note that {@code DataBuffer} objects created by this constructor
      * may be incompatible with <a href="#optimizations">performance
      * optimizations</a> used by some implementations (such as caching
      * an associated image in video memory).
      *
-     * @param dataArray An array of <code>float</code>s to be used as the
-     *                  first and only bank of this <code>DataBuffer</code>.
+     * @param dataArray An array of {@code float}s to be used as the
+     *                  first and only bank of this {@code DataBuffer}.
      * @param size The number of elements of the array to be used.
      * @param offset The offset of the first element of the array
      *               that will be used.
      */
     public DataBufferFloat(float dataArray[], int size, int offset) {

@@ -137,57 +137,57 @@
         bankdata = new float[1][];
         bankdata[0] = data;
     }
 
     /**
-     * Constructs a <code>float</code>-based <code>DataBuffer</code>
+     * Constructs a {@code float}-based {@code DataBuffer}
      * with the specified data arrays.  Only the first
-     * <code>size</code> elements of each array are available for use
-     * by this <code>DataBuffer</code>.  The number of banks will be
-     * equal to <code>dataArray.length</code>.
+     * {@code size} elements of each array are available for use
+     * by this {@code DataBuffer}.  The number of banks will be
+     * equal to {@code dataArray.length}.
      * <p>
      * Note that {@code DataBuffer} objects created by this constructor
      * may be incompatible with <a href="#optimizations">performance
      * optimizations</a> used by some implementations (such as caching
      * an associated image in video memory).
      *
-     * @param dataArray An array of arrays of <code>float</code>s to be
-     *                  used as the banks of this <code>DataBuffer</code>.
+     * @param dataArray An array of arrays of {@code float}s to be
+     *                  used as the banks of this {@code DataBuffer}.
      * @param size The number of elements of each array to be used.
      */
     public DataBufferFloat(float dataArray[][], int size) {
         super(UNTRACKABLE, TYPE_FLOAT, size, dataArray.length);
         bankdata = dataArray.clone();
         data = bankdata[0];
     }
 
     /**
-     * Constructs a <code>float</code>-based <code>DataBuffer</code>
+     * Constructs a {@code float}-based {@code DataBuffer}
      * with the specified data arrays, size, and per-bank offsets.
-     * The number of banks is equal to <code>dataArray.length</code>.
-     * Each array must be at least as large as <code>size</code> plus the
+     * The number of banks is equal to {@code dataArray.length}.
+     * Each array must be at least as large as {@code size} plus the
      * corresponding offset.  There must be an entry in the offsets
      * array for each data array.
      * <p>
      * Note that {@code DataBuffer} objects created by this constructor
      * may be incompatible with <a href="#optimizations">performance
      * optimizations</a> used by some implementations (such as caching
      * an associated image in video memory).
      *
-     * @param dataArray An array of arrays of <code>float</code>s to be
-     *                  used as the banks of this <code>DataBuffer</code>.
+     * @param dataArray An array of arrays of {@code float}s to be
+     *                  used as the banks of this {@code DataBuffer}.
      * @param size The number of elements of each array to be used.
      * @param offsets An array of integer offsets, one for each bank.
      */
     public DataBufferFloat(float dataArray[][], int size, int offsets[]) {
         super(UNTRACKABLE, TYPE_FLOAT, size,dataArray.length, offsets);
         bankdata = dataArray.clone();
         data = bankdata[0];
     }
 
     /**
-     * Returns the default (first) <code>float</code> data array.
+     * Returns the default (first) {@code float} data array.
      * <p>
      * Note that calling this method may cause this {@code DataBuffer}
      * object to be incompatible with <a href="#optimizations">performance
      * optimizations</a> used by some implementations (such as caching
      * an associated image in video memory).

@@ -206,11 +206,11 @@
      * object to be incompatible with <a href="#optimizations">performance
      * optimizations</a> used by some implementations (such as caching
      * an associated image in video memory).
      *
      * @param bank the data array
-     * @return the data array specified by <code>bank</code>.
+     * @return the data array specified by {@code bank}.
      */
     public float[] getData(int bank) {
         theTrackable.setUntrackable();
         return bankdata[bank];
     }

@@ -230,40 +230,40 @@
         return bankdata.clone();
     }
 
     /**
      * Returns the requested data array element from the first
-     * (default) bank as an <code>int</code>.
+     * (default) bank as an {@code int}.
      *
      * @param i The desired data array element.
      *
-     * @return The data entry as an <code>int</code>.
+     * @return The data entry as an {@code int}.
      * @see #setElem(int, int)
      * @see #setElem(int, int, int)
      */
     public int getElem(int i) {
         return (int)(data[i+offset]);
     }
 
     /**
      * Returns the requested data array element from the specified
-     * bank as an <code>int</code>.
+     * bank as an {@code int}.
      *
      * @param bank The bank number.
      * @param i The desired data array element.
      *
-     * @return The data entry as an <code>int</code>.
+     * @return The data entry as an {@code int}.
      * @see #setElem(int, int)
      * @see #setElem(int, int, int)
      */
     public int getElem(int bank, int i) {
         return (int)(bankdata[bank][i+offsets[bank]]);
     }
 
     /**
      * Sets the requested data array element in the first (default)
-     * bank to the given <code>int</code>.
+     * bank to the given {@code int}.
      *
      * @param i The desired data array element.
      * @param val The value to be set.
      * @see #getElem(int)
      * @see #getElem(int, int)

@@ -273,11 +273,11 @@
         theTrackable.markDirty();
     }
 
     /**
      * Sets the requested data array element in the specified bank to
-     * the given <code>int</code>.
+     * the given {@code int}.
      *
      * @param bank The bank number.
      * @param i The desired data array element.
      * @param val The value to be set.
      * @see #getElem(int)

@@ -288,40 +288,40 @@
         theTrackable.markDirty();
     }
 
     /**
      * Returns the requested data array element from the first
-     * (default) bank as a <code>float</code>.
+     * (default) bank as a {@code float}.
      *
      * @param i The desired data array element.
      *
-     * @return The data entry as a <code>float</code>.
+     * @return The data entry as a {@code float}.
      * @see #setElemFloat(int, float)
      * @see #setElemFloat(int, int, float)
      */
     public float getElemFloat(int i) {
         return data[i+offset];
     }
 
     /**
      * Returns the requested data array element from the specified
-     * bank as a <code>float</code>.
+     * bank as a {@code float}.
      *
      * @param bank The bank number.
      * @param i The desired data array element.
      *
-     * @return The data entry as a <code>float</code>.
+     * @return The data entry as a {@code float}.
      * @see #setElemFloat(int, float)
      * @see #setElemFloat(int, int, float)
      */
     public float getElemFloat(int bank, int i) {
         return bankdata[bank][i+offsets[bank]];
     }
 
     /**
      * Sets the requested data array element in the first (default)
-     * bank to the given <code>float</code>.
+     * bank to the given {@code float}.
      *
      * @param i The desired data array element.
      * @param val The value to be set.
      * @see #getElemFloat(int)
      * @see #getElemFloat(int, int)

@@ -331,11 +331,11 @@
         theTrackable.markDirty();
     }
 
     /**
      * Sets the requested data array element in the specified bank to
-     * the given <code>float</code>.
+     * the given {@code float}.
      *
      * @param bank The bank number.
      * @param i The desired data array element.
      * @param val The value to be set.
      * @see #getElemFloat(int)

@@ -346,40 +346,40 @@
         theTrackable.markDirty();
     }
 
     /**
      * Returns the requested data array element from the first
-     * (default) bank as a <code>double</code>.
+     * (default) bank as a {@code double}.
      *
      * @param i The desired data array element.
      *
-     * @return The data entry as a <code>double</code>.
+     * @return The data entry as a {@code double}.
      * @see #setElemDouble(int, double)
      * @see #setElemDouble(int, int, double)
      */
     public double getElemDouble(int i) {
         return (double)data[i+offset];
     }
 
     /**
      * Returns the requested data array element from the specified
-     * bank as a <code>double</code>.
+     * bank as a {@code double}.
      *
      * @param bank The bank number.
      * @param i The desired data array element.
      *
-     * @return The data entry as a <code>double</code>.
+     * @return The data entry as a {@code double}.
      * @see #setElemDouble(int, double)
      * @see #setElemDouble(int, int, double)
      */
     public double getElemDouble(int bank, int i) {
         return (double)bankdata[bank][i+offsets[bank]];
     }
 
     /**
      * Sets the requested data array element in the first (default)
-     * bank to the given <code>double</code>.
+     * bank to the given {@code double}.
      *
      * @param i The desired data array element.
      * @param val The value to be set.
      * @see #getElemDouble(int)
      * @see #getElemDouble(int, int)

@@ -389,11 +389,11 @@
         theTrackable.markDirty();
     }
 
     /**
      * Sets the requested data array element in the specified bank to
-     * the given <code>double</code>.
+     * the given {@code double}.
      *
      * @param bank The bank number.
      * @param i The desired data array element.
      * @param val The value to be set.
      * @see #getElemDouble(int)
< prev index next >