Repository: spark
Updated Branches:
  refs/heads/master 89addd40a -> 12c360c05


[SPARK-14965][SQL] Indicate an exception is thrown for a missing struct field

## What changes were proposed in this pull request?

Fix to ScalaDoc for StructType.

## How was this patch tested?

Built locally.

Author: Gregory Hart <greg.h...@thinkbiganalytics.com>

Closes #12758 from freastro/hotfix/SPARK-14965.


Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/12c360c0
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/12c360c0
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/12c360c0

Branch: refs/heads/master
Commit: 12c360c057f09d13a31c458ad277640b5f6de394
Parents: 89addd4
Author: Gregory Hart <greg.h...@thinkbiganalytics.com>
Authored: Thu Apr 28 11:21:43 2016 -0700
Committer: Reynold Xin <r...@databricks.com>
Committed: Thu Apr 28 11:21:43 2016 -0700

----------------------------------------------------------------------
 .../scala/org/apache/spark/sql/types/StructType.scala  | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/spark/blob/12c360c0/sql/catalyst/src/main/scala/org/apache/spark/sql/types/StructType.scala
----------------------------------------------------------------------
diff --git 
a/sql/catalyst/src/main/scala/org/apache/spark/sql/types/StructType.scala 
b/sql/catalyst/src/main/scala/org/apache/spark/sql/types/StructType.scala
index 1238eef..6f50be7 100644
--- a/sql/catalyst/src/main/scala/org/apache/spark/sql/types/StructType.scala
+++ b/sql/catalyst/src/main/scala/org/apache/spark/sql/types/StructType.scala
@@ -206,8 +206,9 @@ case class StructType(fields: Array[StructField]) extends 
DataType with Seq[Stru
   }
 
   /**
-   * Extracts a [[StructField]] of the given name. If the [[StructType]] 
object does not
-   * have a name matching the given name, `null` will be returned.
+   * Extracts the [[StructField]] with the given name.
+   *
+   * @throws IllegalArgumentException if a field with the given name does not 
exist
    */
   def apply(name: String): StructField = {
     nameToField.getOrElse(name,
@@ -216,7 +217,9 @@ case class StructType(fields: Array[StructField]) extends 
DataType with Seq[Stru
 
   /**
    * Returns a [[StructType]] containing [[StructField]]s of the given names, 
preserving the
-   * original order of fields. Those names which do not have matching fields 
will be ignored.
+   * original order of fields.
+   *
+   * @throws IllegalArgumentException if a field cannot be found for any of 
the given names
    */
   def apply(names: Set[String]): StructType = {
     val nonExistFields = names -- fieldNamesSet
@@ -229,7 +232,9 @@ case class StructType(fields: Array[StructField]) extends 
DataType with Seq[Stru
   }
 
   /**
-   * Returns index of a given field
+   * Returns the index of a given field.
+   *
+   * @throws IllegalArgumentException if a field with the given name does not 
exist
    */
   def fieldIndex(name: String): Int = {
     nameToIndex.getOrElse(name,


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org

Reply via email to