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.Marker;
020    import org.apache.logging.log4j.core.LogEvent;
021    import org.apache.logging.log4j.core.config.plugins.Plugin;
022    
023    /**
024     * Returns the event's rendered message in a StringBuilder.
025     */
026    @Plugin(name = "MarkerPatternConverter", category = PatternConverter.CATEGORY)
027    @ConverterKeys({ "marker" })
028    public final class MarkerPatternConverter extends LogEventPatternConverter {
029    
030        /**
031         * Private constructor.
032         * @param options options, may be null.
033         */
034        private MarkerPatternConverter(final String[] options) {
035            super("Marker", "marker");
036        }
037    
038        /**
039         * Obtains an instance of pattern converter.
040         *
041         * @param options options, may be null.
042         * @return instance of pattern converter.
043         */
044        public static MarkerPatternConverter newInstance(final String[] options) {
045            return new MarkerPatternConverter(options);
046        }
047    
048        /**
049         * {@inheritDoc}
050         */
051        @Override
052        public void format(final LogEvent event, final StringBuilder toAppendTo) {
053            final Marker marker = event.getMarker();
054            if (marker != null) {
055                toAppendTo.append(marker.toString());
056            }
057        }
058    }