info.archinnov.achilles.annotations.UDT Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of achilles-model Show documentation

There is a newer version: 6.1.0

/*
 * Copyright (C) 2012-2016 DuyHai DOAN
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package info.archinnov.achilles.annotations;

import java.lang.annotation.*;

/**
 * Annotation to indicate that a field is an UDT (User Defined Type). Examples:
 * 

 * //Inferred UDT name = "address"
 * {@literal @}UDT(keyspace = "test")
 * public class Address {...}
 * 
 * 




 * 
 * //UDT name = "long_address"
 * {@literal @}UDT(keyspace = "test", name = "long_address")
 * public class Address {...};
 * 
 * 



 * 

 * // Inferred UDT name = "my_address"
 * {@literal @}UDT(keyspace = "test")
 * {@literal @}Strategy(naming = NamingStrategy.SNAKE_CASE)
 * public class MyAddress {...};
 * 
 *
 * @see User Defined Type
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
public @interface UDT {

    /**
     * Provide the keyspace in which is defined the UDT
     */
    String keyspace() default "";

    /**
     * Force the UDT name
     */
    String name() default "";


}