|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.perforce.api.SourceControlObject
An abstract base class for all source control objects.
Constructor Summary | |
SourceControlObject()
Default, no-argument constructor. |
|
SourceControlObject(Env env)
Constructor that takes an environment for this object to use. |
Method Summary | |
void |
clearCache()
Removes any cached objects. |
abstract void |
commit()
Stores this object back into Perforce, creating it if it didn't already exist. |
abstract HashDecay |
getCache()
Returns the HashDecay instance for this class |
Env |
getEnv()
Returns the P4 environment associated with this instance. |
long |
getSyncTime()
Returns the time, in milliseconds, that this object was synchronized. |
long |
getUpdateTime()
Returns the time, in milliseconds, for this object's last update. |
void |
inSync()
Marks this object as being in in sync or valid. |
void |
invalidate()
Invalidates this object. |
boolean |
outOfSync(long threshold)
Tests this object to see if it is out of sync. |
void |
refreshUpdateTime()
Sets the update time for this object to the current time. |
void |
setEnv(Env env)
Sets the P4 environment to be used when working with this object. |
abstract void |
sync()
Brings this object back into sync with Perforce. |
abstract String |
toXML()
Returns a string containing the object in XML form. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SourceControlObject()
public SourceControlObject(Env env)
env
- source control environement to use.Method Detail |
public void clearCache()
clearCache
in interface Cacheable
public abstract void commit() throws CommitException
commit
in interface Cacheable
public abstract HashDecay getCache()
getCache
in interface Cacheable
public Env getEnv()
public long getSyncTime()
getSyncTime
in interface Cacheable
public long getUpdateTime()
getUpdateTime
in interface Cacheable
public void inSync()
inSync
in interface Cacheable
public void invalidate()
invalidate
in interface Cacheable
public boolean outOfSync(long threshold)
outOfSync
in interface Cacheable
threshold
- Number of milliseconds.public void refreshUpdateTime()
refreshUpdateTime
in interface Cacheable
public void setEnv(Env env)
env
- user environment to use.Env
,
P4Process
public abstract void sync() throws PerforceException
sync
in interface Cacheable
public abstract String toXML()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |