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 /**
19 * Interface defining conversion from a {@code String}.
20 * <p>
21 * FromStringConverter is an interface and must be implemented with care.
22 * Implementations must be immutable and thread-safe.
23 *
24 * @param <T> the type of the converter
25 */
26 public interface FromStringConverter<T> {
27
28 /**
29 * Converts the specified object from a {@code String}.
30 * @param cls the class to convert to, not null
31 * @param str the string to convert, not null
32 * @return the converted object, may be null but generally not
33 */
34 T convertFromString(Class<? extends T> cls, String str);
35
36 }