AppenderComponentBuilder.java

/*
 * 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.core.config.builder.api;

/**
 * Builder for constructing Appender Components.
 * @since 2.4
 */
public interface AppenderComponentBuilder extends FilterableComponentBuilder<AppenderComponentBuilder> {

    /**
     * Adds a Layout to the Appender component.
     * @param builder The LayoutComponentBuilder with all of its attributes set.
     * @return this builder.
     */
    AppenderComponentBuilder add(LayoutComponentBuilder builder);

    /**
     * Returns the name of the Appender.
     * @return the name of the Appender.
     */
    @Override
    String getName();
}