View Javadoc
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    *      https://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.commons.lang3.text;
19  
20  import java.text.Format;
21  import java.util.Locale;
22  
23  /**
24   * Format factory.
25   *
26   * @since 2.4
27   * @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
28   *             <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/FormatFactory.html"> FormatFactory</a>.
29   */
30  @Deprecated
31  public interface FormatFactory {
32  
33      /**
34       * Create or retrieve a format instance.
35       *
36       * @param name      The format type name.
37       * @param arguments Arguments used to create the format instance. This allows the {@link FormatFactory} to implement the "format style" concept from
38       *                  {@link java.text.MessageFormat}.
39       * @param locale    The locale, may be null.
40       * @return The format instance.
41       */
42      Format getFormat(String name, String arguments, Locale locale);
43  }