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  
22  
23  /**
24   * Formats a string literal.
25   */
26  public final class LiteralPatternConverter extends LogEventPatternConverter implements ArrayPatternConverter {
27      /**
28       * String literal.
29       */
30      private final String literal;
31  
32      private final Configuration config;
33  
34      private final boolean substitute;
35  
36      /**
37       * Create a new instance.
38       *
39       * @param config The Configuration.
40       * @param literal string literal.
41       */
42      public LiteralPatternConverter(final Configuration config, final String literal) {
43          super("Literal", "literal");
44          this.literal = literal;
45          this.config = config;
46          substitute = config != null && literal.contains("${");
47      }
48  
49      /**
50       * {@inheritDoc}
51       */
52      @Override
53      public void format(final LogEvent event, final StringBuilder toAppendTo) {
54          toAppendTo.append(substitute ? config.getStrSubstitutor().replace(event, literal) : literal);
55      }
56      
57      /**
58       * {@inheritDoc}
59       */
60      @Override
61      public void format(final Object obj, final StringBuilder output) {
62          output.append(substitute ? config.getStrSubstitutor().replace(literal) : literal);
63      }
64  
65      /**
66       * {@inheritDoc}
67       */
68      @Override
69      public void format(final StringBuilder output, final Object... objects) {
70          output.append(substitute ? config.getStrSubstitutor().replace(literal) : literal);
71      }
72  
73      public String getLiteral() {
74          return literal;
75      }
76  }