View Javadoc
1   /*
2    *  Copyright 2010, 2011 Chris Pheby and Sousan Rassoul
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 from a given representation as indicated by the method signature.
26   * <p>
27   * For any given ConverterScope, this annotation can be defined once for
28   * any related input / output class pair.
29   * <p>
30   * The annotation may be applied to either a static method or a constructor. In
31   * either case, the annotated method must have a single parameter. In the
32   * case of a method, the return type must be of the bound target class. In the
33   * case of a constructor, this must be for the bound target class.
34   */
35  @Target({ ElementType.METHOD, ElementType.CONSTRUCTOR })
36  @Retention(RetentionPolicy.RUNTIME)
37  public @interface From {
38  }