|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.io.File | +--com.enderak.procol.common.model.ProColFile
A file for use with ProCol
Field Summary |
Fields inherited from class java.io.File |
pathSeparator, pathSeparatorChar, separator, separatorChar |
Constructor Summary | |
ProColFile(java.lang.String pathname)
Creates a new ProColFile with the specified pathname |
|
ProColFile(java.lang.String pathname,
java.lang.String filename)
Creates a new ProColFile with the specified pathname and filename |
|
ProColFile(java.net.URI uri)
Creates a new ProColFile with the specified URI |
Method Summary | |
boolean |
checkIn(java.lang.String userIn)
Checks in a file |
boolean |
checkOut(java.lang.String userIn)
Checks out the file |
boolean |
createNewVersion(java.lang.String newVersion,
java.lang.String newChangeLog,
java.lang.String userNameIn)
Creates a new version of the file |
java.lang.String |
getFileInfo(java.net.URI relativeRoot)
Returns this file info |
java.lang.String |
getOwner()
Gets the current owner of the file |
java.lang.String |
getVersion()
Gets the current version of the file as a String |
int[] |
getVersionAsArray()
Gets the current version of the file as an int array |
java.io.File |
getVersionsFile()
Gets the versions File |
java.net.URI |
getVersionsURI()
Gets the versions URI |
boolean |
isCheckedOut()
Get the checked-out status of the file |
boolean |
isCheckedOutBy(java.lang.String userName)
Check if the file is checked out by a specific user |
ProColFile[] |
listProColFiles()
Gets all child files as a ProColFile[] array |
boolean |
setOwner(java.lang.String ownerIn)
Sets the owner of this file |
void |
setVersion(java.lang.String versionIn)
Sets the current version of the file |
void |
setVersionsFile(java.net.URI versionsURI)
Sets the file where version information is kept |
java.lang.String |
toString()
Get this file as a printable String |
Methods inherited from class java.io.File |
canRead, canWrite, compareTo, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getName, getParent, getParentFile, getPath, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setLastModified, setReadOnly, toURI, toURL |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ProColFile(java.lang.String pathname)
pathname
- The pathname to the file on diskpublic ProColFile(java.lang.String pathname, java.lang.String filename)
pathname
- The pathname to the file on diskfilename
- The filename of the file on diskpublic ProColFile(java.net.URI uri)
uri
- URI to the fileMethod Detail |
public void setVersionsFile(java.net.URI versionsURI)
versionsURI
- The URI to the versions filepublic java.net.URI getVersionsURI()
public java.io.File getVersionsFile()
public boolean checkOut(java.lang.String userIn)
userIn
- The user checking out the file
public boolean checkIn(java.lang.String userIn)
userIn
- The user checking in the file
public java.lang.String getOwner()
public java.lang.String getVersion()
public int[] getVersionAsArray()
public void setVersion(java.lang.String versionIn)
versionIn
- The new version stringpublic boolean createNewVersion(java.lang.String newVersion, java.lang.String newChangeLog, java.lang.String userNameIn)
newVersion
- The new version stringnewChangeLog
- The new changeloguserNameIn
- The updating user
public boolean setOwner(java.lang.String ownerIn)
ownerIn
-
public boolean isCheckedOut()
public boolean isCheckedOutBy(java.lang.String userName)
userName
- the user's name
public java.lang.String toString()
toString
in class java.io.File
public java.lang.String getFileInfo(java.net.URI relativeRoot)
relativeRoot
- The root of this file to reletiveize from
public ProColFile[] listProColFiles()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |