DirectoryEntry.java

/*
 * Copyright (C) 2006 Steve Ratcliffe
 * 
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2 as
 *  published by the Free Software Foundation.
 * 
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 * 
 * 
 * Author: Steve Ratcliffe
 * Create date: 02-Dec-2006
 */
package uk.me.parabola.imgfmt.fs;

/**
 * Interface used for directory entries used to represent <i>files</i>.
 * A directory entry has the file name, its extension (its a 8+3 filename)
 * and the size of the file.
 *
 * @author Steve Ratcliffe
 */
public interface DirectoryEntry {
	public static final int ENTRY_SIZE = 512;
	public static final int SLOTS_PER_ENTRY = 240;

	/**
	 * Get the file name.
	 * @return The file name.
	 */
	public String getName();

	/**
	 * Get the file extension.
	 * @return The file extension.
	 */
	public String getExt();

	/**
	 * Get the full name.  That is name + extension.
	 *
	 * @return The full name as NAME.EXT
	 */
	public String getFullName();

	/**
	 * Get the file size.
	 * @return The size of the file in bytes.
	 */
	public int getSize();

	/**
	 * If this is a special 'hidden' file.  True for the all-spaces 'file'.
	 *
	 * @return True if this is not a regular file.
	 */
	public boolean isSpecial();
}