org.cubeengine.dirigent.formatter.PostProcessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dirigent Show documentation

A readable and compact message composing library

There is a newer version: 5.0.2

/*
 * The MIT License
 * Copyright © 2013 Cube Island
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.cubeengine.dirigent.formatter;

import org.cubeengine.dirigent.parser.component.Component;
import org.cubeengine.dirigent.context.Context;
import org.cubeengine.dirigent.context.Arguments;

/**
 * A post processor can be added to a specific {@link Formatter} or the whole {@link org.cubeengine.dirigent.Dirigent}
 * object. The provided method is called after a component was created by the specific formatter or in general. It can
 * be used to manipulate the result and do some magic with it, like adding global style options, for example making
 * macro components bold or colorized.
 */
public interface PostProcessor
{
    /**
     * Processes a component afterwards.
     *
     * @param component The component.
     * @param context   The compose context.
     * @param arguments The arguments of the occurred macro.
     *
     * @return The manipulated component.
     */
    Component process(Component component, Context context, Arguments arguments);
}