org.restexpress.plugin.RoutePlugin Maven / Gradle / Ivy

Go to download
/*
    Copyright 2014, Strategic Gains, Inc.

	Licensed 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.restexpress.plugin;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

import org.restexpress.route.RouteBuilder;

/**
 * Adds some convenience methods to AbstractPlugin for plugins that create
 * internal routes. RoutePlugin enables the concept of flags and parameters 
 * on those routes.
 * 
 * Essentially, you want to be sure to call applyFlags(RouteBuilder) and
 * applyParameters(RouteBuilder) for each RouteBuilder created internally.
 * 
 * @author toddf
 * @since Mar 27, 2014
 */
public abstract class RoutePlugin
extends AbstractPlugin
{
	private List flags = new ArrayList();
	private Map parameters = new HashMap();

	public RoutePlugin()
	{
		super();
	}

	// RouteBuilder route augmentation delegates.

	public RoutePlugin flag(String flagValue)
	{
		if (!flags.contains(flagValue))
		{
			flags.add(flagValue);
		}

		return this;
	}

	public RoutePlugin parameter(String name, Object value)
	{
		if (!parameters.containsKey(name))
		{
			parameters.put(name, value);
		}

		return this;
	}

	void applyFlags(RouteBuilder routeBuilder)
	{
		for (String flag : flags)
		{
			routeBuilder.flag(flag);
		}
	}

	void applyParameters(RouteBuilder routeBuilder)
	{
		for (Entry entry : parameters.entrySet())
		{
			routeBuilder.parameter(entry.getKey(), entry.getValue());
		}
	}
}