This is the mail archive of the
java-patches@gcc.gnu.org
mailing list for the Java project.
[gui] Add docs to SampleModel
- From: Jerry Quinn <jlquinn at optonline dot net>
- To: java-patches at gcc dot gnu dot org
- Date: Sun, 31 Oct 2004 17:31:57 -0500
- Subject: [gui] Add docs to SampleModel
2004-10-31 Jerry Quinn <jlquinn@optonline.net>
* java/awt/image/SampleModel.java (createSubsetSampleModel): Add
javadocs.
Index: SampleModel.java
===================================================================
RCS file: /cvs/gcc/gcc/libjava/java/awt/image/SampleModel.java,v
retrieving revision 1.6.72.1
retrieving revision 1.6.72.2
diff -u -r1.6.72.1 -r1.6.72.2
--- SampleModel.java 24 Jun 2004 05:30:20 -0000 1.6.72.1
+++ SampleModel.java 31 Oct 2004 22:28:45 -0000 1.6.72.2
@@ -456,6 +456,17 @@
public abstract SampleModel createCompatibleSampleModel(int w, int h);
+ /**
+ * Return a SampleModel with a subset of the bands in this model.
+ *
+ * Selects bands.length bands from this sample model. The bands chosen
+ * are specified in the indices of bands[]. This also permits permuting
+ * the bands as well as taking a subset. Thus, giving an array with
+ * 1, 2, 3, ..., numbands, will give an identical sample model.
+ *
+ * @param bands Array with band indices to include.
+ * @return A new sample model
+ */
public abstract SampleModel createSubsetSampleModel(int[] bands);
public abstract DataBuffer createDataBuffer();