com.cognifide.slice.mapper.annotation.SliceResource 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.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Objects marked with this annotation can be adapted from Resource.
 * Marks class as a Slice resource which means that fields of this class will be mapped by
 * {@link com.cognifide.slice.mapper.api.Mapper} using dedicated {@link MappingStrategy}. By default
 * {@link MappingStrategy#ANNOTATED} strategy is used.
 * 
 * @author maciej.majchrzak
 * 
 */
@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface SliceResource {

	/**
	 * Defines what mapping strategy of fields mapping should be used. By default
	 * {@link MappingStrategy#ANNOTATED} is used.
	 * 
	 * @return value
	 * @see MappingStrategy
	 */
	MappingStrategy value() default MappingStrategy.ANNOTATED;
}