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    *      http://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  package org.apache.commons.lang3.text;
18  
19  import java.text.Format;
20  import java.util.Locale;
21  
22  /**
23   * Format factory.
24   * 
25   * @since 2.4
26   * @version $Id: FormatFactory.java 1088899 2011-04-05 05:31:27Z bayard $
27   */
28  public interface FormatFactory {
29  
30      /**
31       * Create or retrieve a format instance.
32       *
33       * @param name The format type name
34       * @param arguments Arguments used to create the format instance. This allows the
35       *                  <code>FormatFactory</code> to implement the "format style"
36       *                  concept from <code>java.text.MessageFormat</code>.
37       * @param locale The locale, may be null
38       * @return The format instance
39       */
40      Format getFormat(String name, String arguments, Locale locale);
41  
42  }