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       */
43      public LiteralPatternConverter(final Configuration config, final String literal) {
44          super("Literal", "literal");
45          this.literal = OptionConverter.convertSpecialChars(literal);
46          this.config = config;
47          substitute = config != null && literal.contains("${");
48      }
49  
50      /**
51       * {@inheritDoc}
52       */
53      @Override
54      public void format(final LogEvent event, final StringBuilder toAppendTo) {
55          toAppendTo.append(substitute ? config.getStrSubstitutor().replace(event, literal) : literal);
56      }
57      
58      /**
59       * {@inheritDoc}
60       */
61      @Override
62      public void format(final Object obj, final StringBuilder output) {
63          output.append(substitute ? config.getStrSubstitutor().replace(literal) : literal);
64      }
65  
66      /**
67       * {@inheritDoc}
68       */
69      @Override
70      public void format(final StringBuilder output, final Object... objects) {
71          output.append(substitute ? config.getStrSubstitutor().replace(literal) : literal);
72      }
73  
74      public String getLiteral() {
75          return literal;
76      }
77  }