io.neba.api.annotations.PreMapping Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of io.neba.neba-api Show documentation

Contains all annotations, tag libraries and lifecycle callback interfaces of NEBA. All packages of this API bundle are exported. Change to the API that are not byte code compatible only occur in major revisions.

There is a newer version: 5.2.3

Show newest version

/**
 * Copyright 2013 the original author or 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 io.neba.api.annotations;

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

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Methods of a {@link ResourceModel} with this annotation are invoked before
 * any properties have been mapped from the model's resource.
 * If multiple methods are annotated, all of them are executed in the order of declaration.
 *
 * Example:
 *  *     @{@link ResourceModel}
 *     public class MyModel {
 *          @{@link This}
 *          private Resource resouce;
 *
 *          @{@link PreMapping}
 *          public void provideSomeDefaultValue() {
 *              this.resource = ...;
 *          }
 *          @{@link PreMapping}
 *          private void anotherMethodThatNeedsExecutionBeforeMapping() throws Exception {
 *              ...
 *          }
 *     }
 * 
 *
 * @author Olaf Otto
 */
@Documented
@Retention(RUNTIME)
@Target({METHOD, ANNOTATION_TYPE})
public @interface PreMapping {
}