Class FragmentTemplateEngine

java.lang.Object

aQute.bnd.wstemplates.FragmentTemplateEngine

public class FragmentTemplateEngine
extends Object

Manages a set of workspace template fragments. A template fragment is a zip file or a Github repo. A template index file (parameters format) can be used to provide the meta information. For example, a file on Github can hold the overview of available templates. This class is optimized to add multiple indexes and provide a unified overview of templates. It is expected that the users will select what templates to apply.

Once the set of templates is know, an FragmentTemplateEngine.TemplateUpdater is created. This takes a folder and analyzes the given templates. Since there can be multiple templates, there could be conflicts. The caller can remove FragmentTemplateEngine.Update objects if they conflict. Otherwise, multiple updates will be concatenated during FragmentTemplateEngine.TemplateUpdater.commit()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FragmentTemplateEngine.Action
static final record	FragmentTemplateEngine.TemplateInfo	Info about a template, comes from the index files.
class	FragmentTemplateEngine.TemplateUpdater	Used to edit the updates.
static final record	FragmentTemplateEngine.Update	A single update operation
static enum	FragmentTemplateEngine.UpdateStatus	The conflict status.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_INDEX

Constructor Summary

Constructors

Constructor	Description
FragmentTemplateEngine(Workspace workspace)	Constructor

Method Summary

Modifier and Type	Method	Description
void	add(FragmentTemplateEngine.TemplateInfo info)	Convenience method.
List<FragmentTemplateEngine.TemplateInfo>	getAvailableTemplates()	Get the list of available templates
List<FragmentTemplateEngine.TemplateInfo>	read(Parameters ps)	Read the templates from a Parameters
aQute.bnd.result.Result<List<FragmentTemplateEngine.TemplateInfo>>	read(String source)	Parse the file from the source.
aQute.bnd.result.Result<List<FragmentTemplateEngine.TemplateInfo>>	read(URL url)	Read a template index from a URL.
List<FragmentTemplateEngine.TemplateInfo>	resolveRequirements(List<FragmentTemplateEngine.TemplateInfo> templates)	Resolve all required templates recursively.
FragmentTemplateEngine.TemplateUpdater	updater(File folder, List<FragmentTemplateEngine.TemplateInfo> templates)	Create a TemplateUpdater

Methods inherited from class Object

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

Field Details

DEFAULT_INDEX

public static final String DEFAULT_INDEX

See Also:

• Constant Field Values

Constructor Details

FragmentTemplateEngine

public FragmentTemplateEngine(Workspace workspace)

Constructor

Parameters:

workspace -

Method Details

read

public aQute.bnd.result.Result<List<FragmentTemplateEngine.TemplateInfo>> read(URL url)

Read a template index from a URL. The result is **not** added to this class. See read(String) for the file's format

Parameters:

url - to read.

Returns:

the result

read

public aQute.bnd.result.Result<List<FragmentTemplateEngine.TemplateInfo>> read(String source)

Parse the file from the source. The format is:

* key – see TemplateID
* name – A human readable name
* description – An optional human readable description
* require – An optional comma separated list of TemplateID that will be included
* tags – An optional comma separated list of tags

Parameters:

source - the source (Parameters format)

Returns:

the result.

read

public List<FragmentTemplateEngine.TemplateInfo> read(Parameters ps)

Read the templates from a Parameters

Parameters:

ps - the parameters

Returns:

the list of template info

add

public void add(FragmentTemplateEngine.TemplateInfo info)

Convenience method. Add a FragmentTemplateEngine.TemplateInfo to a list of available templates, see getAvailableTemplates() internally maintained.

getAvailableTemplates

public List<FragmentTemplateEngine.TemplateInfo> getAvailableTemplates()

Get the list of available templates

updater

public FragmentTemplateEngine.TemplateUpdater updater(File folder,
 List<FragmentTemplateEngine.TemplateInfo> templates)

Create a TemplateUpdater

resolveRequirements

public List<FragmentTemplateEngine.TemplateInfo> resolveRequirements(List<FragmentTemplateEngine.TemplateInfo> templates)

Resolve all required templates recursively. This method processes the 'require' field of each template and includes all transitively required templates.

Parameters:

templates - the initial list of templates

Returns:

a list containing the original templates plus all required templates, with duplicates removed