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.core.LogEvent;
    20  import org.apache.logging.log4j.core.config.Configuration;
    21  import org.apache.logging.log4j.core.util.OptionConverter;
    22
    23
    24  /**
    25   * Formats a string literal.
    26   */
    27  public final class LiteralPatternConverter extends LogEventPatternConverter implements ArrayPatternConverter {
    28      /**
    29       * String literal.
    30       */
    31      private final String literal;
    32
    33      private final Configuration config;
    34
    35      private final boolean substitute;
    36
    37      /**
    38       * Create a new instance.
    39       *
    40       * @param config The Configuration.
    41       * @param literal string literal.
    42       * @param convertBackslashes if {@code true}, backslash characters are treated as escape characters and character
    43       *            sequences like "\" followed by "t" (backslash+t) are converted to special characters like '\t' (tab).
    44       */
    45      public LiteralPatternConverter(final Configuration config, final String literal, final boolean convertBackslashes) {
    46          super("Literal", "literal");
    47          this.literal = convertBackslashes ? OptionConverter.convertSpecialChars(literal) : literal; // LOG4J2-829
    48          this.config = config;
    49          substitute = config != null && literal.contains("${");
    50      }
    51
    52      /**
    53       * {@inheritDoc}
    54       */
    55      @Override
    56      public void format(final LogEvent event, final StringBuilder toAppendTo) {
    57          toAppendTo.append(substitute ? config.getStrSubstitutor().replace(event, literal) : literal);
    58      }
    59
    60      /**
    61       * {@inheritDoc}
    62       */
    63      @Override
    64      public void format(final Object obj, final StringBuilder output) {
    65          output.append(substitute ? config.getStrSubstitutor().replace(literal) : literal);
    66      }
    67
    68      /**
    69       * {@inheritDoc}
    70       */
    71      @Override
    72      public void format(final StringBuilder output, final Object... objects) {
    73          output.append(substitute ? config.getStrSubstitutor().replace(literal) : literal);
    74      }
    75
    76      public String getLiteral() {
    77          return literal;
    78      }
    79  }