org.fit.layout.api

Interface ParametrizedOperation

All Known Subinterfaces:

AreaTreeOperator, AreaTreeProvider, BoxTreeProvider, LogicalTreeProvider

All Known Implementing Classes:

BaseAreaTreeProvider, BaseBoxTreeProvider, BaseLogicalTreeProvider, BaseOperator, BaseParametrizedOperation

public interface ParametrizedOperation

An implementation of an operation with external parametres of different types.

Author:

burgetr

Method Summary

Modifier and Type	Method and Description
Object	getParam(String name) Obtains the value of the given parameter.
List<Parameter>	getParams() Obtains a list of available parameters.
boolean	setParam(String name, Object value) Sets the value of the given parameter.

Method Detail

getParams

List<Parameter> getParams()

Obtains a list of available parameters.

Returns:

The list of parameters.

setParam

boolean setParam(String name,
                 Object value)

Sets the value of the given parameter.

Parameters:

name - parameter name

value - parameter value

Returns:

true when successfully set, false for unknown parameter or invalid value

getParam

Object getParam(String name)

Obtains the value of the given parameter.

Parameters:

name - the parameter name

Returns:

the parameter value or null for unknown parameter