jadex.bridge.modelinfo.Argument Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jadex-platform-bridge Show documentation

Jadex bridge is a base package for kernels and platforms, i.e., it is used by both and provides commonly used interfaces and classes for active components and their management.

There is a newer version: 4.0.267

Show newest version

package jadex.bridge.modelinfo;

import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import jadex.commons.Tuple2;

/**
 *  Simple default implementation for an argument.
 */
public class Argument	extends UnparsedExpression	implements IArgument
{
	//-------- attributes --------
	
	/** The description. */
	protected String	description;
	
	//-------- constructors --------
	
	/**
	 *  Create a new argument.
	 */
	public Argument()
	{
	}
	
	/**
	 *  Create a new argument.
	 */
	public Argument(String name, String description, String classname, String defaultvalue)
	{
		super(name, classname, defaultvalue, null);
		this.description = description;
	}
	
	//-------- methods --------
	
	/**
	 *  Get the description.
	 *  @return The description.
	 */
	public String getDescription()
	{
		return description;
	}
	
	/**
	 *  Set the description.
	 *  @param description The description to set.
	 */
	public void setDescription(String description)
	{
		this.description = description;
	}
	
	/**
	 *  Get the default value.
	 *  @return The default value.
	 */
	public UnparsedExpression	getDefaultValue()
	{
		return this;
	}

	/**
	 *  Check the validity of an input.
	 *  @param input The input.
	 *  @return True, if valid.
	 */
	public boolean validate(String input)
	{
		// todo: support validation
		return true;
	}

	/**
	 *  Get the string representation.
	 *  @return The string representation.
	 */
	public String toString()
	{
		return "Argument(defaultvalue=" + this.value + ", description="
			+ this.description + ", name=" + this.name + ", typename="
			+ this.clazz + ")";
	}
	
	/**
	 *  Get a specific result from a result collection.
	 */
	public static Object getResult(Collection> results, String name)
	{
		Object ret = null;
		
		if(results!=null)
		{
			for(java.util.Iterator> it=results.iterator(); it.hasNext(); )
			{
				Tuple2 tup = it.next();
				if(tup.getFirstEntity().equals(name))
				{
					ret = tup.getSecondEntity();
					break;
				}
			}
		}
		
		return ret;
	}
	
	/**
	 *  Convert arguments to argument map.
	 */
	public static Map convertArguments(Collection> results)
	{
		Map ret = new HashMap();

		for(Iterator> it=results.iterator(); it.hasNext(); )
		{
			Tuple2 tup = it.next();
			ret.put(tup.getFirstEntity(), tup.getSecondEntity());
		}
		
		return ret;
	}
}