< prev index next >
src/java.desktop/share/classes/com/sun/imageio/plugins/common/ImageUtil.java
Print this page
@@ -104,39 +104,39 @@
System.out.println(createColorModel(bandedSM));
}
*/
/**
- * Creates a <code>ColorModel</code> that may be used with the
- * specified <code>SampleModel</code>. If a suitable
- * <code>ColorModel</code> cannot be found, this method returns
- * <code>null</code>.
- *
- * <p> Suitable <code>ColorModel</code>s are guaranteed to exist
- * for all instances of <code>ComponentSampleModel</code>.
- * For 1- and 3- banded <code>SampleModel</code>s, the returned
- * <code>ColorModel</code> will be opaque. For 2- and 4-banded
- * <code>SampleModel</code>s, the output will use alpha transparency
+ * Creates a {@code ColorModel} that may be used with the
+ * specified {@code SampleModel}. If a suitable
+ * {@code ColorModel} cannot be found, this method returns
+ * {@code null}.
+ *
+ * <p> Suitable {@code ColorModel}s are guaranteed to exist
+ * for all instances of {@code ComponentSampleModel}.
+ * For 1- and 3- banded {@code SampleModel}s, the returned
+ * {@code ColorModel} will be opaque. For 2- and 4-banded
+ * {@code SampleModel}s, the output will use alpha transparency
* which is not premultiplied. 1- and 2-banded data will use a
- * grayscale <code>ColorSpace</code>, and 3- and 4-banded data a sRGB
- * <code>ColorSpace</code>. Data with 5 or more bands will have a
- * <code>BogusColorSpace</code>.</p>
+ * grayscale {@code ColorSpace}, and 3- and 4-banded data a sRGB
+ * {@code ColorSpace}. Data with 5 or more bands will have a
+ * {@code BogusColorSpace}.</p>
*
- * <p>An instance of <code>DirectColorModel</code> will be created for
- * instances of <code>SinglePixelPackedSampleModel</code> with no more
+ * <p>An instance of {@code DirectColorModel} will be created for
+ * instances of {@code SinglePixelPackedSampleModel} with no more
* than 4 bands.</p>
*
- * <p>An instance of <code>IndexColorModel</code> will be created for
- * instances of <code>MultiPixelPackedSampleModel</code>. The colormap
- * will be a grayscale ramp with <code>1 << numberOfBits</code>
+ * <p>An instance of {@code IndexColorModel} will be created for
+ * instances of {@code MultiPixelPackedSampleModel}. The colormap
+ * will be a grayscale ramp with <code>1 << numberOfBits</code>
* entries ranging from zero to at most 255.</p>
*
- * @return An instance of <code>ColorModel</code> that is suitable for
- * the supplied <code>SampleModel</code>, or <code>null</code>.
+ * @return An instance of {@code ColorModel} that is suitable for
+ * the supplied {@code SampleModel}, or {@code null}.
*
- * @throws IllegalArgumentException If <code>sampleModel</code> is
- * <code>null</code>.
+ * @throws IllegalArgumentException If {@code sampleModel} is
+ * {@code null}.
*/
public static final ColorModel createColorModel(SampleModel sampleModel) {
// Check the parameter.
if(sampleModel == null) {
throw new IllegalArgumentException("sampleModel == null!");
@@ -240,23 +240,23 @@
return colorModel;
}
/**
- * For the case of binary data (<code>isBinary()</code> returns
- * <code>true</code>), return the binary data as a packed byte array.
+ * For the case of binary data ({@code isBinary()} returns
+ * {@code true}), return the binary data as a packed byte array.
* The data will be packed as eight bits per byte with no bit offset,
* i.e., the first bit in each image line will be the left-most of the
* first byte of the line. The line stride in bytes will be
- * <code>(int)((getWidth()+7)/8)</code>. The length of the returned
- * array will be the line stride multiplied by <code>getHeight()</code>
+ * {@code (int)((getWidth()+7)/8)}. The length of the returned
+ * array will be the line stride multiplied by {@code getHeight()}
*
* @return the binary data as a packed array of bytes with zero offset
- * of <code>null</code> if the data are not binary.
- * @throws IllegalArgumentException if <code>isBinary()</code> returns
- * <code>false</code> with the <code>SampleModel</code> of the
- * supplied <code>Raster</code> as argument.
+ * of {@code null} if the data are not binary.
+ * @throws IllegalArgumentException if {@code isBinary()} returns
+ * {@code false} with the {@code SampleModel} of the
+ * supplied {@code Raster} as argument.
*/
public static byte[] getPackedBinaryData(Raster raster,
Rectangle rect) {
SampleModel sm = raster.getSampleModel();
if(!isBinary(sm)) {
@@ -433,15 +433,15 @@
return binaryDataArray;
}
/**
* Returns the binary data unpacked into an array of bytes.
- * The line stride will be the width of the <code>Raster</code>.
+ * The line stride will be the width of the {@code Raster}.
*
- * @throws IllegalArgumentException if <code>isBinary()</code> returns
- * <code>false</code> with the <code>SampleModel</code> of the
- * supplied <code>Raster</code> as argument.
+ * @throws IllegalArgumentException if {@code isBinary()} returns
+ * {@code false} with the {@code SampleModel} of the
+ * supplied {@code Raster} as argument.
*/
public static byte[] getUnpackedBinaryData(Raster raster,
Rectangle rect) {
SampleModel sm = raster.getSampleModel();
if(!isBinary(sm)) {
@@ -513,17 +513,17 @@
return bdata;
}
/**
- * Sets the supplied <code>Raster</code>'s data from an array
+ * Sets the supplied {@code Raster}'s data from an array
* of packed binary data of the form returned by
- * <code>getPackedBinaryData()</code>.
+ * {@code getPackedBinaryData()}.
*
- * @throws IllegalArgumentException if <code>isBinary()</code> returns
- * <code>false</code> with the <code>SampleModel</code> of the
- * supplied <code>Raster</code> as argument.
+ * @throws IllegalArgumentException if {@code isBinary()} returns
+ * {@code false} with the {@code SampleModel} of the
+ * supplied {@code Raster} as argument.
*/
public static void setPackedBinaryData(byte[] binaryDataArray,
WritableRaster raster,
Rectangle rect) {
SampleModel sm = raster.getSampleModel();
@@ -759,20 +759,20 @@
}
}
}
/**
- * Copies data into the packed array of the <code>Raster</code>
+ * Copies data into the packed array of the {@code Raster}
* from an array of unpacked data of the form returned by
- * <code>getUnpackedBinaryData()</code>.
+ * {@code getUnpackedBinaryData()}.
*
* <p> If the data are binary, then the target bit will be set if
* and only if the corresponding byte is non-zero.
*
- * @throws IllegalArgumentException if <code>isBinary()</code> returns
- * <code>false</code> with the <code>SampleModel</code> of the
- * supplied <code>Raster</code> as argument.
+ * @throws IllegalArgumentException if {@code isBinary()} returns
+ * {@code false} with the {@code SampleModel} of the
+ * supplied {@code Raster} as argument.
*/
public static void setUnpackedBinaryData(byte[] bdata,
WritableRaster raster,
Rectangle rect) {
SampleModel sm = raster.getSampleModel();
@@ -1029,11 +1029,11 @@
*
* @param r The red channel color indices.
* @param g The green channel color indices.
* @param b The blue channel color indices.
* @return If all the indices have 256 entries, and are identical mappings,
- * return <code>true</code>; otherwise, return <code>false</code>.
+ * return {@code true}; otherwise, return {@code false}.
*/
public static boolean isIndicesForGrayscale(byte[] r, byte[] g, byte[] b) {
if (r.length != g.length || r.length != b.length)
return false;
@@ -1050,11 +1050,11 @@
}
return true;
}
- /** Converts the provided object to <code>String</code> */
+ /** Converts the provided object to {@code String} */
public static String convertObjectToString(Object obj) {
if (obj == null)
return "";
String s = "";
@@ -1081,14 +1081,14 @@
return obj.toString();
}
- /** Checks that the provided <code>ImageWriter</code> can encode
- * the provided <code>ImageTypeSpecifier</code> or not. If not, an
- * <code>IIOException</code> will be thrown.
- * @param writer The provided <code>ImageWriter</code>.
+ /** Checks that the provided {@code ImageWriter} can encode
+ * the provided {@code ImageTypeSpecifier} or not. If not, an
+ * {@code IIOException} will be thrown.
+ * @param writer The provided {@code ImageWriter}.
* @param type The image to be tested.
* @throws IIOException If the writer cannot encoded the provided image.
*/
public static final void canEncodeImage(ImageWriter writer,
ImageTypeSpecifier type)
@@ -1099,16 +1099,16 @@
throw new IIOException(I18N.getString("ImageUtil2")+" "+
writer.getClass().getName());
}
}
- /** Checks that the provided <code>ImageWriter</code> can encode
- * the provided <code>ColorModel</code> and <code>SampleModel</code>.
- * If not, an <code>IIOException</code> will be thrown.
- * @param writer The provided <code>ImageWriter</code>.
- * @param colorModel The provided <code>ColorModel</code>.
- * @param sampleModel The provided <code>SampleModel</code>.
+ /** Checks that the provided {@code ImageWriter} can encode
+ * the provided {@code ColorModel} and {@code SampleModel}.
+ * If not, an {@code IIOException} will be thrown.
+ * @param writer The provided {@code ImageWriter}.
+ * @param colorModel The provided {@code ColorModel}.
+ * @param sampleModel The provided {@code SampleModel}.
* @throws IIOException If the writer cannot encoded the provided image.
*/
public static final void canEncodeImage(ImageWriter writer,
ColorModel colorModel,
SampleModel sampleModel)
< prev index next >