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 *      http://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 */
017package org.apache.logging.log4j.core.pattern;
018
019import org.apache.logging.log4j.core.config.plugins.Plugin;
020
021/**
022 * Formats a date by delegating to {@link DatePatternConverter}.  The default
023 * date pattern for a %d specifier in a file name is different than
024 * the %d pattern in pattern layout.
025 */
026@Plugin(name = "FileDatePatternConverter", category = "FileConverter")
027@ConverterKeys({ "d", "date" })
028public final class FileDatePatternConverter {
029    /**
030     * Private constructor.
031     */
032    private FileDatePatternConverter() {
033    }
034
035    /**
036     * Obtains an instance of pattern converter.
037     *
038     * @param options options, may be null.
039     * @return instance of pattern converter.
040     */
041    public static PatternConverter newInstance(final String[] options) {
042        if (options == null || options.length == 0) {
043            return DatePatternConverter.newInstance(
044                new String[]{
045                    "yyyy-MM-dd"
046                });
047        }
048
049        return DatePatternConverter.newInstance(options);
050    }
051}