org.jboss.logging.ParameterConverter Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
*
* Copyright 2010 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* Licensed 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.jboss.logging;
import java.util.Locale;
/**
* A converter for a specific parameter type.
*
* @author David M. Lloyd
* @param the input type
* @deprecated this is not currently used anywhere and no replacement will be created
*/
@Deprecated
public interface ParameterConverter {
/**
* Convert the parameter to its string or string-equivalent representation. The returned value will be passed in
* as a parameter to either a {@link java.text.MessageFormat} or {@link java.util.Formatter} instance, depending
* on the setting of {@code org.jboss.logging.annotation.Message.format}.
*
* @param locale the locale
* @param parameter the parameter
* @return the converted value
*/
Object convert(Locale locale, I parameter);
}