de.fu_berlin.inf.dpp.negotiation.FileList Class Reference

List of all members.

Classes
class	File
class	MetaData
Public Member Functions
String	getVCSRevision (String path)
String	getVCSUrl (String path)
Set< String >	getEncodings ()
List< String >	getPaths ()
FileListDiff	diff (FileList other)
boolean	useVersionControl ()
String	getVcsProviderID ()
VCSResourceInfo	getProjectInfo ()
String	getRepositoryRoot ()
String	getProjectID ()
void	setProjectID (String projectID)
int	hashCode ()
boolean	equals (Object o)
String	toString ()
Static Public Attributes
static final String	DIR_SEPARATOR = "/"
Package Functions
MetaData	getMetaData (String path)
	FileList ()
void	addEncoding (String charset)
void	addPath (String path)
void	addPath (String path, MetaData metaData, boolean isDirectory)
boolean	contains (String path)
void	setVcsProviderID (String id)
void	setVcsRepositoryRoot (VCSResourceInfo info)
void	setVcsRepositoryRoot (String repoRoot)

---

Detailed Description

A FileList is a list of resources -- files and folders -- which belong to the same project. FileLists can be compared to other FileLists. Folders are denoted by a trailing separator. Instances of this class are immutable. No further modification is allowed after creation. Instances should be created using the methods provided by the FileListFactory.

Author:

rdjemili

---

Constructor & Destructor Documentation

de.fu_berlin.inf.dpp.negotiation.FileList.FileList

(

)

[package]

Creates an empty file list.

---

Member Function Documentation

void de.fu_berlin.inf.dpp.negotiation.FileList.addEncoding

(

String

charset

)

[package]

void de.fu_berlin.inf.dpp.negotiation.FileList.addPath

(

String

path

)

[package]

void de.fu_berlin.inf.dpp.negotiation.FileList.addPath	(	String	path,
		MetaData	metaData,
		boolean	isDirectory
	)		[package]

boolean de.fu_berlin.inf.dpp.negotiation.FileList.contains

(

String

path

)

[package]

FileListDiff de.fu_berlin.inf.dpp.negotiation.FileList.diff

(

FileList

other

)

boolean de.fu_berlin.inf.dpp.negotiation.FileList.equals

(

Object

o

)

Set<String> de.fu_berlin.inf.dpp.negotiation.FileList.getEncodings

(

)

Returns all encodings (e.g UTF-8, US-ASCII) that are used by the files contained in this file list.

Returns:

used encodings which may be empty if the encodings are not known

MetaData de.fu_berlin.inf.dpp.negotiation.FileList.getMetaData

(

String

path

)

[package]

List<String> de.fu_berlin.inf.dpp.negotiation.FileList.getPaths

(

)

Returns a list of all paths in this FileList.

Example: In case the FileList looks like this:

 / A
   / A1.java
 / B
   / B2.java
   / B3.java
 / C
 

then this method returns: [A/A1.java, B/B2.java, B/B3.java, C/]

Returns:

Returns only the leaves of the tree, i.e. folders are only included if they don't contain anything. The paths are sorted by their character length.

String de.fu_berlin.inf.dpp.negotiation.FileList.getProjectID

(

)

VCSResourceInfo de.fu_berlin.inf.dpp.negotiation.FileList.getProjectInfo

(

)

String de.fu_berlin.inf.dpp.negotiation.FileList.getRepositoryRoot

(

)

String de.fu_berlin.inf.dpp.negotiation.FileList.getVcsProviderID

(

)

String de.fu_berlin.inf.dpp.negotiation.FileList.getVCSRevision

(

String

path

)

String de.fu_berlin.inf.dpp.negotiation.FileList.getVCSUrl

(

String

path

)

int de.fu_berlin.inf.dpp.negotiation.FileList.hashCode

(

)

void de.fu_berlin.inf.dpp.negotiation.FileList.setProjectID

(

String

projectID

)

void de.fu_berlin.inf.dpp.negotiation.FileList.setVcsProviderID

(

String

id

)

[package]

void de.fu_berlin.inf.dpp.negotiation.FileList.setVcsRepositoryRoot

(

VCSResourceInfo

info

)

[package]

void de.fu_berlin.inf.dpp.negotiation.FileList.setVcsRepositoryRoot

(

String

repoRoot

)

[package]

String de.fu_berlin.inf.dpp.negotiation.FileList.toString

(

)

boolean de.fu_berlin.inf.dpp.negotiation.FileList.useVersionControl

(

)

---

Member Data Documentation

final String de.fu_berlin.inf.dpp.negotiation.FileList.DIR_SEPARATOR = "/" [static]

Separator used to divide path segments and mark directories in a file list by suffixing the path entry with this value.