org.cubeengine.dirigent.formatter.Formatter 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 (c) 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 java.util.ArrayList;
import java.util.List;
import java.util.Set;
import org.cubeengine.dirigent.Component;

/**
 * A Formatter for T.
 * PostProcessors can be added to run after formatting
  *
 * @param  the ObjectType to format
 */
public abstract class Formatter
{
    private List postProcessors = new ArrayList();

    /**
     * Returns true if given argument can be formatted with this Formatter
     * @param arg the argument
     * @return whether the argument can be formatted
     */
    public abstract boolean isApplicable(Object arg);

    /**
     * Formats the argument into a Component for given Context
     * @param arg the argument
     * @param context the Context
     * @return the resulting Component
     */
    protected abstract Component format(T arg, Context context);

    /**
     * Formats the argument into a Component for given Context. Then runs all PostProcessors.
     * @param arg the argument
     * @param context the Context
     * @return the resulting processed Component
     */
    public final Component process(T arg, Context context)
    {
        Component result = format(arg, context);
        for (PostProcessor processor : postProcessors)
        {
            result = processor.process(result, context);
        }
        return result;
    }

    /**
     * Adds a PostProcessor to this Formatter
     * @param pp the PostProcessor to add
     */
    public final void addPostProcessor(PostProcessor pp)
    {
        postProcessors.add(pp);
    }

    /**
     * Returns the names of this formatter
     * @return the names
     */
    public abstract Set names();
}