Use throws annotation

HyukjinKwon · HyukjinKwon · commit 73fcd355a565 · 2016-11-26T12:44:12.000+09:00
diff --git a/core/src/main/scala/org/apache/spark/SparkConf.scala b/core/src/main/scala/org/apache/spark/SparkConf.scala
@@ -262,8 +262,9 @@ class SparkConf(loadDefaults: Boolean) extends Cloneable with Logging with Seria
   /**
    * Get a time parameter as seconds; throws a NoSuchElementException if it's not set. If no
    * suffix is provided then seconds are assumed.
-   * @note Throws `NoSuchElementException`
+   * @throws java.util.NoSuchElementException
    */
+  @throws(classOf[NoSuchElementException])
   def getTimeAsSeconds(key: String): Long = {
     Utils.timeStringAsSeconds(get(key))
   }
@@ -279,8 +280,9 @@ class SparkConf(loadDefaults: Boolean) extends Cloneable with Logging with Seria
   /**
    * Get a time parameter as milliseconds; throws a NoSuchElementException if it's not set. If no
    * suffix is provided then milliseconds are assumed.
-   * @note Throws `NoSuchElementException`
+   * @throws java.util.NoSuchElementException
    */
+  @throws(classOf[NoSuchElementException])
   def getTimeAsMs(key: String): Long = {
     Utils.timeStringAsMs(get(key))
   }
@@ -296,8 +298,9 @@ class SparkConf(loadDefaults: Boolean) extends Cloneable with Logging with Seria
   /**
    * Get a size parameter as bytes; throws a NoSuchElementException if it's not set. If no
    * suffix is provided then bytes are assumed.
-   * @note Throws `NoSuchElementException`
+   * @throws java.util.NoSuchElementException
    */
+  @throws(classOf[NoSuchElementException])
   def getSizeAsBytes(key: String): Long = {
     Utils.byteStringAsBytes(get(key))
   }
@@ -320,8 +323,9 @@ class SparkConf(loadDefaults: Boolean) extends Cloneable with Logging with Seria
   /**
    * Get a size parameter as Kibibytes; throws a NoSuchElementException if it's not set. If no
    * suffix is provided then Kibibytes are assumed.
-   * @note Throws `NoSuchElementException`
+   * @throws java.util.NoSuchElementException
    */
+  @throws(classOf[NoSuchElementException])
   def getSizeAsKb(key: String): Long = {
     Utils.byteStringAsKb(get(key))
   }
@@ -337,8 +341,9 @@ class SparkConf(loadDefaults: Boolean) extends Cloneable with Logging with Seria
   /**
    * Get a size parameter as Mebibytes; throws a NoSuchElementException if it's not set. If no
    * suffix is provided then Mebibytes are assumed.
-   * @note Throws `NoSuchElementException`
+   * @throws java.util.NoSuchElementException
    */
+  @throws(classOf[NoSuchElementException])
   def getSizeAsMb(key: String): Long = {
     Utils.byteStringAsMb(get(key))
   }
@@ -354,8 +359,9 @@ class SparkConf(loadDefaults: Boolean) extends Cloneable with Logging with Seria
   /**
    * Get a size parameter as Gibibytes; throws a NoSuchElementException if it's not set. If no
    * suffix is provided then Gibibytes are assumed.
-   * @note Throws `NoSuchElementException`
+   * @throws java.util.NoSuchElementException
    */
+  @throws(classOf[NoSuchElementException])
   def getSizeAsGb(key: String): Long = {
     Utils.byteStringAsGb(get(key))
   }
diff --git a/core/src/main/scala/org/apache/spark/SparkContext.scala b/core/src/main/scala/org/apache/spark/SparkContext.scala
@@ -2061,8 +2061,9 @@ class SparkContext(config: SparkConf) extends Logging {
    * Cancel a given job if it's scheduled or running.
    *
    * @param jobId the job ID to cancel
-   * @note Throws `InterruptedException` if the cancel message cannot be sent
+   * @throws InterruptedException if the cancel message cannot be sent
    */
+  @throws(classOf[InterruptedException])
   def cancelJob(jobId: Int) {
     dagScheduler.cancelJob(jobId)
   }
@@ -2071,8 +2072,9 @@ class SparkContext(config: SparkConf) extends Logging {
    * Cancel a given stage and all jobs associated with it.
    *
    * @param stageId the stage ID to cancel
-   * @note Throws `InterruptedException` if the cancel message cannot be sent
+   * @throws InterruptedException if the cancel message cannot be sent
    */
+  @throws(classOf[InterruptedException])
   def cancelStage(stageId: Int) {
     dagScheduler.cancelStage(stageId)
   }
diff --git a/core/src/main/scala/org/apache/spark/util/Utils.scala b/core/src/main/scala/org/apache/spark/util/Utils.scala
@@ -2354,8 +2354,9 @@ private[spark] object Utils extends Logging {
    * A spark url (`spark://host:port`) is a special URI that its scheme is `spark` and only contains
    * host and port.
    *
-   * @note Throws `SparkException` if sparkUrl is invalid.
+   * @throws org.apache.spark.SparkException if sparkUrl is invalid.
    */
+  @throws(classOf[SparkException])
   def extractHostPortFromSparkUrl(sparkUrl: String): (String, Int) = {
     try {
       val uri = new java.net.URI(sparkUrl)

Original file line number	Diff line number	Diff line change
`@@ -2061,8 +2061,9 @@ class SparkContext(config: SparkConf) extends Logging {`
`2061`	`2061`	`* Cancel a given job if it's scheduled or running.`
`2062`	`2062`	`*`
`2063`	`2063`	`* @param jobId the job ID to cancel`
`2064`		- * @note Throws `InterruptedException` if the cancel message cannot be sent
	`2064`	`+ * @throws InterruptedException if the cancel message cannot be sent`
`2065`	`2065`	`*/`
	`2066`	`+ @throws(classOf[InterruptedException])`
`2066`	`2067`	`def cancelJob(jobId: Int) {`
`2067`	`2068`	`dagScheduler.cancelJob(jobId)`
`2068`	`2069`	`}`
`@@ -2071,8 +2072,9 @@ class SparkContext(config: SparkConf) extends Logging {`
`2071`	`2072`	`* Cancel a given stage and all jobs associated with it.`
`2072`	`2073`	`*`
`2073`	`2074`	`* @param stageId the stage ID to cancel`
`2074`		- * @note Throws `InterruptedException` if the cancel message cannot be sent
	`2075`	`+ * @throws InterruptedException if the cancel message cannot be sent`
`2075`	`2076`	`*/`
	`2077`	`+ @throws(classOf[InterruptedException])`
`2076`	`2078`	`def cancelStage(stageId: Int) {`
`2077`	`2079`	`dagScheduler.cancelStage(stageId)`
`2078`	`2080`	`}`