Package org.irods.irods4j.high_level.vfs

Class CollectionEntry

java.lang.Object
org.irods.irods4j.high_level.vfs.CollectionEntry
All Implemented Interfaces:
Comparable<CollectionEntry>
public class CollectionEntry extends Object implements Comparable<CollectionEntry>
Holds information about a single logical path inside a collection.
Since:
0.1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(CollectionEntry o)
    Compares this collection entry with another using the logical path.
    long
    createdAt()
    Returns the epoch seconds representing the time the filesystem object was created.
    int
    dataMode()
    Returns the data mode of the filesystem object.
    long
    dataSize()
    Returns the size of the filesystem object.
    String
    dataType()
    Returns the data type describing the filesystem object, if available.
    boolean
    exists()
    Returns true if the path points to a valid filesystem object.
    String
    id()
    Returns the ID of the filesystem object.
    boolean
    isCollection()
    Checks whether the logical path identifies a collection.
    boolean
    isDataObject()
    Checks whether the logical path identifies a data object.
    boolean
    isOther()
    Checks whether the logical path identifies something that is not a data object or collection.
    long
    modifiedAt()
    Returns the epoch seconds representing the last modification time of the filesystem object.
    String
    path()
    Returns the logical path which identifies the filesystem object.
    ObjectStatus
    status()
    Returns the status information of the filesystem object.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • path

      public String path()
      Returns the logical path which identifies the filesystem object.
      Since:
      0.1.0

    • exists

      public boolean exists()
      Returns true if the path points to a valid filesystem object.
      Since:
      0.1.0

    • isDataObject

      public boolean isDataObject()
      Checks whether the logical path identifies a data object.
      Since:
      0.1.0

    • isCollection

      public boolean isCollection()
      Checks whether the logical path identifies a collection.
      Since:
      0.1.0

    • isOther

      public boolean isOther()
      Checks whether the logical path identifies something that is not a data object or collection.
      Since:
      0.1.0

    • createdAt

      public long createdAt()
      Returns the epoch seconds representing the time the filesystem object was created.
      Since:
      0.1.0

    • modifiedAt

      public long modifiedAt()
      Returns the epoch seconds representing the last modification time of the filesystem object. Changes to the modification time following this operation will not be reflected by this method.
      Since:
      0.1.0

    • status

      public ObjectStatus status()
      Returns the status information of the filesystem object.
      Since:
      0.1.0

    • dataMode

      public int dataMode()
      Returns the data mode of the filesystem object.
      Since:
      0.1.0

    • id

      public String id()
      Returns the ID of the filesystem object.
      Since:
      0.1.0

    • dataType

      public String dataType()
      Returns the data type describing the filesystem object, if available.
      Since:
      0.1.0

    • dataSize

      public long dataSize()
      Returns the size of the filesystem object.
      Since:
      0.1.0

    • compareTo

      public int compareTo(CollectionEntry o)
      Compares this collection entry with another using the logical path.
      Specified by:
      compareTo in interface Comparable<CollectionEntry>
      Since:
      0.1.0