1 /*
2 * Copyright 2011 Chris Pheby
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.jadira.bindings.core.annotation;
17
18 import java.lang.annotation.ElementType;
19 import java.lang.annotation.Retention;
20 import java.lang.annotation.RetentionPolicy;
21 import java.lang.annotation.Target;
22
23 /**
24 * This annotation, when applied to a method indicates that it is suitable for
25 * converting an object to or from a given representation as indicated by the
26 * method signature.
27 * <p>
28 * For any given ConverterScope, this annotation can be defined once for
29 * any related input / output class pair.
30 * <p>
31 * The annotation may be applied to either a static method, a constructor, or an
32 * instance method. In the case of the static method or the constructor, the
33 * annotated method must have a single parameter (the input class). In the case
34 * of a method, the return type must be of the output class. In the case of a
35 * constructor, this must be for the bound output class. The instance method
36 * takes no parameters, must be applied to the source (input) type and returns
37 * the output type.
38 * For disambiguation, @From and @To may be used instead
39 */
40 @Target({ ElementType.METHOD, ElementType.CONSTRUCTOR })
41 @Retention(RetentionPolicy.RUNTIME)
42 public @interface Convert {
43 }