Package de.espirit.firstspirit.storage

Interface Revision

All Superinterfaces:
Comparable<Revision>, Serializable
public interface Revision extends Serializable, Comparable<Revision>
Definition of a container providing information about a revision.
Since:
4.0.47

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getComment()
    Returns the comment of this revision.
    long
    getCommitOrCreationTime()
    Returns the time of commit or the creation time if the revision is not commited yet.
    long
    getCreationTime()
    Returns the time of creation of this revision
    String
    getEditor()
    Returns the editor string of this revision in the format 'EDITOR_NAME [ID=123]'
    long
    getEditorId()
    Returns the user id of the editor of this revision or -1 if the id is missing in the editor string
    long
    getId()
    Returns the revision id of this revision.
    RevisionMetaData
    getMetaData()
    Returns the metadata of this revision.
    de.espirit.storage.Revision.State
    getState()
    Returns the current state of this revision.
    List<Tag>
    getTags()
    Return list of all tags for this revision.

    Methods inherited from interface java.lang.Comparable

    compareTo

  • Method Details

    • getId

      long getId()
      Returns the revision id of this revision.
      Since:
      4.0.47

    • getComment

      String getComment()
      Returns the comment of this revision. This can be a editor specific comment or an system specific comment, dependent on the project comment mode settings
      Returns:
      the comment of this revision
      Since:
      4.0.47
      See Also:

    • getEditor

      String getEditor()
      Returns the editor string of this revision in the format 'EDITOR_NAME [ID=123]'
      Since:
      4.0.47

    • getEditorId

      long getEditorId()
      Returns the user id of the editor of this revision or -1 if the id is missing in the editor string
      Returns:
      the user id of the editor or -1 if no id was set
      Since:
      4.0.47
      See Also:

    • getState

      @NotNull de.espirit.storage.Revision.State getState()
      Returns the current state of this revision.
      Since:
      4.0.47

    • getCreationTime

      long getCreationTime()
      Returns the time of creation of this revision
      Since:
      4.0.47
      See Also:

    • getCommitOrCreationTime

      long getCommitOrCreationTime()
      Returns the time of commit or the creation time if the revision is not commited yet.
      Since:
      4.0.47
      See Also:

    • getMetaData

      RevisionMetaData getMetaData() throws IOException
      Returns the metadata of this revision.
      Throws:
      IOException
      Since:
      4.0.47

    • getTags

      List<Tag> getTags() throws IOException
      Return list of all tags for this revision.
      Throws:
      IOException
      Since:
      4.2.400