Class FileSpecification

  • All Implemented Interfaces:
    java.io.Serializable

    public class FileSpecification
    extends java.lang.Object
    implements java.io.Serializable
    The class that represents the specification of a file or a folder. For a file, version can be specified. The default version is null which represents the latest version.
    Since:
    2.4
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      FileSpecification​(java.lang.String path)
      Constructor.
      FileSpecification​(java.lang.String path, java.lang.String version)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getPath()
      Gets the path to the file or folder.
      java.lang.String getVersion()
      Gets the version of the file.
      int hashCode()  
      void setPath​(java.lang.String path)
      Sets the path to the file or folder.
      void setVersion​(java.lang.String version)
      Sets the version of the file.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • FileSpecification

        public FileSpecification​(java.lang.String path)
        Constructor.
        Parameters:
        path - The path to the file or folder.
      • FileSpecification

        public FileSpecification​(java.lang.String path,
                                 java.lang.String version)
        Constructor.
        Parameters:
        path - The path to the file or folder.
        version - The version of the file. Specifying null indicates the latest version.
    • Method Detail

      • getPath

        public java.lang.String getPath()
        Gets the path to the file or folder.
        Returns:
        The path to the file or folder.
      • setPath

        public void setPath​(java.lang.String path)
        Sets the path to the file or folder.
        Parameters:
        path - The path to the file or folder.
      • getVersion

        public java.lang.String getVersion()
        Gets the version of the file. Null indicates the latest version.
        Returns:
        The version of the file.
      • setVersion

        public void setVersion​(java.lang.String version)
        Sets the version of the file. Null indicates the latest version.
        Parameters:
        version - The version of the file.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

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