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.Marker;
20  import org.apache.logging.log4j.core.LogEvent;
21  import org.apache.logging.log4j.core.config.plugins.Plugin;
22  
23  /**
24   * Returns the event's rendered message in a StringBuilder.
25   */
26  @Plugin(name = "MarkerPatternConverter", category = "Converter")
27  @ConverterKeys({"marker" })
28  public final class MarkerPatternConverter extends LogEventPatternConverter {
29  
30      /**
31       * Private constructor.
32       * @param options options, may be null.
33       */
34      private MarkerPatternConverter(final String[] options) {
35          super("Marker", "marker");
36      }
37  
38      /**
39       * Obtains an instance of pattern converter.
40       *
41       * @param options options, may be null.
42       * @return instance of pattern converter.
43       */
44      public static MarkerPatternConverter newInstance(final String[] options) {
45          return new MarkerPatternConverter(options);
46      }
47  
48      /**
49       * {@inheritDoc}
50       */
51      @Override
52      public void format(final LogEvent event, final StringBuilder toAppendTo) {
53          final Marker marker = event.getMarker();
54          if (marker != null) {
55              toAppendTo.append(marker.toString());
56          }
57      }
58  }