TemplateBuilder.java

/**
 * Copyright (C) 2015 Born Informatik AG (www.born.ch)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.wte4j;

import java.nio.file.Path;
import java.util.Map;

public interface TemplateBuilder<E> {

	TemplateBuilder<E> setDocumentName(String name);

	TemplateBuilder<E> setLanguage(String languageCode);

	TemplateBuilder<E> setAuthor(User user);

	TemplateBuilder<E> setProperties(Map<String, String> properties);

	TemplateBuilder<E> setTemplateFile(Path file);

	TemplateBuilder<E> setMappingData(Map<String, MappingDetail> mappingData);

	/**
	 * 
	 * @return a valid template containing all the elements provided by
	 *         {@linkplain WteModelService
	 *         WteModelService.createModel(Template<?>, Object)}
	 * @throws TemplateBuildException
	 */
	Template<E> build() throws TemplateBuildException;
}