1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.logging.log4j.core.config.plugins.convert;
19
20 /**
21 * Interface for doing automatic String conversion to a specific type.
22 *
23 * @param <T> Converts Strings into the given type {@code T}.
24 * @since 2.1 Moved to the {@code convert} package.
25 */
26 public interface TypeConverter<T> {
27
28 /**
29 * Converts a String to a given type.
30 *
31 * @param s the String to convert. Cannot be {@code null}.
32 * @return the converted object.
33 * @throws Exception thrown when a conversion error occurs
34 */
35 T convert(String s) throws Exception;
36 }