com.groupdocs.parser.templates

Class TemplateCollection

java.lang.Object

com.groupdocs.parser.templates.TemplateCollection

All Implemented Interfaces:

Iterable<Template>

public class TemplateCollection
extends Object
implements Iterable<Template>

A collection of candidate Templates used by automatic template selection.

Pass an instance to Parser.parseByTemplate(TemplateCollection, com.groupdocs.parser.options.ParseByTemplateOptions) and the parser will choose the best-matching template for the document being parsed.

Constructor Summary

Constructors

Constructor and Description
TemplateCollection() Initializes a new empty instance of the TemplateCollection class.
TemplateCollection(Iterable<? extends Template> templates) Initializes a new instance of the TemplateCollection class populated with the given templates.

Method Summary

Modifier and Type	Method and Description
void	add(Template template) Adds a template to the collection.
void	clear() Clears the collection.
Template	get(int index) Gets the template at the given index.
int	getCount() Gets the number of templates in the collection.
Iterator<Template>	iterator()
void	removeAt(int index) Removes the template at the given index.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TemplateCollection

public TemplateCollection()

Initializes a new empty instance of the TemplateCollection class.

TemplateCollection

public TemplateCollection(Iterable<? extends Template> templates)

Initializes a new instance of the TemplateCollection class populated with the given templates.

Parameters:

templates - The templates to seed the collection with.

Method Detail

add

public void add(Template template)

Adds a template to the collection.

Parameters:

template - The template to add.

removeAt

public void removeAt(int index)

Removes the template at the given index.

Parameters:

index - The zero-based index.

clear

public void clear()

Clears the collection.

get

public Template get(int index)

Gets the template at the given index.

Parameters:

index - The zero-based index.

Returns:

The template.

getCount

public int getCount()

Gets the number of templates in the collection.

Returns:

The size.

iterator

public Iterator<Template> iterator()

Specified by:

iterator in interface Iterable<Template>