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.

pathString

protected String pathString

pathType

protected FilePath.PathType pathType

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.

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).

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.

annotate

public String annotate(IFileSpec fileSpec)

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)