org.btrplace.btrpsl.template

Interface TemplateFactory

All Known Implementing Classes:

DefaultTemplateFactory, MockTemplateFactory

public interface TemplateFactory

A factory of templates. Allow to register several templates and to check element from the template name and the element identifier.

Author:

Fabien Hermenier

Method Summary

Modifier and Type	Method and Description
void	check(Script scr, String tplName, Element e, Map<String,String> attrs) Build an element.
Set<String>	getAvailables() Get the available templates.
boolean	isAvailable(String id) Test if a template is available.
Template	register(Template tpl) Register a template.

Method Detail

getAvailables

Set<String> getAvailables()

Get the available templates.

Returns:

a set of templates identifier that may be empty

isAvailable

boolean isAvailable(String id)

Test if a template is available.

Parameters:

id - the template identifier

Returns:

true iff the template is available

check

void check(Script scr,
           String tplName,
           Element e,
           Map<String,String> attrs)
    throws ElementBuilderException

Build an element.

Parameters:

scr - the script the element belongs to.

tplName - the template name for the element

e - the element associated to the template

attrs - the attributes related to the element. @return the built element if succeed

Throws:

ElementBuilderException - if an error occurred

register

Template register(Template tpl)

Register a template.

Parameters:

tpl - the template to register

Returns:

the template that was previously registered in place of tpl.