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 as being suitable for converting an
25 * object to a standard format {@code String}.
26 * <p>
27 * This annotation should be applied to one method on a class.
28 * The method must not be static. It must take no parameters and return a {@code String}.
29 * The string format must be able to be parsed by the matching @FromString on
30 * the same class. The format should be human readable and an industry standard
31 * where possible, for example ISO-8601 for dates and times.
32 */
33 @Target(ElementType.METHOD)
34 @Retention(RetentionPolicy.RUNTIME)
35 public @interface ToString {
36
37 }