ch.systemsx.cisd.openbis.dss.generic.shared.api.v1
Class FileInfoDssDTO

java.lang.Object
  extended by ch.systemsx.cisd.openbis.dss.generic.shared.api.v1.FileInfoDssDTO
All Implemented Interfaces:
java.io.Serializable

@JsonObject(value="FileInfoDssDTO")
public class FileInfoDssDTO
extends java.lang.Object
implements java.io.Serializable

Represents information about a file stored in DSS.

See Also:
Serialized Form

Constructor Summary
FileInfoDssDTO(java.lang.String pathInDataSet, java.lang.String pathInListing, boolean isDirectory, long fileSize)
           
 
Method Summary
 long getFileSize()
          Return the file size if this FileInfo represents a file.
 java.lang.String getPathInDataSet()
          The path of this file in the data set (i.e., the root of the data set has a path of "").
 java.lang.String getPathInListing()
          The path of this file relative to the path of the request that produced this FileInfoDss
 boolean isDirectory()
          Return true if this FileInfo represents a folder.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FileInfoDssDTO

public FileInfoDssDTO(java.lang.String pathInDataSet,
                      java.lang.String pathInListing,
                      boolean isDirectory,
                      long fileSize)
Method Detail

getPathInDataSet

public java.lang.String getPathInDataSet()
The path of this file in the data set (i.e., the root of the data set has a path of "").


getPathInListing

public java.lang.String getPathInListing()
The path of this file relative to the path of the request that produced this FileInfoDss


isDirectory

public boolean isDirectory()
Return true if this FileInfo represents a folder.


getFileSize

public long getFileSize()
Return the file size if this FileInfo represents a file. If this FileInfo represents a folder, the return value is negative.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object