001    /*
002     *  Copyright 2010 Stephen Colebourne
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     */
016    package org.joda.convert;
017    
018    import java.lang.annotation.ElementType;
019    import java.lang.annotation.Retention;
020    import java.lang.annotation.RetentionPolicy;
021    import java.lang.annotation.Target;
022    
023    /**
024     * Annotation used to mark a method as being suitable for converting an
025     * object to a standard format {@code String}.
026     * <p>
027     * This annotation should be applied to one method on a class.
028     * The method must not be static. It must take no parameters and return a {@code String}.
029     * The string format must be able to be parsed by the matching @FromString on
030     * the same class. The format should be human readable and an industry standard
031     * where possible, for example ISO-8601 for dates and times.
032     */
033    @Target(ElementType.METHOD)
034    @Retention(RetentionPolicy.RUNTIME)
035    public @interface ToString {
036    
037    }