Author: britter
Date: Sun Jan 11 12:24:41 2015
New Revision: 1650898
URL: http://svn.apache.org/r1650898
Log:
JavaDoc for TiffOutputDirectory.findField(TagInfo)
Modified:
commons/proper/imaging/trunk/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputDirectory.java
Modified:
commons/proper/imaging/trunk/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputDirectory.java
URL:
http://svn.apache.org/viewvc/commons/proper/imaging/trunk/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputDirectory.java?rev=1650898&r1=1650897&r2=1650898&view=diff
==============================================================================
---
commons/proper/imaging/trunk/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputDirectory.java
(original)
+++
commons/proper/imaging/trunk/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputDirectory.java
Sun Jan 11 12:24:41 2015
@@ -428,10 +428,32 @@ public final class TiffOutputDirectory e
fields.removeAll(matches);
}
+ /**
+ * Finds the TiffOutputField for the given TagInfo from this
TiffOutputDirectory.
+ *
+ * <p>
+ * If there is no field matching the given TagInfo, null will be returned.
+ * </p>
+ *
+ * @param tagInfo the TagInfo specifying the field
+ * @return the field matching tagInfo or null, if the field isn't present
+ * @see #findField(int)
+ */
public TiffOutputField findField(final TagInfo tagInfo) {
return findField(tagInfo.tag);
}
+ /**
+ * Finds the TiffOutputField for the given tag from this
TiffOutputDirectory.
+ *
+ * <p>
+ * If there is no field matching the given tag, null will be returned.
+ * </p>
+ *
+ * @param tag the tag specifying the field
+ * @return the field matching tagInfo or null, if the field isn't present
+ * @see #findField(TagInfo)
+ */
public TiffOutputField findField(final int tag) {
for (TiffOutputField field : fields) {
if (field.tag == tag) {
