org.seasar.doma.Embeddable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of doma-core Show documentation

DAO Oriented Database Mapping Framework for Java

There is a newer version: 3.3.0

/*
 * Copyright Doma Authors
 *
 * 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
 *
 *     https://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 org.seasar.doma;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Indicates an embeddable class.
 *
 * The embeddable class can be embedded into an entity class.
 *
 * 
The embeddable class must have a non-private constructor that accepts all properties of the
 * class as arguments.
 *
 * 
 * @Embeddable
 * public class Address {
 *
 *     @Column(name = "CITY")
 *     private final String city;
 *
 *     @Column(name = "STREET")
 *     private final String street;
 *
 *     public Address(String city, String street) {
 *         this.city = city;
 *         this.street = street;
 *     }
 *     ...
 * }
 * 
 *
 *  * @Entity
 * public class Employee {
 *
 *     @Id
 *     @Column(name = "ID")
 *     Integer id;
 *
 *     Address address;
 *
 *     @Version
 *     @Column(name = "VERSION")
 *     int version;
 *
 *     ...
 * }
 * 
 *
 * The embeddable instance is not required to be thread safe.
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Embeddable {}