Package jline.console.history

Class MemoryHistory

    • Nested Class Summary

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DEFAULT_MAX_SIZE  

    • Constructor Summary

      Constructors 
      Constructor Description
      MemoryHistory()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(java.lang.CharSequence item)  
      void clear()  
      java.lang.CharSequence current()
      Return the content of the current buffer.
      java.util.ListIterator<History.Entry> entries()  
      java.util.ListIterator<History.Entry> entries​(int index)  
      java.lang.CharSequence get​(int index)  
      int getMaxSize()  
      int index()  
      protected void internalAdd​(java.lang.CharSequence item)  
      boolean isAutoTrim()  
      boolean isEmpty()  
      boolean isIgnoreDuplicates()  
      java.util.Iterator<History.Entry> iterator()  
      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.
      java.lang.CharSequence remove​(int i)
      Remove the history element at the given index.
      java.lang.CharSequence removeFirst()
      Remove the first element from history.
      java.lang.CharSequence removeLast()
      Remove the last element from history
      void replace​(java.lang.CharSequence item)  
      void set​(int index, java.lang.CharSequence item)
      Set the history item at the given index to the given CharSequence.
      void setAutoTrim​(boolean flag)  
      void setIgnoreDuplicates​(boolean flag)  
      void setMaxSize​(int maxSize)  
      int size()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Constructor Detail

      • MemoryHistory

        public MemoryHistory()

    • Method Detail

      • setMaxSize

        public void setMaxSize​(int maxSize)

      • getMaxSize

        public int getMaxSize()

      • isIgnoreDuplicates

        public boolean isIgnoreDuplicates()

      • setIgnoreDuplicates

        public void setIgnoreDuplicates​(boolean flag)

      • isAutoTrim

        public boolean isAutoTrim()

      • setAutoTrim

        public void setAutoTrim​(boolean flag)

      • size

        public int size()
        Specified by:
        size in interface History

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface History

      • index

        public int index()
        Specified by:
        index in interface History

      • clear

        public void clear()
        Specified by:
        clear in interface History

      • get

        public java.lang.CharSequence get​(int index)
        Specified by:
        get in interface History

      • set

        public void set​(int index,
                java.lang.CharSequence item)
        Description copied from interface: History
        Set the history item at the given index to the given CharSequence.
        Specified by:
        set in interface History
        Parameters:
        index - the index of the history offset
        item - the new item

      • add

        public void add​(java.lang.CharSequence item)
        Specified by:
        add in interface History

      • remove

        public java.lang.CharSequence remove​(int i)
        Description copied from interface: History
        Remove the history element at the given index.
        Specified by:
        remove in interface History
        Parameters:
        i - the index of the element to remove
        Returns:
        the removed element

      • removeFirst

        public java.lang.CharSequence removeFirst()
        Description copied from interface: History
        Remove the first element from history.
        Specified by:
        removeFirst in interface History
        Returns:
        the removed element

      • removeLast

        public java.lang.CharSequence removeLast()
        Description copied from interface: History
        Remove the last element from history
        Specified by:
        removeLast in interface History
        Returns:
        the removed element

      • internalAdd

        protected void internalAdd​(java.lang.CharSequence item)

      • replace

        public void replace​(java.lang.CharSequence item)
        Specified by:
        replace in interface History

      • moveToLast

        public boolean moveToLast()
        This moves the history to the last entry. This entry is one position before the moveToEnd() position.
        Specified by:
        moveToLast in interface History
        Returns:
        Returns false if there were no history entries or the history index was already at the last entry.

      • moveTo

        public boolean moveTo​(int index)
        Move to the specified index in the history
        Specified by:
        moveTo in interface History

      • moveToFirst

        public boolean moveToFirst()
        Moves the history index to the first entry.
        Specified by:
        moveToFirst in interface History
        Returns:
        Return false if there are no entries in the history or if the history is already at the beginning.

      • moveToEnd

        public void moveToEnd()
        Move to the end of the history buffer. This will be a blank entry, after all of the other entries.
        Specified by:
        moveToEnd in interface History

      • current

        public java.lang.CharSequence current()
        Return the content of the current buffer.
        Specified by:
        current in interface History

      • previous

        public boolean previous()
        Move the pointer to the previous element in the buffer.
        Specified by:
        previous in interface History
        Returns:
        true if we successfully went to the previous element

      • next

        public boolean next()
        Move the pointer to the next element in the buffer.
        Specified by:
        next in interface History
        Returns:
        true if we successfully went to the next element

      • toString

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