org.jext.project
Interface Project

All Known Implementing Classes:

AbstractProject

public interface Project

Defines a basic project created using Jext.

Author:

Matt Benson

Method Summary

void	closeFile(java.io.File f) Close the specified File.
java.lang.Object	getAttribute(java.lang.String key) Returns the value of the specified attribute for this Project.
java.lang.Object	getAttribute(java.lang.String key, java.lang.Object defaultValue) Returns the value of the specified attribute for this Project, returning the specified default value if no such attribute exists.
java.lang.String	getAttributeAsString(java.lang.String key) Returns the String value of the specified attribute for this Project.
java.io.File[]	getFiles() Returns the Files that compose this Project.
java.lang.String	getName() Returns the name of this Project.
java.io.File	getSelectedFile() Returns the currently selected File of this Project.
void	openFile(java.io.File f) Open the specified File in this Project.
void	selectFile(java.io.File f) Select the specified File.
void	setAttribute(java.lang.String key, java.lang.Object value) Sets the specified attribute.

Method Detail

getName

public java.lang.String getName()

Returns the name of this Project.

Returns:

String.

getFiles

public java.io.File[] getFiles()

Returns the Files that compose this Project. If any of these Files is a directory, it is understood that all Files in and below this directory are part of this Project.

Returns:

File[].

openFile

public void openFile(java.io.File f)

Open the specified File in this Project. Although it is an implementation decision, this act might also add the specified File to this Project.

Parameters:

f - the File to close.

closeFile

public void closeFile(java.io.File f)

Close the specified File.

Parameters:

f - the File to close.

selectFile

public void selectFile(java.io.File f)

Select the specified File. It is recommended that this method be implemented such that the File is opened if not already open.

Parameters:

f - the File to select.

See Also:

openFile(File)

getSelectedFile

public java.io.File getSelectedFile()

Returns the currently selected File of this Project.

Returns:

File.

getAttribute

public java.lang.Object getAttribute(java.lang.String key)

Returns the value of the specified attribute for this Project.

Parameters:

key - the String key to which this attribute is tied.

Returns:

Object

getAttribute

public java.lang.Object getAttribute(java.lang.String key,
                                     java.lang.Object defaultValue)

Returns the value of the specified attribute for this Project, returning the specified default value if no such attribute exists.

Parameters:

key - the String key to which this attribute is tied.

defaultValue - the default Object to return if no such attribute exists.

Returns:

Object

getAttributeAsString

public java.lang.String getAttributeAsString(java.lang.String key)

Returns the String value of the specified attribute for this Project.

Parameters:

key - the String key to which this attribute is tied.

Returns:

String

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object value)

Sets the specified attribute.

Parameters:

key - the String key of the attribute to be set.

value - the Object value to assign.