SongImporter (jjazzlab 4.0.3-SNAPSHOT API)

public interface SongImporter

An interface for objects able to import a song object from a file.

Method Summary

Modifier and Type

Method

Description

String

getId()

A unique id or name for the importer.

List<FileNameExtensionFilter>

getSupportedFileTypes()

Get the list of file types which can be read by this object.

Song

importFromFile(File f)

Try to build a Song object from the specified file.

Method Details
- getId
  
  String getId()
  
  A unique id or name for the importer.
  
  Returns:
- getSupportedFileTypes
  
  List<FileNameExtensionFilter> getSupportedFileTypes()
  
  Get the list of file types which can be read by this object.
  
  Returns:
  
  Can't be empty.
- importFromFile
  
  Song importFromFile(File f) throws IOException, SongCreationException
  
  Try to build a Song object from the specified file.
  
  Parameters:
  
  f -
  
  Returns:
  
  Throws:
  
  IOException
  
  SongCreationException