001/*
002 *  Copyright 2010, 2011 Chris Pheby and Sousan Rassoul
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.jadira.bindings.core.annotation;
017
018import java.lang.annotation.ElementType;
019import java.lang.annotation.Retention;
020import java.lang.annotation.RetentionPolicy;
021import java.lang.annotation.Target;
022
023/**
024 * This annotation, when applied to a method indicates that it is suitable for
025 * converting an object from a given representation as indicated by the method signature.
026 * <p>
027 * For any given ConverterScope, this annotation can be defined once for
028 * any related input / output class pair.
029 * <p>
030 * The annotation may be applied to either a static method or a constructor. In
031 * either case, the annotated method must have a single parameter. In the
032 * case of a method, the return type must be of the bound target class. In the
033 * case of a constructor, this must be for the bound target class.
034 */
035@Target({ ElementType.METHOD, ElementType.CONSTRUCTOR })
036@Retention(RetentionPolicy.RUNTIME)
037public @interface From {
038}