infernap12/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2026-04-27 23:31:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

8149562: TIFFField#createFromMetadataNode javadoc should provide information about sibling/child nodes that should be part of parameter node

Browse Source 
Add a throws clause to the TIFFField.createFromMetadataNode method specification stating that the supplied Node parameter must adhere to the TIFFField element structure defined by the TIFF native image metadata DTD.

Reviewed-by: prr, darcy, serb
This commit is contained in:
Brian Burkhalter 2016-08-24 10:59:17 -07:00
parent 21d1580782
commit 60eccdede5
2 changed files with 35 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
jdk/src/java.desktop/share/classes/javax/imageio/plugins/tiff/TIFFField.java
View File

@ -412,7 +412,7 @@ public class TIFFField implements Cloneable {
/**
* Creates a {@code TIFFField} from a TIFF native image
* metadata node. If the value of the <tt>"number"</tt> attribute
* metadata node. If the value of the {@code "number"} attribute
* of the node is not found in {@code tagSet} then a new
* {@code TIFFTag} with name {@code TIFFTag.UNKNOWN_TAG_NAME}
* will be created and assigned to the field.
@ -420,20 +420,22 @@ public class TIFFField implements Cloneable {
* @param tagSet The {@code TIFFTagSet} to which the
* {@code TIFFTag} of the field belongs.
* @param node A native TIFF image metadata {@code TIFFField} node.
* @throws NullPointerException if {@code node} is
* {@code null}.
* @throws IllegalArgumentException if the name of the node is not
* {@code "TIFFField"}.
* @throws NullPointerException if the node does not contain any data.
* @throws IllegalArgumentException if the combination of node attributes
* and data is not legal per the {@link #TIFFField(TIFFTag,int,int,Object)}
* constructor specification.
* @throws IllegalArgumentException If the {@code Node} parameter content
* does not adhere to the {@code TIFFField} element structure defined by
* the <a href="../../metadata/doc-files/tiff_metadata.html#ImageMetadata">
* TIFF native image metadata format specification</a>, or if the
* combination of node attributes and data is not legal per the
* {@link #TIFFField(TIFFTag,int,int,Object)} constructor specification.
* Note that a cause might be set on such an exception.
* @return A new {@code TIFFField}.
*/
public static TIFFField createFromMetadataNode(TIFFTagSet tagSet,
Node node) {
if (node == null) {
throw new NullPointerException("node == null!");
// This method is specified to throw only IllegalArgumentExceptions
// so we create an IAE with a NullPointerException as its cause.
throw new IllegalArgumentException(new NullPointerException
("node == null!"));
}
String name = node.getNodeName();
if (!name.equals("TIFFField")) {
@ -487,7 +489,17 @@ public class TIFFField implements Cloneable {
tag = new TIFFTag(TIFFTag.UNKNOWN_TAG_NAME, tagNumber, 1 << type);
}
return new TIFFField(tag, type, count, data);
TIFFField field;
try {
field = new TIFFField(tag, type, count, data);
} catch (NullPointerException npe) {
// This method is specified to throw only IllegalArgumentExceptions
// so we catch the NullPointerException and set it as the cause of
// the IAE which is thrown.
throw new IllegalArgumentException(npe);
}
return field;
}
/**

15
jdk/test/javax/imageio/plugins/tiff/TIFFFieldTest.java
View File

@ -23,7 +23,7 @@
/**
* @test
* @bug 8152183
* @bug 8152183 8149562
* @author a.stepanov
* @summary Some checks for TIFFField methods
* @run main TIFFFieldTest
@ -455,8 +455,17 @@ public class TIFFFieldTest {
TIFFTagSet ts = new TIFFTagSet(tags);
boolean ok = false;
try { TIFFField.createFromMetadataNode(ts, null); }
catch (NullPointerException e) { ok = true; }
try {
TIFFField.createFromMetadataNode(ts, null);
} catch (IllegalArgumentException e) {
// createFromMetadataNode() formerly threw a NullPointerException
// if its Node parameter was null, but the specification has been
// modified to allow only IllegalArgumentExceptions, perhaps with
// a cause set. In the present invocation the cause would be set
// to a NullPointerException but this is not explicitly specified
// hence not verified here.
ok = true;
}
check(ok, "can create TIFFField from a null node");
TIFFField f = new TIFFField(tag, v);