• Home
• org.daisy.streamline
• streamline-api
• 1.6.0
• source code
• FileDetails.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.FileDetails Maven / Gradle / Ivy

package org.daisy.streamline.api.media;

import java.util.Map;

/**
 * Provides details regarding a file.
 * @author Joel Håkansson
 */
public interface FileDetails {
	
	/**
	 * Gets the identifying name for the file format. This should be the shortest
	 * name commonly used when referring to the file format.
	 * @return returns the name, or null if not known
	 */
	public String getFormatName();
	
	/**
	 * Gets the identifying file extension of this file's format without the leading '.' (which may or may not 
	 * correspond with the actual extension of the file retrieved by getFile).
	 * 
	 * @return the identifying file extension, or null if unknown
	 */
	public String getExtension();

	/**
	 * Gets the media type for this file's format.
	 * @return the media type, or null if unknown.
	 * @see Media Types
	 */
	public String getMediaType();
	
	/**
	 * Gets additional properties about the file. To conform with this interface
	 * the returned map and all value objects must be immutable.
	 * @return returns a map of properties
	 */
	public Map getProperties();

}