Class XWikiRCSArchive


  • public class XWikiRCSArchive
    extends org.suigeneris.jrcs.rcs.Archive
    Class for String [de]serialization for XWikiDocumentArchive.
    Since:
    1.2M1
    Version:
    $Id: 2f7039745f07e8557832d68b8293d537321bced3 $
    • Field Summary

      • Fields inherited from class org.suigeneris.jrcs.rcs.Archive

        branch, comment, desc, EXP_Binary, EXP_KeywordAndValue, EXP_KeywordOnly, EXP_KeywordValueAndLocker, EXP_PreserveOriginal, EXP_ValueOnly, expand, filename, head, locked, nodes, phrases, RCS_NEWLINE, RCS_NEWLINE_CHAR, strictLocking, symbols, users
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      Collection getNodes​(long docId)
      Deprecated.
      since 13.10.7, 14.4.1, 14.5, use getNodes(WikiReference, long) instead
      Collection getNodes​(WikiReference wikiReference, long docId)  
      String getRevisionAsString​(org.suigeneris.jrcs.rcs.Version version)  
      • Methods inherited from class org.suigeneris.jrcs.rcs.Archive

        addLock, addPhrase, addRevision, addRevision, addRevision, addSymbol, addSymbol, addUser, changeLog, changeLog, changeLog, doKeywords, findNode, getDesc, getExpand, getLog, getLog, getNode, getPhrases, getRevision, getRevision, getRevision, getRevision, getRevision, getRevision, getRevision, getRevision, getRevision, getRevisionPath, getRevisionVersion, getRevisionVersion, getRevisionVersion, getSymbols, isBinary, isValidSymbol, newBranchNode, newNode, newNode, newTrunkNode, quoteString, Remove, Remove, Remove, removeKeywords, save, save, setBranch, setBranch, setComment, setDesc, setExpand, setFileName, setHead, setStrictLocking, toByteArray, toCharArray, toString, toString, toString, toString, unquoteString, unquoteString, version
      • Methods inherited from class org.suigeneris.jrcs.util.ToString

        arrayToString, arrayToString, stringToArray, stringToArray, toString, toStringOfChars
    • Method Detail

      • getNodes

        @Deprecated(since="13.10.7")
        public Collection getNodes​(long docId)
                            throws org.suigeneris.jrcs.rcs.impl.NodeNotFoundException,
                                   org.suigeneris.jrcs.rcs.InvalidFileFormatException,
                                   org.suigeneris.jrcs.diff.PatchFailedException
        Deprecated.
        since 13.10.7, 14.4.1, 14.5, use getNodes(WikiReference, long) instead
        Parameters:
        docId - - docId which will be wrote in XWikiRCSNodeId.setDocId(long)
        Returns:
        Collection of pairs [XWikiRCSNodeInfo, XWikiRCSNodeContent]
        Throws:
        org.suigeneris.jrcs.diff.PatchFailedException
        org.suigeneris.jrcs.rcs.InvalidFileFormatException
        org.suigeneris.jrcs.rcs.impl.NodeNotFoundException
      • getNodes

        public Collection getNodes​(WikiReference wikiReference,
                                   long docId)
                            throws org.suigeneris.jrcs.rcs.impl.NodeNotFoundException,
                                   org.suigeneris.jrcs.rcs.InvalidFileFormatException,
                                   org.suigeneris.jrcs.diff.PatchFailedException
        Parameters:
        wikiReference - the wiki of the document
        docId - the local identifier of the document
        Returns:
        Collection of pairs [XWikiRCSNodeInfo, XWikiRCSNodeContent]
        Throws:
        org.suigeneris.jrcs.diff.PatchFailedException
        org.suigeneris.jrcs.rcs.InvalidFileFormatException
        org.suigeneris.jrcs.rcs.impl.NodeNotFoundException
        Since:
        13.10.7, 14.4.1, 14.5
      • getRevisionAsString

        public String getRevisionAsString​(org.suigeneris.jrcs.rcs.Version version)
                                   throws org.suigeneris.jrcs.rcs.impl.NodeNotFoundException,
                                          org.suigeneris.jrcs.rcs.InvalidFileFormatException,
                                          org.suigeneris.jrcs.diff.PatchFailedException
        Parameters:
        version - - the version number.
        Returns:
        The text of the revision if found.
        Throws:
        org.suigeneris.jrcs.rcs.impl.NodeNotFoundException - if the revision could not be found.
        org.suigeneris.jrcs.rcs.InvalidFileFormatException - if any of the deltas cannot be parsed.
        org.suigeneris.jrcs.diff.PatchFailedException - if any of the deltas could not be applied