• Home
• org.daisy.streamline
• streamline-api
• 1.6.0
• source code
• FileSetMakerService.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.daisy.streamline.api.media.FileSetMakerService Maven / Gradle / Ivy

package org.daisy.streamline.api.media;

import java.util.Map;

/**
 * 

 * Provides an interface for a FileSetMaker service. The purpose of
 * this interface is to expose an implementation of a FileSetMaker as
 * an OSGi service.
 * 
 * 
 * 

 * To comply with this interface, an implementation must be thread safe and
 * address both the possibility that only a single instance is created and used
 * throughout and that new instances are created as desired.
 * 
 * 
 * @author Joel Håkansson
 * 
 */
public interface FileSetMakerService {

	/**
	 * Builds a file set based on the supplied file.
	 * @param f the file to create a file set for
	 * @return returns the file set
	 */
	public FileSet create(AnnotatedFile f);
	
	/**
	 * Builds a file set based on the supplied file.
	 * @param f the file to create a file set for
	 * @param parameters parameters to pass to the file set creator
	 * @return returns the file set
	 */
	public FileSet create(AnnotatedFile f, Map parameters);

}