com.github.helenusdriver.persistence.InitialObjects Maven / Gradle / Ivy
Show all versions of api Show documentation
/*
* Copyright (C) 2015-2015 The Helenus Driver Project 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
*
* 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.github.helenusdriver.persistence;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* The InitialObjects annotation can be used to identify a factory
* static methods to invoke at the time the table for an associate entity class
* is created in order to pre-populate the table with the pojos returned by the
* method. It can also be used with an object created class which can be used
* alongside with the Helenus tool to insert objects in the database.
*
* The referenced method must be public and static. It must returned an array
* of pojo objects to insert in the database. Finally, it must not take any
* parameters unless the entity is defined with suffixes in which case it must
* expect a single parameter of type Map<String, String> which
* will be used to provide access to each suffix values based on the
* corresponding suffix types.
*
* @copyright 2015-2015 The Helenus Driver Project Authors
*
* @author The Helenus Driver Project Authors
*
* @version 1 - Jan 15, 2015 - paouelle - Creation
*
* @since 1.0
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface InitialObjects {
/**
* Specifies the factory static method to be invoked to get an array of
* pojo objects to insert in the database at the time a table for the
* associate entity is created.
*
* Note: If the POJO class requires suffix keys, the specified method
* must be defined with a Map<String, String> parameter in order
* to receive a map of all available suffixes keyed by their defined type.
*
* @author paouelle
*
* @return the factory static method to be invoked to get an array of pojo objects
*/
String staticMethod();
/**
* Specifies dependent creator classes which must be explored and their provided
* objects inserted into the database first before invoking this creator's
* initial method.
*
* Note: This attribute only make sense when the annotation is used
* as an object creator via the Helenus tool.
*
* @author paouelle
*
* @return the dependent creator classes
*/
Class[] dependsOn() default {};
}