com.cognifide.slice.mapper.annotation.ImagePath 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;

/**
 * Indicates that a SliceResource's field represents an image resource. Images are not basic JCR types, so
 * logic for accessing them is different. Should be used for fields of type String; using it for
 * fields of com.day.cq.wcm.foundation.Image is not necessary - they are mapped by default. For
 * strings - image's source will be mapped, for com.day.cq.wcm.foundation.Image's - whole image object.
 *
 *  * {@literal @}SliceResource
 * public class ExampleModel {
 *
 *   {@literal @}ImagePath
 *   private String imagePath;
 *
 * }
 * 
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface ImagePath {
}