org.mapstruct.Qualifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mapstruct-jdk8 Show documentation

MapStruct annotations to be used with JDK 8 and later

There is a newer version: 1.6.3

/**
 *  Copyright 2012-2017 Gunnar Morling (http://www.gunnarmorling.de/)
 *  and/or other contributors as indicated by the @authors tag. See the
 *  copyright.txt file in the distribution for a full listing of all
 *  contributors.
 *
 *  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 org.mapstruct;

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

/**
 * Declares an annotation type to be a qualifier. Qualifier annotations allow unambiguously identify a suitable mapping
 * method in case several methods qualify to map a bean property, iterable element etc.
 * 
 * For more info see:
 * 

 * {@link Mapping#qualifiedBy() }
 * {@link BeanMapping#qualifiedBy() }
 * {@link IterableMapping#qualifiedBy() }
 * {@link MapMapping#keyQualifiedBy() }
 * {@link MapMapping#valueQualifiedBy() }
 * 
 * Example:
 *
 *  * @Qualifier
 * @Target(ElementType.METHOD)
 * @Retention(RetentionPolicy.CLASS)
 * public @interface EnglishToGerman {
 * }
 * 
 *
 * NOTE: Qualifiers should have {@link RetentionPolicy#CLASS}.
 *
 * @author Sjaak Derksen
 * @see Named
 */
@Target(ElementType.ANNOTATION_TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface Qualifier {
}