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