org.fife.rtext.plugins.project.model
Class FolderProjectEntry

java.lang.Object
  extended by org.fife.rtext.plugins.project.model.FolderProjectEntry
All Implemented Interfaces:
java.lang.Comparable<ProjectEntry>, ModelEntity, ProjectEntry

public class FolderProjectEntry
extends java.lang.Object

A project entry representing a folder on the local file system and its contents, possibly filtered.

Version:
1.0
Author:
Robert Futrell

Field Summary
 
Fields inherited from interface org.fife.rtext.plugins.project.model.ProjectEntry
DIR_PROJECT_ENTRY, FILE_PROJECT_ENTRY, LOGICAL_DIR_PROJECT_ENTRY
 
Constructor Summary
FolderProjectEntry(ProjectEntryParent parent, java.io.File folder)
           
 
Method Summary
 void accept(WorkspaceVisitor visitor)
          Called when a visitor visits this entity.
 int compareTo(ProjectEntry o)
           
 boolean equals(java.lang.Object o)
           
 java.lang.String getDisplayName()
           
 java.io.File getFile()
          Returns the file system resource this project entry represents.
 FolderFilterInfo getFilterInfo()
           
 ProjectEntryParent getParent()
          Returns the parent of this entry.
 java.lang.String getSaveData()
          Returns the data to save about this entry in workspace XML.
 java.lang.String getType()
          Returns the type of project entry this is.
 int hashCode()
           
 void removeFromParent()
          Removes this entry from its parent.
 void setDisplayName(java.lang.String displayName)
           
 void setFilterInfo(FolderFilterInfo filterInfo)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FolderProjectEntry

public FolderProjectEntry(ProjectEntryParent parent,
                          java.io.File folder)
Method Detail

accept

public void accept(WorkspaceVisitor visitor)
Description copied from interface: ModelEntity
Called when a visitor visits this entity.

Parameters:
visitor - The visitor.

compareTo

public int compareTo(ProjectEntry o)

equals

public final boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

getDisplayName

public java.lang.String getDisplayName()

getFile

public java.io.File getFile()
Description copied from interface: ProjectEntry
Returns the file system resource this project entry represents.

Returns:
The file system resource.

getFilterInfo

public FolderFilterInfo getFilterInfo()

getSaveData

public java.lang.String getSaveData()
Description copied from interface: ProjectEntry
Returns the data to save about this entry in workspace XML.

Returns:
The save data.

getType

public java.lang.String getType()
Description copied from interface: ProjectEntry
Returns the type of project entry this is.

Returns:
The type of project entry.

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

setDisplayName

public void setDisplayName(java.lang.String displayName)

setFilterInfo

public void setFilterInfo(FolderFilterInfo filterInfo)

getParent

public final ProjectEntryParent getParent()
Description copied from interface: ProjectEntry
Returns the parent of this entry.

Specified by:
getParent in interface ProjectEntry
Returns:
The parent model object.
See Also:
ProjectEntry.removeFromParent()

removeFromParent

public final void removeFromParent()
Description copied from interface: ProjectEntry
Removes this entry from its parent.

Specified by:
removeFromParent in interface ProjectEntry
See Also:
ProjectEntry.getParent()