4912693: Behavior of null arguments not specified in Java Sound
authorserb
Thu, 22 Mar 2018 17:02:40 -0700
changeset 49314 b4ff41220ad9
parent 49310 edbc57573a1c
child 49315 2d4964bc055d
4912693: Behavior of null arguments not specified in Java Sound Reviewed-by: prr
src/java.desktop/share/classes/javax/sound/midi/package-info.java
src/java.desktop/share/classes/javax/sound/midi/spi/package-info.java
src/java.desktop/share/classes/javax/sound/sampled/package-info.java
src/java.desktop/share/classes/javax/sound/sampled/spi/package-info.java
--- a/src/java.desktop/share/classes/javax/sound/midi/package-info.java	Thu Mar 22 14:10:30 2018 -0700
+++ b/src/java.desktop/share/classes/javax/sound/midi/package-info.java	Thu Mar 22 17:02:40 2018 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2018, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -33,6 +33,12 @@
  *   <li><a href="https://docs.oracle.com/javase/tutorial/sound/">
  *   The Java Sound Tutorial</a>
  * </ul>
+ * Please note: In the {@code javax.sound.midi} APIs, a {@code null} reference
+ * parameter to methods is incorrect unless explicitly documented on the method
+ * as having a meaningful interpretation. Usage to the contrary is incorrect
+ * coding and may result in a run time exception either immediately or at some
+ * later time. {@code NullPointerException} is an example of typical and
+ * acceptable run time exception for such cases.
  *
  * @since 1.3
  */
--- a/src/java.desktop/share/classes/javax/sound/midi/spi/package-info.java	Thu Mar 22 14:10:30 2018 -0700
+++ b/src/java.desktop/share/classes/javax/sound/midi/spi/package-info.java	Thu Mar 22 17:02:40 2018 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2018, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -33,6 +33,12 @@
  *   <li><a href="https://docs.oracle.com/javase/tutorial/sound/">
  *   The Java Sound Tutorial</a>
  * </ul>
+ * Please note: In the {@code javax.sound.midi.spi} APIs, a {@code null}
+ * reference parameter to methods is incorrect unless explicitly documented on
+ * the method as having a meaningful interpretation. Usage to the contrary is
+ * incorrect coding and may result in a run time exception either immediately or
+ * at some later time. {@code NullPointerException} is an example of typical and
+ * acceptable run time exception for such cases.
  *
  * @since 1.3
  */
--- a/src/java.desktop/share/classes/javax/sound/sampled/package-info.java	Thu Mar 22 14:10:30 2018 -0700
+++ b/src/java.desktop/share/classes/javax/sound/sampled/package-info.java	Thu Mar 22 17:02:40 2018 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2018, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -33,6 +33,12 @@
  *   <li><a href="https://docs.oracle.com/javase/tutorial/sound/">
  *   The Java Sound Tutorial</a>
  * </ul>
+ * Please note: In the {@code javax.sound.sampled} APIs, a {@code null}
+ * reference parameter to methods is incorrect unless explicitly documented on
+ * the method as having a meaningful interpretation. Usage to the contrary is
+ * incorrect coding and may result in a run time exception either immediately or
+ * at some later time. {@code NullPointerException} is an example of typical and
+ * acceptable run time exception for such cases.
  *
  * @since 1.3
  */
--- a/src/java.desktop/share/classes/javax/sound/sampled/spi/package-info.java	Thu Mar 22 14:10:30 2018 -0700
+++ b/src/java.desktop/share/classes/javax/sound/sampled/spi/package-info.java	Thu Mar 22 17:02:40 2018 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2018, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -33,6 +33,12 @@
  *   <li><a href="https://docs.oracle.com/javase/tutorial/sound/">
  *   The Java Sound Tutorial</a>
  * </ul>
+ * Please note: In the {@code javax.sound.sampled.spi} APIs, a {@code null}
+ * reference parameter to methods is incorrect unless explicitly documented on
+ * the method as having a meaningful interpretation. Usage to the contrary is
+ * incorrect coding and may result in a run time exception either immediately or
+ * at some later time. {@code NullPointerException} is an example of typical and
+ * acceptable run time exception for such cases.
  *
  * @since 1.3
  */