Package org.apache.subversion.javahl.remote

Class StateReporter

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected RemoteSession session
      Stores a reference to the session that created this reporter.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected StateReporter​(long cppAddr, RemoteSession session)
      This constructor is called from the factory method.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void abortReport()
      If an error occurs during a report, this routine should cause the filesystem transaction to be aborted and cleaned up.
      void deletePath​(String path)
      Describe a working copy path as missing.
      void dispose()
      Release the native peer (should not depend on finalize), and abort the report if it has not been completed yet.
      void finalize()  
      long finishReport()
      The report driver calls this when the state report is finished.
      void linkPath​(String url, String path, long revision, Depth depth, boolean startEmpty, String lockToken)
      Like setPath(), but differs in that path in the working copy (relative to the root of the report driver) isn't a reflection of path in the repository (relative to the URL specified when opening the remote session), but is instead a reflection of a different repository url at revision, and has depth depth.
      void setPath​(String path, long revision, Depth depth, boolean startEmpty, String lockToken)
      Describe a working copy path as being at a particular revision and having the given depth.

    • Field Detail

      • session

        protected RemoteSession session
        Stores a reference to the session that created this reporter.

    • Constructor Detail

      • StateReporter

        protected StateReporter​(long cppAddr,
                        RemoteSession session)
        This constructor is called from the factory method.

    • Method Detail

      • dispose

        public void dispose()
        Description copied from interface: ISVNReporter
        Release the native peer (should not depend on finalize), and abort the report if it has not been completed yet.
        Specified by:
        dispose in interface ISVNReporter

      • setPath

        public void setPath​(String path,
                    long revision,
                    Depth depth,
                    boolean startEmpty,
                    String lockToken)
             throws ClientException
        Description copied from interface: ISVNReporter
        Describe a working copy path as being at a particular revision and having the given depth.

        revision may be Revision.SVN_INVALID_REVNUM if (for example) path represents a locally-added path with no revision number, or depth is Depth.exclude.

        path may not be underneath a path on which setPath() was previously called with Depth.exclude in this report.

        If startEmpty is set and path is a directory, the implementor should assume the directory has no entries or properties.

        This will override any previous setPath() calls made on parent paths. path is relative to the URL of the remote session that created this reporter instance.

        If lockToken is not null, it is the lock token for path in the working copy.

        Specified by:
        setPath in interface ISVNReporter
        Throws:
        ClientException

      • linkPath

        public void linkPath​(String url,
                     String path,
                     long revision,
                     Depth depth,
                     boolean startEmpty,
                     String lockToken)
              throws ClientException
        Description copied from interface: ISVNReporter
        Like setPath(), but differs in that path in the working copy (relative to the root of the report driver) isn't a reflection of path in the repository (relative to the URL specified when opening the remote session), but is instead a reflection of a different repository url at revision, and has depth depth.

        path may not be underneath a path on which setPath() was previously called with Depth.exclude in this report.

        If startEmpty is set and path is a directory, the implementor should assume the directory has no entries or properties.

        If lockToken is not null, it is the lock token for path in the working copy.

        Specified by:
        linkPath in interface ISVNReporter
        Throws:
        ClientException

      • abortReport

        public void abortReport()
                 throws ClientException
        Description copied from interface: ISVNReporter
        If an error occurs during a report, this routine should cause the filesystem transaction to be aborted and cleaned up. No other reporting functions should be called after calling this function.
        Specified by:
        abortReport in interface ISVNReporter
        Throws:
        ClientException