DataModel.java

/**
 * Copyright 2011-2017 Asakusa Framework Team.
 *
 * 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 com.asakusafw.vocabulary.model;

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

/**
 * An annotation for Asakusa data model classes.
 * @deprecated Use data model interface declared in asakusa-runtime.
 */
@Deprecated
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataModel {

    /**
     * An interface that provides skeletal information of data model classes.
     * <p>
     * Each data model class may or may not implement this interface,
     * but that class must provide methods in the interface.
     * </p>
     * @param <T> the data model type
     */
    interface Interface<T> {

        /**
         * The method name of {@link #copyFrom(Object)}.
         */
        String METHOD_NAME_COPY_FROM = "copyFrom"; //$NON-NLS-1$

        /**
         * Copies each property value of the specified object into this data model.
         * @param source the source data model object
         */
        void copyFrom(T source);
    }
}