/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache license, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the license for the specific language governing permissions and
 * limitations under the license.
 */

package org.apache.logging.log4j.core.config.plugins.convert;

Interface for doing automatic String conversion to a specific type.
Type parameters:
  • <T> – Converts Strings into the given type T.
Since:2.1 Moved to the convert package.
/** * Interface for doing automatic String conversion to a specific type. * * @param <T> Converts Strings into the given type {@code T}. * @since 2.1 Moved to the {@code convert} package. */
public interface TypeConverter<T> {
Converts a String to a given type.
Params:
  • s – the String to convert. Cannot be null.
Throws:
  • Exception – thrown when a conversion error occurs
Returns:the converted object.
/** * Converts a String to a given type. * * @param s the String to convert. Cannot be {@code null}. * @return the converted object. * @throws Exception thrown when a conversion error occurs */
T convert(String s) throws Exception; }