com.perforce.p4java.core.file
Interface IExtendedFileSpec

All Superinterfaces:
IFileOperationResult, IFileSpec, IServerResource
All Known Implementing Classes:
ExtendedFileSpec

public interface IExtendedFileSpec
extends IFileSpec

Extends the basic IFileSpec with methods and fields for use with the IServer getExtendedFiles method and other specialized methods.

This information is typically only returned by the server.fstat() method or similarly specialized method, but this interface may be returned or used by other methods as documented. Note that returns from these methods may be (and often will be) null.

No documentation is given here on individual methods and usage; please consult the detailed Perforce documentation for help with this.

Note that setter methods below will only affect local fields and are provided mostly to help with object initialization.


Field Summary
 
Fields inherited from interface com.perforce.p4java.core.file.IFileSpec
HAVE_REVISION, HAVE_REVISION_STRING, HEAD_REVISION, HEAD_REVISION_STRING, NO_FILE_REVISION, NO_REVISION_STRING, NONE_REVISION, NONE_REVISION_STRING
 
Method Summary
 String getActionOwner()
           
 Map<String,byte[]> getAttributes()
          Get the file attributes of this file, if they're available.
 String getCharset()
           
 String getDesc()
           
 String getDigest()
           
 long getFileSize()
           
 int getHaveRev()
           
 FileAction getHeadAction()
           
 int getHeadChange()
           
 String getHeadCharset()
           
 Date getHeadModTime()
           
 int getHeadRev()
           
 Date getHeadTime()
           
 String getHeadType()
           
 String getMovedFile()
           
 FileAction getOpenAction()
           
 String getOpenActionOwner()
           
 int getOpenChangelistId()
           
 String getOpenType()
           
 List<String> getOtherActionList()
           
 List<String> getOtherChangelist()
           
 List<String> getOtherOpenList()
           
 List<IResolveRecord> getResolveRecords()
           
 String getVerifyStatus()
           
 boolean isMapped()
           
 boolean isOtherLocked()
           
 boolean isReresolvable()
           
 boolean isResolved()
           
 boolean isShelved()
           
 boolean isUnresolved()
           
 void setActionOwner(String actionOwner)
           
 void setCharset(String charset)
           
 void setDesc(String desc)
           
 void setDigest(String digest)
           
 void setFileSize(long size)
           
 void setHaveRev(int rev)
           
 void setHeadAction(FileAction action)
           
 void setHeadChange(int change)
           
 void setHeadCharset(String charset)
           
 void setHeadModTime(Date date)
           
 void setHeadRev(int rev)
           
 void setHeadTime(Date date)
           
 void setHeadType(String type)
           
 void setMapped(boolean mapped)
           
 void setMovedFile(String movedFile)
           
 void setOpenAction(FileAction action)
           
 void setOpenActionOwner(String owner)
           
 void setOpenChangelistId(int id)
           
 void setOpenType(String type)
           
 void setOtherActionList(List<String> actionList)
           
 void setOtherChangelist(List<String> otherChangelist)
           
 void setOtherLocked(boolean otherLocked)
           
 void setOtherOpenList(List<String> otherOpenList)
           
 void setReresolvable(boolean reresolvable)
           
 void setResolved(boolean resolved)
           
 void setResolveRecords(List<IResolveRecord> resolveRecords)
           
 void setUnresolved(boolean unresolved)
           
 void setVerifyStatus(String status)
           
 
Methods inherited from interface com.perforce.p4java.core.file.IFileSpec
getAction, getAnnotatedPathString, getAnnotatedPreferredPathString, getAnnotations, getAnnotations, getBaseFile, getBaseName, getBaseRev, getChangelistId, getClientName, getClientPath, getClientPathString, getContentResolveType, getContents, getContents, getDate, getDepotPath, getDepotPathString, getDiffStatus, getEndFromRev, getEndRevision, getEndToRev, getFileType, getFromFile, getHowResolved, getLabel, getLocalPath, getLocalPathString, getOriginalPath, getOriginalPathString, getOtherAction, getPath, getPathString, getPreferredPath, getPreferredPathString, getResolveType, getRevisionHistory, getRevisionHistory, getShelvedChange, getStartFromRev, getStartRevision, getStartToRev, getToFile, getUserName, getWorkRev, isLocked, isUnmap, move, move, setAction, setBaseFile, setBaseName, setBaseRev, setChangelistId, setClientName, setClientPath, setContentResolveType, setDate, setDepotPath, setDiffStatus, setEndFromRev, setEndRevision, setEndToRev, setFileType, setFromFile, setHowResolved, setLabel, setLocalPath, setLocked, setOriginalPath, setOtherAction, setPath, setPathFromString, setResolveType, setShelvedChange, setStartFromRev, setStartRevision, setStartToRev, setToFile, setUnmap, setUserName, setWorkRev, toString
 
Methods inherited from interface com.perforce.p4java.core.file.IFileOperationResult
getGenericCode, getOpStatus, getRawCode, getSeverityCode, getStatusMessage, getSubCode, getSubSystem, getUniqueCode
 
Methods inherited from interface com.perforce.p4java.core.IServerResource
canRefresh, canUpdate, refresh, setServer, update, update, update
 

Method Detail

isMapped

boolean isMapped()

setMapped

void setMapped(boolean mapped)

getHeadAction

FileAction getHeadAction()

setHeadAction

void setHeadAction(FileAction action)

getHeadChange

int getHeadChange()

setHeadChange

void setHeadChange(int change)

getHeadRev

int getHeadRev()

setHeadRev

void setHeadRev(int rev)

getHeadType

String getHeadType()

setHeadType

void setHeadType(String type)

getHeadTime

Date getHeadTime()

setHeadTime

void setHeadTime(Date date)

getHeadModTime

Date getHeadModTime()

setHeadModTime

void setHeadModTime(Date date)

getHeadCharset

String getHeadCharset()

setHeadCharset

void setHeadCharset(String charset)

getHaveRev

int getHaveRev()

setHaveRev

void setHaveRev(int rev)

getDesc

String getDesc()

setDesc

void setDesc(String desc)

getDigest

String getDigest()

setDigest

void setDigest(String digest)

getFileSize

long getFileSize()

setFileSize

void setFileSize(long size)

getOpenAction

FileAction getOpenAction()

setOpenAction

void setOpenAction(FileAction action)

getOpenType

String getOpenType()

setOpenType

void setOpenType(String type)

getOpenActionOwner

String getOpenActionOwner()

setOpenActionOwner

void setOpenActionOwner(String owner)

getCharset

String getCharset()

setCharset

void setCharset(String charset)

getOpenChangelistId

int getOpenChangelistId()

setOpenChangelistId

void setOpenChangelistId(int id)

isUnresolved

boolean isUnresolved()

setUnresolved

void setUnresolved(boolean unresolved)

isResolved

boolean isResolved()

setResolved

void setResolved(boolean resolved)

isReresolvable

boolean isReresolvable()

setReresolvable

void setReresolvable(boolean reresolvable)

isOtherLocked

boolean isOtherLocked()

setOtherLocked

void setOtherLocked(boolean otherLocked)

getOtherOpenList

List<String> getOtherOpenList()

setOtherOpenList

void setOtherOpenList(List<String> otherOpenList)

getOtherChangelist

List<String> getOtherChangelist()

setOtherChangelist

void setOtherChangelist(List<String> otherChangelist)

getOtherActionList

List<String> getOtherActionList()

setOtherActionList

void setOtherActionList(List<String> actionList)

isShelved

boolean isShelved()

getActionOwner

String getActionOwner()

setActionOwner

void setActionOwner(String actionOwner)

getResolveRecords

List<IResolveRecord> getResolveRecords()

setResolveRecords

void setResolveRecords(List<IResolveRecord> resolveRecords)

getMovedFile

String getMovedFile()

setMovedFile

void setMovedFile(String movedFile)

getVerifyStatus

String getVerifyStatus()

setVerifyStatus

void setVerifyStatus(String status)

getAttributes

Map<String,byte[]> getAttributes()
Get the file attributes of this file, if they're available. Attributes will only be available if getExtendedFiles was called with the correct FileStatAncilliaryOptions settings; see the main Perforce file attribute documentation. Attributes are treated by the Perforce server as bytes (they're commonly used to store raw data such as thumbnails); it is up to the consumer to determine the "real" type and convert as appropriate.

Returns:
non-null but possibly-empty map of file attributes keyed by attribute name. Individual attribute values may be null.
Since:
2011.1


Copyright © 2015 Perforce Software. All Rights Reserved.