org.apache.logging.log4j.message.FlowMessageFactory Maven / Gradle / Ivy
/*
* 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.
*/
package org.apache.logging.log4j.message;
/**
* Creates flow messages. Implementations can provide different message format syntaxes.
* @since 2.6
*/
public interface FlowMessageFactory {
/**
* Creates a new entry message based on a format string with parameters.
*
* @param message format string
* @param params parameters
* @return the new entry message
* @since 2.20
*/
EntryMessage newEntryMessage(String message, Object... params);
/**
* Creates a new entry message based on an existing message.
*
* @param message the original message
* @return the new entry message
*/
EntryMessage newEntryMessage(Message message);
/**
* Creates a new exit message based on a return value and a forma string.
*
* @param format a format string
* @param result the return value
* @return the new exit message
* @since 2.20
*/
ExitMessage newExitMessage(String format, Object result);
/**
* Creates a new exit message based on no return value and an existing message.
*
* @param message the original entry message
* @return the new exit message
* @since 2.20
*/
ExitMessage newExitMessage(Message message);
/**
* Creates a new exit message based on a return value and an existing message.
*
* @param result the return value.
* @param message the original message
* @return the new exit message
*/
ExitMessage newExitMessage(Object result, Message message);
/**
* Creates a new exit message based on no return value and an existing entry message.
*
* @param message the original entry message
* @return the new exit message
*/
ExitMessage newExitMessage(EntryMessage message);
/**
* Creates a new exit message based on a return value and an existing entry message.
*
* @param result the return value.
* @param message the original entry message
* @return the new exit message
*/
ExitMessage newExitMessage(Object result, EntryMessage message);
}