Source code
Description: source: package: org.apache.commons.lang3.text, interface: FormatFactory

    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 *      https://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.commons.lang3.text;
    019
    020import java.text.Format;
    021import java.util.Locale;
    022
    023/**
    024 * Format factory.
    025 *
    026 * @since 2.4
    027 * @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
    028 *             <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/FormatFactory.html"> FormatFactory</a>.
    029 */
    030@Deprecated
    031public interface FormatFactory {
    032
    033    /**
    034     * Create or retrieve a format instance.
    035     *
    036     * @param name      The format type name.
    037     * @param arguments Arguments used to create the format instance. This allows the {@link FormatFactory} to implement the "format style" concept from
    038     *                  {@link java.text.MessageFormat}.
    039     * @param locale    The locale, may be null.
    040     * @return The format instance.
    041     */
    042    Format getFormat(String name, String arguments, Locale locale);
    043}