scaladoc

jeanlyn · Mar 16, 2015 · 3377e61 · 3377e61
1 parent d05f7a9
commit 3377e61
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/core/src/main/scala/org/apache/spark/status/api/v1/JsonRootResource.scala b/core/src/main/scala/org/apache/spark/status/api/v1/JsonRootResource.scala
@@ -94,6 +94,11 @@ object JsonRootResource {
 private[spark] trait UIRoot {
   def getSparkUI(appKey: String): Option[SparkUI]
   def getApplicationInfoList: Seq[ApplicationInfo]
+
+  /**
+   * Get the spark UI with the given appID, and apply a function
+   * to it.  If there is no such app, throw an appropriate exception
+   */
   def withSparkUI[T](appId: String)(f: SparkUI => T): T = {
     getSparkUI(appId) match {
       case Some(ui) => f(ui)