A B C D E F G H I J L M N O P R S T U V W

A

addFile(FileEntry) - Method in class com.perforce.api.Change

Adds the given FileEntry to the changelist.

addValue(String) - Method in class com.perforce.api.JobField

addView(String) - Method in class com.perforce.api.Mapping

addView(String, String) - Method in class com.perforce.api.Mapping

Add a view to the Mapping.

ALWAYS - Static variable in class com.perforce.api.JobField

Field type has always reset to the default upon saving

B

Branch - class com.perforce.api.Branch.

Representation of a source control branch.

Branch() - Constructor for class com.perforce.api.Branch

Default no-argument constructor.

Branch(String) - Constructor for class com.perforce.api.Branch

Constructor that is passed the branch name.

C

Cacheable - interface com.perforce.api.Cacheable.

An interface that indicates the implementing class can be cached for some period of time.

Change - class com.perforce.api.Change.

Representation of a source control change.

Change() - Constructor for class com.perforce.api.Change

Default no-argument constructor.

Change(Env) - Constructor for class com.perforce.api.Change

Change(int) - Constructor for class com.perforce.api.Change

Constructor that accepts the change number.

Change(String) - Constructor for class com.perforce.api.Change

checkIn(Env, String, String) - Static method in class com.perforce.api.FileEntry

Checks in a file that has already been opened on the client using the description given.

checkValidity() - Method in class com.perforce.api.Env

Checks the environment to see if it is valid.

cleanUp() - Static method in class com.perforce.api.Utils

Cleans up after the package has been used.

clearCache() - Method in class com.perforce.api.SourceControlObject

Removes any cached objects.

clearCache() - Method in interface com.perforce.api.Cacheable

Removes any cached objects.

Client - class com.perforce.api.Client.

Representation of a source control client.

Client() - Constructor for class com.perforce.api.Client

Default no-argument constructor.

Client(Env, String) - Constructor for class com.perforce.api.Client

Constructor that is passed the client name.

Client(String) - Constructor for class com.perforce.api.Client

Constructor that is passed the client name.

close() - Method in class com.perforce.api.P4Process

Waits for the underlying process to exit and closes it down.

close(PrintStream) - Method in class com.perforce.api.P4Process

Waits for the process to exit and closes out the process.

CLOSED - Static variable in class com.perforce.api.Job

Indicates that the Job is closed.

com.perforce.api - package com.perforce.api

Provides classes for accessing Perforce objects (LICENSE).

commit() - Method in class com.perforce.api.SourceControlObject

Stores this object back into Perforce, creating it if it didn't already exist.

commit() - Method in class com.perforce.api.Mapping

commit() - Method in class com.perforce.api.Client

commit() - Method in class com.perforce.api.DirEntry

Does nothing.

commit() - Method in class com.perforce.api.Branch

commit() - Method in interface com.perforce.api.Cacheable

Stores this object back into Perforce, creating it if it didn't already exist.

commit() - Method in class com.perforce.api.User

TBD: The commit method is not working yet.

commit() - Method in class com.perforce.api.Counter

commit() - Method in class com.perforce.api.Label

commit() - Method in class com.perforce.api.Change

commit() - Method in class com.perforce.api.Job

commit() - Method in class com.perforce.api.FileEntry

No-op.

CommitException - exception com.perforce.api.CommitException.

Signals that an exception occurred during the process of committing a cacheable object to perforce.

CommitException(String) - Constructor for class com.perforce.api.CommitException

commonLog(String) - Static method in class com.perforce.api.EventLog

Logs an event to the common log.

commonLog(String, String) - Static method in class com.perforce.api.EventLog

Logs an event to the common log.

commonLog(String, String, boolean) - Static method in class com.perforce.api.EventLog

Logs an event to the common log.

commonPrefix(Enumeration) - Static method in class com.perforce.api.Utils

Returns common prefix for an Enumeration of strings.

commonPrefix(Vector) - Static method in class com.perforce.api.Utils

Returns common prefix for a Vector of strings.

Counter - class com.perforce.api.Counter.

Representation of perforce counters.

Counter() - Constructor for class com.perforce.api.Counter

Default no-argument constructor.

Counter(Env, String) - Constructor for class com.perforce.api.Counter

Counter(String) - Constructor for class com.perforce.api.Counter

customizePath(String, char, char) - Static method in class com.perforce.api.FileEntry

Returns the path after converting characters.

D

DATE - Static variable in class com.perforce.api.JobField

Data type is a date/time field

Debug - class com.perforce.api.Debug.

Utility class used for debugging.

Debug() - Constructor for class com.perforce.api.Debug

DEFAULT - Static variable in class com.perforce.api.JobField

Field type has default provided, still not required

deleteEmptyChange() - Method in class com.perforce.api.Change

Deletes the Changelist if it is empty.

depotizePath(String) - Static method in class com.perforce.api.FileEntry

Returns the path in depot format.

DirEntry - class com.perforce.api.DirEntry.

Representation of a source control directory.

DirEntry() - Constructor for class com.perforce.api.DirEntry

Default, no-argument constructor.

DirEntry(DirEntry, String) - Constructor for class com.perforce.api.DirEntry

Constructs a directory entry.

DirEntry(Env) - Constructor for class com.perforce.api.DirEntry

Constructs a directory entry.

DirEntry(Env, String) - Constructor for class com.perforce.api.DirEntry

Constructs a directory entry.

E

Env - class com.perforce.api.Env.

Representation of a source control environment.

Env() - Constructor for class com.perforce.api.Env

Default, no-argument constructor.

Env(Env) - Constructor for class com.perforce.api.Env

Constructor that uses another environment as its basis.

Env(Properties) - Constructor for class com.perforce.api.Env

Constructor that uses a set of Properties to set up the environment.

Env(String) - Constructor for class com.perforce.api.Env

Constructs an environment from a properties file.

ERROR - Static variable in class com.perforce.api.Debug

Only error messages are displayed.

error(String) - Static method in class com.perforce.api.Debug

Displays an error message for debugging.

EventLog - class com.perforce.api.EventLog.

This class controls an event log.

EventLog() - Constructor for class com.perforce.api.EventLog

Default, no-argument constructor.

EventLog(String) - Constructor for class com.perforce.api.EventLog

Constructor that accepts the title for this.

EventLog(String, String) - Constructor for class com.perforce.api.EventLog

Constructor that sets the log title and ouput filename.

exec(String[]) - Method in class com.perforce.api.P4Process

Executes a p4 command.

F

FileEntry - class com.perforce.api.FileEntry.

Representation of a source control file.

FileEntry() - Constructor for class com.perforce.api.FileEntry

Default no-argument constructor.

FileEntry(Env) - Constructor for class com.perforce.api.FileEntry

Constructs a file entry using the environment.

FileEntry(Env, String) - Constructor for class com.perforce.api.FileEntry

Constructs a file entry using the environment and path.

FileEntry(String) - Constructor for class com.perforce.api.FileEntry

Constructs a file entry using the path.

fix(Env, String, boolean, String) - Static method in class com.perforce.api.Job

fix(Env, String, boolean, Vector) - Static method in class com.perforce.api.Job

flush() - Method in class com.perforce.api.P4Process

Flushes the output stream to the process.

G

getBase() - Static method in class com.perforce.api.P4Process

Returns the base process for this class.

getBasePath() - Method in class com.perforce.api.DirEntry

Returns the base path for this directory.

getBranch(Env, String, boolean) - Static method in class com.perforce.api.Branch

Returns a Branch with the specified name, or null if not found.

getBranch(String) - Static method in class com.perforce.api.Branch

Returns a Branch with the specified name, or null if not found.

getBranches() - Static method in class com.perforce.api.Branch

Returns list of all branches.

getBranches(Env) - Static method in class com.perforce.api.Branch

Returns list of all branches.

getBranchNames(Env) - Static method in class com.perforce.api.Branch

Returns list of all branch names.

getCache() - Method in class com.perforce.api.SourceControlObject

Returns the HashDecay instance for this class

getCache() - Method in class com.perforce.api.Client

getCache() - Method in class com.perforce.api.DirEntry

getCache() - Method in class com.perforce.api.Branch

getCache() - Method in interface com.perforce.api.Cacheable

Returns the HashDecay instance for this class

getCache() - Method in class com.perforce.api.User

getCache() - Method in class com.perforce.api.Counter

getCache() - Method in class com.perforce.api.Label

getCache() - Method in class com.perforce.api.Change

getCache() - Method in class com.perforce.api.Job

getCache() - Method in class com.perforce.api.FileEntry

getChange(Env, int, boolean) - Static method in class com.perforce.api.Change

getChange(Env, String, boolean) - Static method in class com.perforce.api.Change

getChange(int) - Static method in class com.perforce.api.Change

getChange(int, boolean) - Static method in class com.perforce.api.Change

getChange(String) - Static method in class com.perforce.api.Change

getChange(String, boolean) - Static method in class com.perforce.api.Change

getChangeFixes(Env, String, String[]) - Static method in class com.perforce.api.Job

getChangeFromPath(String) - Static method in class com.perforce.api.Utils

Returns the change number portion of a depot path, if there is a valid one found.

getChanges() - Method in class com.perforce.api.Job

getChanges(Env, String) - Static method in class com.perforce.api.Change

getChanges(Env, String, int, String, String, boolean, String) - Static method in class com.perforce.api.Change

getChanges(String) - Static method in class com.perforce.api.Change

getClient() - Method in class com.perforce.api.Env

Returns the P4CLIENT.

getClient(Env, String) - Static method in class com.perforce.api.Client

Returns a Client with the specified name, or null if not found.

getClient(String) - Static method in class com.perforce.api.Client

Returns a Client with the specified name, or null if not found.

getClientName() - Method in class com.perforce.api.Change

getClientPath() - Method in class com.perforce.api.FileEntry

Returns the client path for this file.

getClients(Env) - Static method in class com.perforce.api.Client

Returns a list of all the clients currently loaded.

getCode() - Method in class com.perforce.api.JobField

getCounters(Env) - Static method in class com.perforce.api.Counter

Returns an array of all the Counters established on the server.

getDataType() - Method in class com.perforce.api.JobField

getDebugLevel() - Static method in class com.perforce.api.Debug

Returns the current debug level.

getDelay() - Method in class com.perforce.api.HashDecay

Returns the delay.

getDepotPath() - Method in class com.perforce.api.FileEntry

Returns the depot path for this file.

getDescription() - Method in class com.perforce.api.Mapping

Returns the Mapping description.

getDescription() - Method in class com.perforce.api.Change

Returns the description for the Change.

getDescription() - Method in class com.perforce.api.Job

Returns the description for the Job.

getDescription() - Method in class com.perforce.api.FileEntry

Returns the decription for this file

getDirEntry(Env, String, boolean) - Static method in class com.perforce.api.DirEntry

Returns a directory entry for the supplied path.

getDirNames() - Method in class com.perforce.api.DirEntry

Returns an array of directory names.

getDirNames(Env) - Method in class com.perforce.api.DirEntry

Returns an array of directory names.

getEmail() - Method in class com.perforce.api.User

Returns the e-mail address for this user.

getEnv() - Method in class com.perforce.api.SourceControlObject

Returns the P4 environment associated with this instance.

getEnv() - Method in class com.perforce.api.P4Process

Returns the environment in use by this process.

getEnvp() - Method in class com.perforce.api.Env

getEventLog() - Static method in class com.perforce.api.Debug

Returns the current EventLog in use.

getExecutable() - Method in class com.perforce.api.Env

Returns the path to the executable.

getExitCode() - Method in class com.perforce.api.P4Process

Returns the exit code returned when the underlying process exits.

getField(String) - Static method in class com.perforce.api.JobField

getField(String) - Method in class com.perforce.api.Job

getFieldNames() - Method in class com.perforce.api.Job

getFieldType() - Method in class com.perforce.api.JobField

getFile(String) - Static method in class com.perforce.api.FileEntry

Gets the file information for the specified path.

getFileContents() - Method in class com.perforce.api.FileEntry

Returns a String that contains this file's contents.

getFileContents(Env, String) - Method in class com.perforce.api.FileEntry

Returns a String that contains this file's contents.

getFileEntries() - Method in class com.perforce.api.Change

Returns a Vector filled with the files (including revision numbers) that were affected by this change.

getFileEntries() - Method in class com.perforce.api.Job

getFileLog(Env, String) - Static method in class com.perforce.api.FileEntry

Returns a list of FileEntry objects that represent the history of the specified file.

getFileName() - Method in class com.perforce.api.EventLog

Returns the output file name.

getFileNames() - Method in class com.perforce.api.DirEntry

Returns an array of file names for this directory.

getFileNames(Env) - Method in class com.perforce.api.DirEntry

Returns an array of file names for this directory.

getFiles() - Method in class com.perforce.api.DirEntry

Returns an array of file entries for this directory.

getFiles() - Method in class com.perforce.api.Change

Returns a Vector filled with the files (including revision numbers) that were affected by this change.

getFiles(Env) - Method in class com.perforce.api.DirEntry

Returns an array of file entries for this directory.

getFiles(Env, String) - Static method in class com.perforce.api.FileEntry

Returns the list of files for the path.

getFullName() - Method in class com.perforce.api.User

Returns the full name of this user.

getHaveRev() - Method in class com.perforce.api.FileEntry

Returns the revision number the client has for this file.

getHeadAction() - Method in class com.perforce.api.FileEntry

Returns the head revision action for this file.

getHeadChange() - Method in class com.perforce.api.FileEntry

Returns the head revision change number for this file.

getHeadDate() - Method in class com.perforce.api.FileEntry

Returns a String representation of date for the head revsision of the file.

getHeadRev() - Method in class com.perforce.api.FileEntry

Returns the head revision number for this file.

getHeadTime() - Method in class com.perforce.api.FileEntry

Returns the head revision time for this file.

getHeadTimeString() - Method in class com.perforce.api.FileEntry

Returns the head revision time as a String for this file.

getHeadType() - Method in class com.perforce.api.FileEntry

Returns the head revision type for this file.

getId() - Method in class com.perforce.api.User

Returns the id for this user.

getJob(Env, String) - Static method in class com.perforce.api.Job

Returns the job with the specified name.

getJob(String) - Static method in class com.perforce.api.Job

Returns the job with the specified name.

getJobs(Env, String, int, boolean, String[]) - Static method in class com.perforce.api.Job

getLabel(Env, String, boolean) - Static method in class com.perforce.api.Label

Returns a Label with the specified name, or null if not found.

getLabel(String) - Static method in class com.perforce.api.Label

Returns a Label with the specified name, or null if not found.

getLabelNames(Env) - Static method in class com.perforce.api.Label

getLabels() - Static method in class com.perforce.api.Label

getLabels(Env) - Static method in class com.perforce.api.Label

getLength() - Method in class com.perforce.api.JobField

getLevelName(int) - Static method in class com.perforce.api.Debug

Returns the name associated with the specified level.

getLog() - Method in class com.perforce.api.EventLog

Returns an Enumeration that contains all the events in the log.

getLogLevel() - Static method in class com.perforce.api.Debug

Returns the current logging level.

getModtimeString() - Method in class com.perforce.api.Change

getModtimeString() - Method in class com.perforce.api.Job

Returns the job's modification time

getName() - Method in class com.perforce.api.Mapping

Returns the name of the Mapping.

getName() - Method in class com.perforce.api.Counter

getName() - Method in class com.perforce.api.JobField

getName() - Method in class com.perforce.api.Job

Returns the name of this Job.

getName() - Method in class com.perforce.api.FileEntry

Returns the file name.

getNumber() - Method in class com.perforce.api.Change

Returns the number of this Change.

getOpened() - Static method in class com.perforce.api.FileEntry

Returns a list of files that are open for edit or add.

getOpened(Env, boolean) - Static method in class com.perforce.api.FileEntry

Returns a list of files that are open for edit or add.

getOpened(Env, boolean, boolean, int, Vector) - Static method in class com.perforce.api.FileEntry

Returns a list of files that are open for edit or add.

getOptions() - Method in class com.perforce.api.Client

Returns the Client options.

getOwner() - Method in class com.perforce.api.Mapping

Returns the owner of the Mapping.

getOwner() - Method in class com.perforce.api.FileEntry

Returns the owner for this file

getParent() - Method in class com.perforce.api.DirEntry

Returns the parent director.

getPassword() - Method in class com.perforce.api.Env

Returns the P4PASSWORD.

getPath() - Method in class com.perforce.api.DirEntry

Returns the path for this directory.

getPath() - Method in class com.perforce.api.Env

Returns the PATH.

getPort() - Method in class com.perforce.api.Env

Returns the P4PORT.

getPreset() - Method in class com.perforce.api.JobField

getProperties() - Method in class com.perforce.api.Env

Returns a new Properties instance that is set using the environments properties as its default.

getProperty(String) - Method in class com.perforce.api.Env

Searches for the property with the specified key in this property list.

getProperty(String, String) - Method in class com.perforce.api.Env

Searches for the property with the specified key in this property list.

getRawMode() - Method in class com.perforce.api.P4Process

Returns the status of raw mode for this process.

getReader() - Method in class com.perforce.api.P4JNI

getRoot() - Method in class com.perforce.api.Client

Returns the Client root.

getServerTimeout() - Method in class com.perforce.api.P4Process

Return the server timeout threshold.

getServerTimeout() - Method in class com.perforce.api.Env

Return the server timeout threshold.

getShortDescription() - Method in class com.perforce.api.Change

getShortDescription(boolean) - Method in class com.perforce.api.Change

getShowThread() - Static method in class com.perforce.api.Debug

Returns the state of showing threads in degugging output.

getSize() - Method in class com.perforce.api.EventLog

Returns the size of the event log memory.

getSource() - Method in class com.perforce.api.FileEntry

Returns the source file entry associated with this file.

getStatus() - Method in class com.perforce.api.Change

Returns the status for the Change.

getStatus() - Method in class com.perforce.api.Job

Returns the status for the Job.

getStatusName() - Method in class com.perforce.api.Job

getSyncTime() - Method in class com.perforce.api.SourceControlObject

Returns the time, in milliseconds, that this object was synchronized.

getSyncTime() - Method in interface com.perforce.api.Cacheable

Returns the time, in milliseconds, that this object was synchronized.

getTitle() - Method in class com.perforce.api.EventLog

Gets the title of the log.

getUpdateTime() - Method in class com.perforce.api.SourceControlObject

Returns the time, in milliseconds, for this object's last update.

getUpdateTime() - Method in interface com.perforce.api.Cacheable

Returns the time, in milliseconds, for this object's last update.

getUser() - Method in class com.perforce.api.Env

Returns the P4USER.

getUser() - Method in class com.perforce.api.Change

Returns the User that owns this Change.

getUser() - Method in class com.perforce.api.Job

Returns the User that owns this Job.

getUser(Env, String) - Static method in class com.perforce.api.User

Returns a User object representing the user.

getUser(String) - Static method in class com.perforce.api.User

Gets the user information for the specified user.

getUsers() - Static method in class com.perforce.api.User

Returns an Enumeration of all User objects.

getUsers(Env) - Static method in class com.perforce.api.User

Returns an Enumeration of all User objects.

getValue() - Method in class com.perforce.api.Counter

Returns the value of this Counter.

getValues() - Method in class com.perforce.api.JobField

getView() - Method in class com.perforce.api.Mapping

getViews() - Method in class com.perforce.api.Mapping

getWriter() - Method in class com.perforce.api.P4JNI

H

HashDecay - class com.perforce.api.HashDecay.

This hashtable build to contain objects that will decay over time.

HashDecay() - Constructor for class com.perforce.api.HashDecay

HashDecay(long) - Constructor for class com.perforce.api.HashDecay

HTMLEncode(String) - Static method in class com.perforce.api.Utils

Returns the string encoded for HTML use.

I

in_close() - Method in class com.perforce.api.P4JNI

in_flush() - Method in class com.perforce.api.P4JNI

in_write(char[], int, int) - Method in class com.perforce.api.P4JNI

initPackage() - Static method in class com.perforce.api.Utils

Initializes the package, in order to avoid some arbitrary JVM problems that have been encountered.

inSync() - Method in class com.perforce.api.SourceControlObject

Marks this object as being in in sync or valid.

inSync() - Method in interface com.perforce.api.Cacheable

Marks this object as being in in sync or valid.

integrate(Env, String, String, StringBuffer, Change) - Static method in class com.perforce.api.Branch

Integrate a set of files using the named branch.

integrate(Env, Vector, String, StringBuffer, Change) - Static method in class com.perforce.api.Branch

Integrate a set of files using the named branch.

integrate(Env, Vector, String, StringBuffer, String) - Static method in class com.perforce.api.Branch

Integrate a set of files using the named branch.

integrate(String, StringBuffer, Change) - Method in class com.perforce.api.Branch

Class method for integrating using the instantiated Branch.

invalidate() - Method in class com.perforce.api.SourceControlObject

Invalidates this object.

invalidate() - Method in interface com.perforce.api.Cacheable

Invalidates this object.

isMSJVM() - Static method in class com.perforce.api.Utils

Check to see if the current Java Virtual Machine is made by Microsoft

isPiped() - Method in class com.perforce.api.P4JNI

isValid() - Static method in class com.perforce.api.P4JNI

isWindows() - Static method in class com.perforce.api.Utils

Check to see if the current operating system is a Windows OS

J

Job - class com.perforce.api.Job.

Representation of a source control job.

Job() - Constructor for class com.perforce.api.Job

Default no-argument constructor.

Job(String) - Constructor for class com.perforce.api.Job

Constructor that accepts the job number.

JobField - class com.perforce.api.JobField.

Data class for p4 jobspec field information.

JobField() - Constructor for class com.perforce.api.JobField

JobField(int, String, int, int, int) - Constructor for class com.perforce.api.JobField

JobField(int, String, String, int, String) - Constructor for class com.perforce.api.JobField

L

Label - class com.perforce.api.Label.

Representation of a source control lablel.

Label() - Constructor for class com.perforce.api.Label

Default no-argument constructor.

Label(String) - Constructor for class com.perforce.api.Label

Constructor that is passed the label name.

LINE - Static variable in class com.perforce.api.JobField

Data type is a one-liner

loadBranches() - Static method in class com.perforce.api.Branch

Loads the list of branches using the default environment.

loadBranches(Env) - Static method in class com.perforce.api.Branch

Loads a list of all the branches into an internal class HashDecay.

loadClients() - Static method in class com.perforce.api.Client

Loads a list of all the clients into an internal class Hashtable.

loadClients(Env) - Static method in class com.perforce.api.Client

Loads a list of all the clients into an internal class Hashtable.

loadFields(Env, boolean) - Static method in class com.perforce.api.JobField

loadLabels() - Static method in class com.perforce.api.Label

Loads the list of labels using the default environment.

loadLabels(Env) - Static method in class com.perforce.api.Label

Loads a list of all the labels into an internal class HashDecay.

localizePath(String) - Static method in class com.perforce.api.FileEntry

Returns the path in local format.

LOG_NONE - Static variable in class com.perforce.api.Debug

Debugging output is discarded entirely.

LOG_ONLY - Static variable in class com.perforce.api.Debug

Debugging output is sent only to the EventLog.

LOG_SPLIT - Static variable in class com.perforce.api.Debug

Debugging output is sent to standard out and to the EventLog.

log(String) - Method in class com.perforce.api.EventLog

Logs an event to this log.

log(String, String) - Method in class com.perforce.api.EventLog

Logs an event to this log.

log(String, String, boolean) - Method in class com.perforce.api.EventLog

Logs an event to this log.

lookupBranches(String) - Static method in class com.perforce.api.Branch

Returns a list of branches that begin with the specified prefix.

lookupClient(Env, String) - Static method in class com.perforce.api.Client

Returns a list of clients that begin with the specified prefix.

lookupClient(String) - Static method in class com.perforce.api.Client

Returns a list of clients that begin with the specified prefix.

lookupLabels(String) - Static method in class com.perforce.api.Label

Returns a list of labels that begin with the specified prefix.

lookupMappings(HashDecay, String) - Static method in class com.perforce.api.Mapping

Returns a list of mappings that begin with the specified prefix.

M

main(String[]) - Static method in class com.perforce.api.P4JNI

Mapping - class com.perforce.api.Mapping.

Representation of a source control mapping.

Mapping() - Constructor for class com.perforce.api.Mapping

Default no-argument constructor.

Mapping(String) - Constructor for class com.perforce.api.Mapping

Constructor that is passed the mapping name.

MIN_DELAY - Static variable in class com.perforce.api.HashDecay

The minimum delay allowed

N

NONE - Static variable in class com.perforce.api.Debug

No debug messages are displayed.

NOTICE - Static variable in class com.perforce.api.Debug

Error, warning, and notice messages are displayed.

notify(String) - Static method in class com.perforce.api.Debug

Displays a notice message for debugging.

notify(String, String[]) - Static method in class com.perforce.api.Debug

Displays a notice message for debugging.

O

obtainLock() - Method in class com.perforce.api.FileEntry

Obtains the lock for this file.

ONCE - Static variable in class com.perforce.api.JobField

Field type has set once to the default and never changed

OPEN - Static variable in class com.perforce.api.Job

Indicates that the Job is open.

openForAdd() - Method in class com.perforce.api.FileEntry

Opens this file for addition.

openForAdd(Change) - Method in class com.perforce.api.FileEntry

Opens this file for addition.

openForAdd(Env, String, Change) - Static method in class com.perforce.api.FileEntry

Opens the file on the path for add under the change.

openForEdit() - Method in class com.perforce.api.FileEntry

Opens this file for edit.

openForEdit(boolean, boolean) - Method in class com.perforce.api.FileEntry

Opens this file for edit.

openForEdit(boolean, boolean, Change) - Method in class com.perforce.api.FileEntry

Opens this file for edit.

openForEdit(Env, String, boolean, boolean, boolean, Change) - Static method in class com.perforce.api.FileEntry

Opens the file on the path for edit under the change.

OPTIONAL - Static variable in class com.perforce.api.JobField

Field type has no default, not required to be present

out_read(char[], int, int) - Method in class com.perforce.api.P4JNI

out(int, String) - Static method in class com.perforce.api.Debug

Writes the message to the debugging output.

out(int, String, String[]) - Static method in class com.perforce.api.Debug

Writes the message and associated array of Strings to the debugging output.

out(int, Throwable) - Static method in class com.perforce.api.Debug

Writes the message associated with the Throwable to the debugging output.

out(String, int, Throwable) - Static method in class com.perforce.api.Debug

Writes the formatted message associated with the Throwable to the debugging output.

outClose() - Method in class com.perforce.api.P4Process

Flushes and closes the output stream to the process.

outOfSync(long) - Method in class com.perforce.api.SourceControlObject

Tests this object to see if it is out of sync.

outOfSync(long) - Method in interface com.perforce.api.Cacheable

Tests this object to see if it is out of sync.

P

P4JNI - class com.perforce.api.P4JNI.

This class handles the Java Native Interface to the P4 libraries.

P4JNI() - Constructor for class com.perforce.api.P4JNI

P4Process - class com.perforce.api.P4Process.

Handles the execution of all perforce commands.

P4Process() - Constructor for class com.perforce.api.P4Process

Default no-argument constructor.

P4Process(Env) - Constructor for class com.perforce.api.P4Process

Constructor that specifies the source control environment.

PENDING - Static variable in class com.perforce.api.Change

Indicates that the Change is pending submission.

PerforceException - exception com.perforce.api.PerforceException.

Signals that a general exception occurred when working with Perforce.

PerforceException(String) - Constructor for class com.perforce.api.PerforceException

print(String) - Method in class com.perforce.api.P4Process

Writes line to the standard input of the process.

println(String) - Method in class com.perforce.api.P4Process

Writes line to the standard input of the process.

printLog(EventLog, PrintWriter, String) - Static method in class com.perforce.api.EventLog

Prints a log, using the specified format.

printLog(PrintWriter, String) - Static method in class com.perforce.api.EventLog

Prints this log, using the specified format.

put(Object, Cacheable) - Method in class com.perforce.api.HashDecay

put(Object, Object) - Method in class com.perforce.api.HashDecay

R

readLine() - Method in class com.perforce.api.P4Process

Returns the next line from the process, or null if the command has completed its execution.

refreshUpdateTime() - Method in class com.perforce.api.SourceControlObject

Sets the update time for this object to the current time.

refreshUpdateTime() - Method in interface com.perforce.api.Cacheable

Sets the update time for this object to the current time.

removeFix(int) - Method in class com.perforce.api.Job

reopen(String, Change) - Method in class com.perforce.api.FileEntry

Reopens the file with the new type or in the new change list.

REQUIRED - Static variable in class com.perforce.api.JobField

Field type has default provided, value must be present

resolve(boolean) - Method in class com.perforce.api.Change

Resolves the files associated with this change.

resolve(boolean) - Method in class com.perforce.api.FileEntry

Resolves this file.

resolveAll(Env, String, String) - Static method in class com.perforce.api.FileEntry

Resolves all the files in the path.

resolveAT(Env, Enumeration) - Static method in class com.perforce.api.FileEntry

Forces a resolve on a set of files.

revert() - Method in class com.perforce.api.FileEntry

Reverts this file.

review() - Method in class com.perforce.api.Counter

Determine the changelists that need to be reviewed.

reviews() - Method in class com.perforce.api.Change

Determine the users that review this changelist.

run() - Method in class com.perforce.api.HashDecay

run() - Method in class com.perforce.api.P4JNI

runCommand(Object, String[], Env) - Method in class com.perforce.api.P4JNI

S

SELECT - Static variable in class com.perforce.api.JobField

Data type is one of a set of words

setBase(P4Process) - Static method in class com.perforce.api.P4Process

Sets the base process to be used when new processes are instantiated.

setClient(String) - Method in class com.perforce.api.Env

Sets the P4CLIENT in the class information.

setClientName(String) - Method in class com.perforce.api.Change

setClientPath(String) - Method in class com.perforce.api.FileEntry

Sets the client path for this file.

setCode(int) - Method in class com.perforce.api.JobField

setDataType(int) - Method in class com.perforce.api.JobField

setDataType(String) - Method in class com.perforce.api.JobField

setDebugLevel(int) - Static method in class com.perforce.api.Debug

Sets the debug level for the application.

setDelay(long) - Method in class com.perforce.api.HashDecay

Sets the delay, in milliseconds, before items in the hashtable are discarded.

setDepotPath(String) - Method in class com.perforce.api.FileEntry

Sets the depot path for this file.

setDescription(String) - Method in class com.perforce.api.Mapping

Sets the description for the Mapping.

setDescription(String) - Method in class com.perforce.api.Change

Sets the description for the change.

setDescription(String) - Method in class com.perforce.api.Job

Sets the description for the job.

setDescription(String) - Method in class com.perforce.api.FileEntry

Sets the decription for this file

setEmail(String) - Method in class com.perforce.api.User

Sets the e-mail address for this user.

setEnv(Env) - Method in class com.perforce.api.SourceControlObject

Sets the P4 environment to be used when working with this object.

setEnv(Env) - Method in class com.perforce.api.P4Process

Sets the environment to use.

setEventLog(EventLog) - Method in class com.perforce.api.P4Process

Sets the event log.

setEventLog(EventLog) - Static method in class com.perforce.api.Debug

Sets the EventLog that debugging output should be sent to.

setExecutable(String) - Method in class com.perforce.api.Env

Sets up the path to reach the p4 executable.

setField(String, String) - Method in class com.perforce.api.Job

setFieldType(int) - Method in class com.perforce.api.JobField

setFieldType(String) - Method in class com.perforce.api.JobField

setFromProperties(Properties) - Method in class com.perforce.api.Env

Uses a set of Properties to set up the environment.

setFullName(String) - Method in class com.perforce.api.User

Sets the full name of this user.

setHaveRev(int) - Method in class com.perforce.api.FileEntry

Sets the revision number the client has for this file.

setHeadAction(String) - Method in class com.perforce.api.FileEntry

Sets the head revision action for this file.

setHeadChange(int) - Method in class com.perforce.api.FileEntry

Sets the head revision change number for this file.

setHeadDate(String) - Method in class com.perforce.api.FileEntry

Sets the head date for this file.

setHeadRev(int) - Method in class com.perforce.api.FileEntry

Sets the head revision number for this file.

setHeadTime(long) - Method in class com.perforce.api.FileEntry

Sets the head revision time for this file.

setHeadType(String) - Method in class com.perforce.api.FileEntry

Sets the head revision type for this file.

setId(String) - Method in class com.perforce.api.User

Sets the id for this user.

setLength(int) - Method in class com.perforce.api.JobField

setLogLevel(int) - Static method in class com.perforce.api.Debug

Sets the logging level.

setLogLevel(String) - Static method in class com.perforce.api.Debug

Sets the logging level.

setModtimeString(String) - Method in class com.perforce.api.Change

setModtimeString(String) - Method in class com.perforce.api.Job

Sets the job's modification time

setName(String) - Method in class com.perforce.api.Mapping

Sets the name of the Mapping.

setName(String) - Method in class com.perforce.api.Counter

setName(String) - Method in class com.perforce.api.JobField

setName(String) - Method in class com.perforce.api.Job

Sets the job name for the Job.

setNumber(int) - Method in class com.perforce.api.Change

Sets the change number for the Change.

setOptions(String) - Method in class com.perforce.api.Client

Sets the options for the Client.

setOwner(String) - Method in class com.perforce.api.Mapping

Sets the owner of the Mapping.

setOwner(String) - Method in class com.perforce.api.FileEntry

Sets the owner for this file

setPassword(String) - Method in class com.perforce.api.Env

Sets the P4PASSWD in the class information.

setPath(String) - Method in class com.perforce.api.DirEntry

Sets the path for this directory.

setPath(String) - Method in class com.perforce.api.Env

Sets the PATH in the class information.

setPort(String) - Method in class com.perforce.api.Env

Sets the P4PORT in the class information.

setPreset(String) - Method in class com.perforce.api.JobField

setProperties(Properties) - Static method in class com.perforce.api.Debug

Sets the logging level from the supplied Properties.

setProperty(String, String) - Method in class com.perforce.api.Env

Calls the hashtable method put.

setRawMode(boolean) - Method in class com.perforce.api.P4Process

In raw mode, the process will return the prefix added by the "-s" command line option.

setRoot(String) - Method in class com.perforce.api.Client

Sets the root for the Client.

setServerTimeout(long) - Method in class com.perforce.api.P4Process

Set the server timeout threshold.

setServerTimeout(long) - Method in class com.perforce.api.Env

Set the server timeout threshold.

setShowThread(boolean) - Static method in class com.perforce.api.Debug

If set true, the thread number is included in all debugging output.

setSize(int) - Method in class com.perforce.api.EventLog

Sets the size of the log.

setSource(FileEntry) - Method in class com.perforce.api.FileEntry

Sets the source file entry associated with this file.

setStatus(int) - Method in class com.perforce.api.Change

Sets status for the Change.

setStatus(int) - Method in class com.perforce.api.Job

Sets status for the Job.

setStatus(String) - Method in class com.perforce.api.Job

Sets status for the Job.

setSystemDrive(String) - Method in class com.perforce.api.Env

Sets the SystemDrive in the class information.

setSystemRoot(String) - Method in class com.perforce.api.Env

Sets the SystemRoot in the class information.

setTitle(String) - Method in class com.perforce.api.EventLog

Sets the title for this log.

setUser(String) - Method in class com.perforce.api.Env

Sets the P4USER in the class information.

setUser(String) - Method in class com.perforce.api.Job

Sets the User that owns this Job.

setUser(User) - Method in class com.perforce.api.Change

Sets the User that owns this Change.

setValue(int) - Method in class com.perforce.api.Counter

Sets the value for the Counter.

SourceControlObject - class com.perforce.api.SourceControlObject.

An abstract base class for all source control objects.

SourceControlObject() - Constructor for class com.perforce.api.SourceControlObject

Default, no-argument constructor.

SourceControlObject(Env) - Constructor for class com.perforce.api.SourceControlObject

Constructor that takes an environment for this object to use.

start() - Method in class com.perforce.api.HashDecay

stop() - Method in class com.perforce.api.HashDecay

stopAll() - Static method in class com.perforce.api.HashDecay

Stops running threads for all HashDecay instances.

submit() - Method in class com.perforce.api.Change

Submits the change, if it is pending.

SubmitException - exception com.perforce.api.SubmitException.

Signals that an exception occurred during a submit to Perforce.

SubmitException(String) - Constructor for class com.perforce.api.SubmitException

SUBMITTED - Static variable in class com.perforce.api.Change

Indicates that the Change has been submitted.

SUSPENDED - Static variable in class com.perforce.api.Job

Indicates that the Job is suspended.

sync() - Method in class com.perforce.api.SourceControlObject

Brings this object back into sync with Perforce.

sync() - Method in class com.perforce.api.Client

sync() - Method in class com.perforce.api.DirEntry

Loads the directories and files for this directory.

sync() - Method in class com.perforce.api.Branch

sync() - Method in interface com.perforce.api.Cacheable

Brings this object back into sync with Perforce.

sync() - Method in class com.perforce.api.User

Synchronizes the user information with P4.

sync() - Method in class com.perforce.api.Counter

sync() - Method in class com.perforce.api.Label

sync() - Method in class com.perforce.api.Change

Synchronizes the Change with the correct information from P4, using whatever change number has already been set in the Change.

sync() - Method in class com.perforce.api.Job

Synchronizes the Job with the correct information from P4, using whatever job number has already been set in the Job.

sync() - Method in class com.perforce.api.FileEntry

sync(int) - Method in class com.perforce.api.Change

Sycnhronizes the Change with the correct information from P4.

sync(String) - Method in class com.perforce.api.Mapping

Synchronizes the Mapping with the latest information from P4.

sync(String) - Method in class com.perforce.api.Client

Synchronizes the Client with the latest information from P4.

sync(String) - Method in class com.perforce.api.Branch

Synchronizes the Branch with the latest information from P4.

sync(String) - Method in class com.perforce.api.User

Synchronizes the user information with P4.

sync(String) - Method in class com.perforce.api.Label

Synchronizes the Label with the latest information from P4.

sync(String) - Method in class com.perforce.api.Job

Sycnhronizes the Job with the correct information from P4.

syncWorkspace(Env, String) - Static method in class com.perforce.api.FileEntry

Synchronizes the workspace.

T

TEXT - Static variable in class com.perforce.api.JobField

Data type is a block of text

toString() - Method in class com.perforce.api.Mapping

toString() - Method in class com.perforce.api.User

toString() - Method in class com.perforce.api.P4Process

toString() - Method in class com.perforce.api.Env

toString() - Method in class com.perforce.api.Change

Overrides the default toString() method.

toString() - Method in class com.perforce.api.Job

Overrides the default toString() method.

toString() - Method in class com.perforce.api.FileEntry

toXML() - Method in class com.perforce.api.SourceControlObject

Returns a string containing the object in XML form.

toXML() - Method in class com.perforce.api.Mapping

toXML() - Method in class com.perforce.api.Client

toXML() - Method in class com.perforce.api.DirEntry

toXML() - Method in class com.perforce.api.Branch

toXML() - Method in class com.perforce.api.User

toXML() - Method in class com.perforce.api.Counter

toXML() - Method in class com.perforce.api.Env

Returns an XML representation of the environment.

toXML() - Method in class com.perforce.api.Label

toXML() - Method in class com.perforce.api.JobField

toXML() - Method in class com.perforce.api.Change

toXML() - Method in class com.perforce.api.Job

toXML() - Method in class com.perforce.api.FileEntry

U

User - class com.perforce.api.User.

Representation of a source control user.

User() - Constructor for class com.perforce.api.User

Default no-argument constructor.

User(String) - Constructor for class com.perforce.api.User

Constructor that accepts the id of the user.

Utils - class com.perforce.api.Utils.

Class that contains static utility methods.

Utils() - Constructor for class com.perforce.api.Utils

V

VERBOSE - Static variable in class com.perforce.api.Debug

Error, warning, notice, and verbose messages are displayed.

verbose(String) - Static method in class com.perforce.api.Debug

Displays a verbose message for debugging.

verbose(String, String[]) - Static method in class com.perforce.api.Debug

Displays a verbose message for debugging.

W

warn(String) - Static method in class com.perforce.api.Debug

Displays a warning message for debugging.

WARNING - Static variable in class com.perforce.api.Debug

Error and warning messages are displayed.

wildPathMatch(String, String) - Static method in class com.perforce.api.Utils

Returns true if the path matches the wildpath.

WORD - Static variable in class com.perforce.api.JobField

Data type is a single word (any value)

A B C D E F G H I J L M N O P R S T U V W