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 * Return the event's rendered message in a StringBuffer.
025 *
026 * @author Ceki Gülcü
027 */
028public final class MessagePatternConverter extends LoggingEventPatternConverter {
029  /**
030   * Singleton.
031   */
032  private static final MessagePatternConverter INSTANCE =
033    new MessagePatternConverter();
034
035  /**
036   * Private constructor.
037   */
038  private MessagePatternConverter() {
039    super("Message", "message");
040  }
041
042  /**
043   * Obtains an instance of pattern converter.
044   * @param options options, may be null.
045   * @return instance of pattern converter.
046   */
047  public static MessagePatternConverter newInstance(
048    final String[] options) {
049    return INSTANCE;
050  }
051
052  /**
053   * {@inheritDoc}
054   */
055  public void format(final LoggingEvent event, final StringBuffer toAppendTo) {
056    toAppendTo.append(event.getRenderedMessage());
057  }
058}