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  
18  package org.apache.log4j.pattern;
19  
20  import org.apache.log4j.spi.LoggingEvent;
21  
22  
23  /**
24   * Formats a string literal.
25   *
26   * @author Curt Arnold
27   *
28   */
29  public final class LiteralPatternConverter extends LoggingEventPatternConverter {
30    /**
31     * String literal.
32     */
33    private final String literal;
34  
35    /**
36     * Create a new instance.
37     * @param literal string literal.
38     */
39    public LiteralPatternConverter(final String literal) {
40      super("Literal", "literal");
41      this.literal = literal;
42    }
43  
44    /**
45     * {@inheritDoc}
46     */
47    public void format(final LoggingEvent event, final StringBuffer toAppendTo) {
48      toAppendTo.append(literal);
49    }
50  
51    /**
52     * {@inheritDoc}
53     */
54    public void format(final Object obj, final StringBuffer toAppendTo) {
55      toAppendTo.append(literal);
56    }
57  }