br.com.jhonsapp.repository.object.Object Maven / Gradle / Ivy

Go to download
package br.com.jhonsapp.repository.object;

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

/**
 * An abstract representation of the repository object.
 * 
 * @author Jhonathan Camacho.
 */
public interface Object extends Serializable {
	
	/**
	 * Get the object id.
	 * 
	 * @return the name.
	 */
	public String getId();
	
	/**
	 * 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 getContentsInFile();

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