Package com.perforce.p4java.impl.generic.core.file

Class FilePath

java.lang.Object

com.perforce.p4java.impl.generic.core.file.FilePath

public class FilePath
extends Object

Defines a file spec path for Perforce IFileSpec objects, and a bunch of useful methods for extracting and appending Perforce file-related metadata (such as revision information or label / changelist / date annotations) to and from paths and path strings. In Perforce terms, a file path specifies a particular file, but not a specific revision of that file (either implicitly or explicitly). That is, FilePath objects do not contain the possible "#" or "@" (etc.) specifiers suffixed to Perforce paths. In P4Java terms, file path strings are typically string representations of paths as understood above, but with version / changelist / etc. annotations attached.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FilePath.PathType	Defines the various types a Perforce file path can have.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	pathString
protected FilePath.PathType	pathType

Constructor Summary

Constructors

Constructor	Description
FilePath()	Default constructor -- sets path type field to UNKNOWN, path string to null.
FilePath(FilePath.PathType pathType, String pathString)	Construct a FilePath from explicit type and path string values.
FilePath(FilePath.PathType pathType, String pathString, boolean ignoreAnnotations)	Construct a FilePath from explicit type and path string values.

Method Summary

Modifier and Type	Method	Description
String	annotate(IFileSpec fileSpec)
String	annotate(PathAnnotations annotations)	Annotate this path with the passed-in Perforce file metadata annotations.
String	getPathString()
FilePath.PathType	getPathType()
void	setPathString(String pathString)
void	setPathType(FilePath.PathType pathType)
String	toString()	Note: does NOT annotate by default!

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

pathString

protected String pathString

pathType

protected FilePath.PathType pathType

Constructor Details

FilePath

public FilePath()

Default constructor -- sets path type field to UNKNOWN, path string to null.

FilePath

public FilePath(FilePath.PathType pathType,
 String pathString)

Construct a FilePath from explicit type and path string values. If the passed-in pathString contains version / date / changelist information, it is stripped from the path and ignored.

Parameters:

pathType - pathType

pathString - pathString

FilePath

public FilePath(FilePath.PathType pathType,
 String pathString,
 boolean ignoreAnnotations)

Construct a FilePath from explicit type and path string values. If the ignoreAnnotations parameter is false and if the passed-in pathString contains version / date / changelist information, it is stripped from the path and ignored; otherwise the pathString parameter is used-as is (allowing for embedded "#" and "@" characters, for instance).

Parameters:

pathType - pathType

pathString - pathString

ignoreAnnotations - ignoreAnnotations

Method Details

annotate

public String annotate(PathAnnotations annotations)

Annotate this path with the passed-in Perforce file metadata annotations. If either or both this.pathString and annotations is null, returns this.pathString.

Parameters:

annotations - annotations

Returns:

path string

annotate

public String annotate(IFileSpec fileSpec)

Parameters:

fileSpec - file spec

Returns:

annotated path string

getPathType

public FilePath.PathType getPathType()

toString

public String toString()

Note: does NOT annotate by default!

Overrides:

toString in class Object

getPathString

public String getPathString()

setPathString

public void setPathString(String pathString)

setPathType

public void setPathType(FilePath.PathType pathType)