com.phoenixnap.oss.ramlapisync.generation.rules.ConfigurableRule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of springmvc-raml-parser Show documentation

Components including the parsing of RAML documents and Spring MVC Annotations to create RAML models

The newest version!

/*
 * Copyright 2002-2017 the original author or authors.
 * 
 * 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 com.phoenixnap.oss.ramlapisync.generation.rules;

import java.util.Map;

/**
 * An Extension of the rule interface to represent rules that are configurable
 *
 * @param 
 *            The type of the source code item on which this rule can operate. E.g. JClass.
 * @param 
 *            The type of the source code item generated by this rule. E.g. JMethod.
 * @param 
 *            The type of the meta data that this rule should operate on. E.g ApiControllerMetadata.
 *
 * @author kurt.paris
 * @since 0.5.0
 */
public interface ConfigurableRule extends Rule {
	
	/**
	 * Accepts a key-value representation of the the configurations and their respective values
	 * 
	 * @param configuration The Map with the configuration to applye
	 */
	void applyConfiguration(Map configuration);

}