001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.logging.log4j.core.config.plugins.convert;
019
020/**
021 * Interface for doing automatic String conversion to a specific type.
022 *
023 * @param <T> Converts Strings into the given type {@code T}.
024 * @since 2.1 Moved to the {@code convert} package.
025 */
026public interface TypeConverter<T> {
027
028    /**
029     * Converts a String to a given type.
030     *
031     * @param s the String to convert. Cannot be {@code null}.
032     * @return the converted object.
033     * @throws Exception thrown when a conversion error occurs
034     */
035    T convert(String s) throws Exception;
036}