org.kohsuke.jnt
Class JNFile

java.lang.Object
  extended by org.kohsuke.jnt.JNFile

public final class JNFile
extends Object

File in the documents & files section.

Author:
Kohsuke Kawaguchi, Bruno Souza

Method Summary
 void delete()
          Removes this file.
 boolean equals(Object o)
           
 String getDescription()
          A human-readable description of this file.
 JNFileFolder getFolder()
          Gets the folder to which this file belongs.
 int getId()
          Gets the unique ID that distinguishes this document.
 Date getLastModified()
          The timestamp when this file was modifieid.
 JNUser getModifiedBy()
          The person who modified this file.
 String getName()
          The name of the file.
 FileStatus getStatus()
          File status.
 URL getURL()
          The location of the file.
 int hashCode()
           
 void moveTo(JNFileFolder newFolder)
          Move this file to another folder
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getFolder

public JNFileFolder getFolder()
Gets the folder to which this file belongs.

Returns:
never be null.

getName

public String getName()
The name of the file.

Returns:
never be null.

getURL

public URL getURL()
The location of the file.

Returns:
never be null.

getStatus

public FileStatus getStatus()
File status.

Returns:
never be null.

getModifiedBy

public JNUser getModifiedBy()
The person who modified this file.

Returns:
never be null.

getLastModified

public Date getLastModified()
The timestamp when this file was modifieid.

Returns:
never be null.

getDescription

public String getDescription()
A human-readable description of this file.

Returns:
never be null.

getId

public int getId()
Gets the unique ID that distinguishes this document.

It's not clear to me whether the scope of the uniqueness is within a project or the whole java.net. I suspect the latter.


delete

public void delete()
            throws ProcessingException
Removes this file.

Throws:
ProcessingException

moveTo

public void moveTo(JNFileFolder newFolder)
            throws ProcessingException
Move this file to another folder

Throws:
ProcessingException

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object


Copyright © 2003-2010 Kohsuke Kawaguchi. All Rights Reserved.