|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.perforce.api.SourceControlObject com.perforce.api.DirEntry
public final class DirEntry
Representation of a source control directory.
Constructor Summary | |
---|---|
DirEntry()
Default, no-argument constructor. |
|
DirEntry(DirEntry base,
String path)
Constructs a directory entry. |
|
DirEntry(Env e)
Constructs a directory entry. |
|
DirEntry(Env e,
String path)
Constructs a directory entry. |
Method Summary | |
---|---|
void |
commit()
Does nothing. |
String |
getBasePath()
Returns the base path for this directory. |
HashDecay |
getCache()
Returns the HashDecay instance for this class |
static DirEntry |
getDirEntry(Env env,
String path,
boolean sync)
Returns a directory entry for the supplied path. |
String[] |
getDirNames()
Returns an array of directory names. |
String[] |
getDirNames(Env env)
Returns an array of directory names. |
String[] |
getFileNames()
Returns an array of file names for this directory. |
String[] |
getFileNames(Env env)
Returns an array of file names for this directory. |
FileEntry[] |
getFiles()
Returns an array of file entries for this directory. |
FileEntry[] |
getFiles(Env env)
Returns an array of file entries for this directory. |
DirEntry |
getParent()
Returns the parent director. |
String |
getPath()
Returns the path for this directory. |
void |
setPath(String path)
Sets the path for this directory. |
void |
sync()
Loads the directories and files for this directory. |
String |
toXML()
Returns a string containing the object in XML form. |
Methods inherited from class com.perforce.api.SourceControlObject |
---|
clearCache, getEnv, getSyncTime, getUpdateTime, inSync, invalidate, outOfSync, refreshUpdateTime, setEnv |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DirEntry()
public DirEntry(DirEntry base, String path)
base
- Another DirEntry
used to set the environment.path
- The path for this directory.public DirEntry(Env e)
e
- Source control environment to use.public DirEntry(Env e, String path)
e
- Source control environment to use.path
- The path for this directory.Method Detail |
---|
public void commit()
commit
in interface Cacheable
commit
in class SourceControlObject
public String getBasePath()
public HashDecay getCache()
SourceControlObject
getCache
in interface Cacheable
getCache
in class SourceControlObject
public static DirEntry getDirEntry(Env env, String path, boolean sync)
env
- Source control environment to use.path
- The path for this directory.sync
- Forces the directory information to be current.public String[] getDirNames()
public String[] getDirNames(Env env)
env
- Source control environment to use.public String[] getFileNames()
public String[] getFileNames(Env env)
env
- Source control environment to use.public FileEntry[] getFiles()
public FileEntry[] getFiles(Env env)
env
- Source control environment to use.public DirEntry getParent()
DirEntry
that
represents the parent and returns it.
public String getPath()
public void setPath(String path)
path
- New path for this directory.public void sync()
sync
in interface Cacheable
sync
in class SourceControlObject
public String toXML()
SourceControlObject
toXML
in class SourceControlObject
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |