Interface History

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static interface  History.Entry  
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default void add​(java.lang.String line)  
      void add​(java.time.Instant time, java.lang.String line)  
      void append​(java.nio.file.Path file, boolean incremental)
      Append history to the file.
      void attach​(LineReader reader)
      Initialize the history for the given reader.
      java.lang.String current()
      Return the content of the current buffer.
      int first()  
      java.lang.String get​(int index)  
      int index()  
      default boolean isEmpty()  
      default boolean isPersistable​(History.Entry entry)
      Check if an entry should be persisted or not.
      default java.util.ListIterator<History.Entry> iterator()  
      java.util.ListIterator<History.Entry> iterator​(int index)  
      int last()  
      void load()
      Load history.
      boolean moveTo​(int index)
      Move to the specified index in the history
      void moveToEnd()
      Move to the end of the history buffer.
      boolean moveToFirst()
      Moves the history index to the first entry.
      boolean moveToLast()
      This moves the history to the last entry.
      boolean next()
      Move the pointer to the next element in the buffer.
      boolean previous()
      Move the pointer to the previous element in the buffer.
      void purge()
      Purge history.
      void read​(java.nio.file.Path file, boolean checkDuplicates)
      Read history from the file.
      void resetIndex()
      Reset index after remove
      default java.util.Iterator<History.Entry> reverseIterator()  
      default java.util.Iterator<History.Entry> reverseIterator​(int index)  
      void save()
      Save history.
      int size()  
      void write​(java.nio.file.Path file, boolean incremental)
      Write history to the file.
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
    • Method Detail

      • attach

        void attach​(LineReader reader)
        Initialize the history for the given reader.
        Parameters:
        reader - the reader to attach to
      • load

        void load()
           throws java.io.IOException
        Load history.
        Throws:
        java.io.IOException - if a problem occurs
      • save

        void save()
           throws java.io.IOException
        Save history.
        Throws:
        java.io.IOException - if a problem occurs
      • write

        void write​(java.nio.file.Path file,
                   boolean incremental)
            throws java.io.IOException
        Write history to the file. If incremental only the events that are new since the last incremental operation to the file are added.
        Parameters:
        file - History file
        incremental - If true incremental write operation is performed.
        Throws:
        java.io.IOException - if a problem occurs
      • append

        void append​(java.nio.file.Path file,
                    boolean incremental)
             throws java.io.IOException
        Append history to the file. If incremental only the events that are new since the last incremental operation to the file are added.
        Parameters:
        file - History file
        incremental - If true incremental append operation is performed.
        Throws:
        java.io.IOException - if a problem occurs
      • read

        void read​(java.nio.file.Path file,
                  boolean checkDuplicates)
           throws java.io.IOException
        Read history from the file. If checkDuplicates is true only the events that are not contained within the internal list are added.
        Parameters:
        file - History file
        checkDuplicates - If true, duplicate history entries will be discarded
        Throws:
        java.io.IOException - if a problem occurs
      • purge

        void purge()
            throws java.io.IOException
        Purge history.
        Throws:
        java.io.IOException - if a problem occurs
      • size

        int size()
      • isEmpty

        default boolean isEmpty()
      • index

        int index()
      • first

        int first()
      • last

        int last()
      • get

        java.lang.String get​(int index)
      • add

        default void add​(java.lang.String line)
      • add

        void add​(java.time.Instant time,
                 java.lang.String line)
      • isPersistable

        default boolean isPersistable​(History.Entry entry)
        Check if an entry should be persisted or not.
        Parameters:
        entry - the entry to check
        Returns:
        true if the given entry should be persisted, false otherwise
      • iterator

        java.util.ListIterator<History.Entry> iterator​(int index)
      • iterator

        default java.util.ListIterator<History.Entry> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<History.Entry>
      • reverseIterator

        default java.util.Iterator<History.Entry> reverseIterator()
      • reverseIterator

        default java.util.Iterator<History.Entry> reverseIterator​(int index)
      • current

        java.lang.String current()
        Return the content of the current buffer.
        Returns:
        the content of the current buffer
      • previous

        boolean previous()
        Move the pointer to the previous element in the buffer.
        Returns:
        true if we successfully went to the previous element
      • next

        boolean next()
        Move the pointer to the next element in the buffer.
        Returns:
        true if we successfully went to the next element
      • moveToFirst

        boolean moveToFirst()
        Moves the history index to the first entry.
        Returns:
        Return false if there are no iterator in the history or if the history is already at the beginning.
      • moveToLast

        boolean moveToLast()
        This moves the history to the last entry. This entry is one position before the moveToEnd() position.
        Returns:
        Returns false if there were no history iterator or the history index was already at the last entry.
      • moveTo

        boolean moveTo​(int index)
        Move to the specified index in the history
        Parameters:
        index - The index to move to.
        Returns:
        Returns true if the index was moved.
      • moveToEnd

        void moveToEnd()
        Move to the end of the history buffer. This will be a blank entry, after all of the other iterator.
      • resetIndex

        void resetIndex()
        Reset index after remove