com.vaadin.generator.metadata

Class ComponentFunctionData

java.lang.Object

com.vaadin.generator.metadata.ComponentFunctionData

public class ComponentFunctionData
extends Object

Represents a exposed function of the webcomponent, that can be called on the server-side by the corresponding Java class.

Since:

1.0

See Also:

ComponentMetadata

Constructor Summary

Constructors

Constructor and Description
ComponentFunctionData()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets the public description of the function, that can be used to generate the corresponding Javadoc at the Java class.
String	getName() Gets the name of the function on the webcomponent.
List<ComponentFunctionParameterData>	getParameters() Gets the list of parameters of the function.
ComponentBasicType	getReturns() Gets the return type of the function.
void	setDescription(String description) Sets the public description of the function, that can be used to generate the corresponding Javadoc at the Java class.
void	setName(String name) Sets the name of the function on the webcomponent.
void	setParameters(List<ComponentFunctionParameterData> parameters) Sets the list of parameters of the function.
void	setReturns(ComponentBasicType returns) Sets the return type of the function.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentFunctionData

public ComponentFunctionData()

Method Detail

getName

public String getName()

Gets the name of the function on the webcomponent.

Returns:

The name of the function.

setName

public void setName(String name)

Sets the name of the function on the webcomponent.

Parameters:

name - The name of the function.

getReturns

public ComponentBasicType getReturns()

Gets the return type of the function.

Returns:

The type of the return, or null if void.

setReturns

public void setReturns(ComponentBasicType returns)

Sets the return type of the function.

Parameters:

returns - The type of the return, or null if void.

getDescription

public String getDescription()

Gets the public description of the function, that can be used to generate the corresponding Javadoc at the Java class.

Returns:

The function-level description.

setDescription

public void setDescription(String description)

Sets the public description of the function, that can be used to generate the corresponding Javadoc at the Java class.

Parameters:

description - The function-level description.

getParameters

public List<ComponentFunctionParameterData> getParameters()

Gets the list of parameters of the function. Each parameter is represented by the ComponentFunctionParameterData object.

Returns:

The list of parameters of the function.

setParameters

public void setParameters(List<ComponentFunctionParameterData> parameters)

Sets the list of parameters of the function. Each parameter is represented by the ComponentFunctionParameterData object.

Parameters:

parameters - The list of parameters of the function.