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.Logger;
020import org.apache.logging.log4j.status.StatusLogger;
021
022
023/**
024 * AbstractPatternConverter is an abstract class that provides the formatting functionality that derived classes need.
025 * <p>
026 * Conversion specifiers in a conversion patterns are parsed to individual PatternConverters. Each of which is
027 * responsible for converting an object in a converter specific manner.
028 * </p>
029 */
030public abstract class AbstractPatternConverter implements PatternConverter {
031    /**
032     * Allow subclasses access to the status logger.
033     */
034    protected static final Logger LOGGER = StatusLogger.getLogger();
035
036    /**
037     * Converter name.
038     */
039    private final String name;
040
041    /**
042     * Converter style name.
043     */
044    private final String style;
045
046    /**
047     * Create a new pattern converter.
048     *
049     * @param name  name for pattern converter.
050     * @param style CSS style for formatted output.
051     */
052    protected AbstractPatternConverter(final String name, final String style) {
053        this.name = name;
054        this.style = style;
055    }
056
057    /**
058     * This method returns the name of the conversion pattern.
059     * <p>
060     * The name can be useful to certain Layouts such as HtmlLayout.
061     * </p>
062     *
063     * @return the name of the conversion pattern
064     */
065    @Override
066    public final String getName() {
067        return name;
068    }
069
070    /**
071     * This method returns the CSS style class that should be applied to the LoggingEvent passed as parameter, which can
072     * be null.
073     * <p>
074     * This information is currently used only by HtmlLayout.
075     * </p>
076     *
077     * @param e
078     *        null values are accepted
079     * @return the name of the conversion pattern
080     */
081    @Override
082    public String getStyleClass(final Object e) {
083        return style;
084    }
085}