001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.log4j.pattern;
019
020import org.apache.log4j.spi.LoggingEvent;
021
022
023/**
024 * Formats a string literal.
025 *
026 * @author Curt Arnold
027 *
028 */
029public final class LiteralPatternConverter extends LoggingEventPatternConverter {
030  /**
031   * String literal.
032   */
033  private final String literal;
034
035  /**
036   * Create a new instance.
037   * @param literal string literal.
038   */
039  public LiteralPatternConverter(final String literal) {
040    super("Literal", "literal");
041    this.literal = literal;
042  }
043
044  /**
045   * {@inheritDoc}
046   */
047  public void format(final LoggingEvent event, final StringBuffer toAppendTo) {
048    toAppendTo.append(literal);
049  }
050
051  /**
052   * {@inheritDoc}
053   */
054  public void format(final Object obj, final StringBuffer toAppendTo) {
055    toAppendTo.append(literal);
056  }
057}