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