org.apache.camel.model

Class RouteTemplateParameterDefinition

java.lang.Object

org.apache.camel.model.RouteTemplateParameterDefinition

@Metadata(label="configuration")
public class RouteTemplateParameterDefinition
extends Object

A route template parameter

Constructor Summary

Constructors

Constructor and Description
RouteTemplateParameterDefinition()
RouteTemplateParameterDefinition(String name, String defaultValue, String description)

Method Summary

Modifier and Type	Method and Description
String	getDefaultValue()
String	getDescription()
String	getName()
Boolean	getRequired()
boolean	isRequired()
void	setDefaultValue(String defaultValue) Default value of the parameter.
void	setDescription(String description) Description of the parameter
void	setName(String name) The name of the parameter
void	setRequired(Boolean required) Whether the parameter is required or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RouteTemplateParameterDefinition

public RouteTemplateParameterDefinition()

RouteTemplateParameterDefinition

public RouteTemplateParameterDefinition(String name,
                                        String defaultValue,
                                        String description)

Method Detail

isRequired

public boolean isRequired()

getName

public String getName()

setName

public void setName(String name)

The name of the parameter

getRequired

public Boolean getRequired()

setRequired

public void setRequired(Boolean required)

Whether the parameter is required or not. A parameter is required unless this option is set to false or a default value has been configured.

getDefaultValue

public String getDefaultValue()

setDefaultValue

public void setDefaultValue(String defaultValue)

Default value of the parameter. If a default value is provided then the parameter is implied not to be required.

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

Description of the parameter