info.archinnov.achilles.annotations.Frozen 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 type is frozen. Examples:
 * 

 * {@literal @}UDT
 * public class Address{
 * {@literal @}Column
 * private String street;

 * {@literal @}Column
 * private int number;

 * {@literal @}Column
 * private int zipCode;

 * ...
 * }

 * {@literal @}Table
 * public class UserEntity {

 * ...

 * {@literal @}Column
 * {@literal @}Frozen
 * private Address address;
 * }

 * 

 * It can be used in nested data types too:

 * 

 * {@literal @}Column
 * private List<{@literal @}Frozen Address> addresses;
 * 

 * Nested collections inside collections should be frozen too;

 * 

 * {@literal @}Column
 * private Map<Integer,{@literal @}Frozen List<String>> nestedCollections;
 * 
 * 
 *
 * @see User Defined Type
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.TYPE_USE})
@Documented
public @interface Frozen {

}