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.logging.log4j.core.pattern;
18  
19  import org.apache.logging.log4j.core.config.plugins.Plugin;
20  import org.apache.logging.log4j.util.PerformanceSensitive;
21  
22  /**
23   * Formats a date by delegating to {@link DatePatternConverter}.  The default
24   * date pattern for a %d specifier in a file name is different than
25   * the %d pattern in pattern layout.
26   */
27  @Plugin(name = "FileDatePatternConverter", category = "FileConverter")
28  @ConverterKeys({ "d", "date" })
29  @PerformanceSensitive("allocation")
30  public final class FileDatePatternConverter {
31      /**
32       * Private constructor.
33       */
34      private FileDatePatternConverter() {
35      }
36  
37      /**
38       * Obtains an instance of pattern converter.
39       *
40       * @param options options, may be null.
41       * @return instance of pattern converter.
42       */
43      public static PatternConverter newInstance(final String[] options) {
44          if (options == null || options.length == 0) {
45              return DatePatternConverter.newInstance(
46                  new String[]{
47                      "yyyy-MM-dd"
48                  });
49          }
50  
51          return DatePatternConverter.newInstance(options);
52      }
53  }