sql/types/SQLUserDefinedType.java

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *    http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 package org.apache.spark.sql.types;
0019
0020 import java.lang.annotation.*;
0021
0022 import org.apache.spark.annotation.DeveloperApi;
0023
0024 /**
0025  * ::DeveloperApi::
0026  * A user-defined type which can be automatically recognized by a SQLContext and registered.
0027  * WARNING: UDTs are currently only supported from Scala.
0028  */
0029 // TODO: Should I used @Documented ?
0030 @DeveloperApi
0031 @Retention(RetentionPolicy.RUNTIME)
0032 @Target(ElementType.TYPE)
0033 public @interface SQLUserDefinedType {
0034
0035   /**
0036    * Returns an instance of the UserDefinedType which can serialize and deserialize the user
0037    * class to and from Catalyst built-in types.
0038    */
0039   Class<? extends UserDefinedType<?>> udt();
0040 }