br.com.jhonsapp.repository.document.DocumentFile Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of repository Show documentation

Repository is a project created by Jhonathan Camacho to facilitate the file management in local and remote repositories.

The newest version!

package br.com.jhonsapp.repository.document;

import java.io.File;
import java.io.Serializable;

/**
 * An abstract representation of the repository file.
 * 
 * @author Jhonathan Camacho.
 */
public interface DocumentFile extends Serializable {
	
	/**
	 * Get the document file name.
	 * 
	 * @return the name.
	 */
	public String getName();
	
	/**
	 * Gets the directory that the object is in the repository.
	 * 
	 * Standard folder format folder1/folder2/folder3/
	 * 
	 * @return the directory name in the repository.
	 */
	public String getFolder();
	
	/**
	 * Gets the full path of the file in the repository.
	 * 
	 * @return the full path in the repository.
	 */
	public String getAbsolutePath();
	
	/**
	 * Gets the contents of the object in the {@link File} format.
	 * 
	 * @return the file.
	 */
	public File getDocumentInFile();

	/**
	 * Gets the contents of the object in the bytes format.
	 * 
	 * @return the file in bytes.
	 */
	public byte[] getDocumentInByte();
	
}