com.cognifide.slice.mapper.annotation.Follow Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * Slice - Mapper API
 * %%
 * Copyright (C) 2012 Wunderman Thompson Technology
 * %%
 * 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.
 * #L%
 */

package com.cognifide.slice.mapper.annotation;

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

/**
 * Allows mapper to map a resource by following a path stored under given jcr property. The path to a parent
 * resource is the one indicated by the name of the field or {@link JcrProperty}. It is possible to use this
 * annotation in conjunction with @Children as well.
 *
 *  * {@literal @}SliceResource
 * public class ExampleModel {
 *
 *   {@literal @}Follow
 *   {@literal @}JcrProperty("secondModelPath")
 *   private SecondModel secondModel;
 *
 * }
 * 
 *
 * @author Jaromir Celejewski
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Follow {
}