1 /*
2 * Copyright 2010 Stephen Colebourne
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.joda.convert;
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 * Annotation used to mark a method or constructor as being suitable for converting
25 * an object from a {@code String}.
26 * <p>
27 * When applying to a method, this annotation should be applied once per class.
28 * The method must be static and have one {@code String} parameter with a
29 * return type of the type that the method is implemented on.
30 * For example, {@link Integer#parseInt(String)}.
31 * <p>
32 * When applying to a constructor, this annotation should be applied to the constructor
33 * that takes one {@code String} parameter.
34 */
35 @Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
36 @Retention(RetentionPolicy.RUNTIME)
37 public @interface FromString {
38
39 }