src/main/include/log4cxx/pattern/throwableinformationpatternconverter.h

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _LOG4CXX_PATTERN_THROWABLE_INFORMATION_PATTERN_CONVERTER
#define _LOG4CXX_PATTERN_THROWABLE_INFORMATION_PATTERN_CONVERTER

#include <log4cxx/pattern/loggingeventpatternconverter.h>

namespace log4cxx { namespace pattern {


/**
 * Outputs the ThrowableInformation portion of the LoggingiEvent as a full stacktrace
 * unless this converter's option is 'short', where it just outputs the first line of the trace.
 *
 *
 *
 *
 */
class LOG4CXX_EXPORT ThrowableInformationPatternConverter
  : public LoggingEventPatternConverter {
  /**
   * If "short", only first line of throwable report will be formatted.
   */
  const bool shortReport;

  /**
   * Private constructor.
   */
  ThrowableInformationPatternConverter(bool shortReport);

public:
DECLARE_LOG4CXX_PATTERN(ThrowableInformationPatternConverter)
BEGIN_LOG4CXX_CAST_MAP()
     LOG4CXX_CAST_ENTRY(ThrowableInformationPatternConverter)
     LOG4CXX_CAST_ENTRY_CHAIN(LoggingEventPatternConverter)
END_LOG4CXX_CAST_MAP()


  /**
   * Gets an instance of the class.
    * @param options pattern options, may be null.  If first element is "short",
   * only the first line of the throwable will be formatted.
   * @return instance of class.
   */
  static PatternConverterPtr newInstance(
    const std::vector<LogString>& options);

  using LoggingEventPatternConverter::format;

  void format(const log4cxx::spi::LoggingEventPtr& event,
     LogString& toAppendTo,
     log4cxx::helpers::Pool& p) const;

  /**
   * This converter obviously handles throwables.
   * @return true.
   */
  bool handlesThrowable() const;
};
}
}
#endif