Module MaterialFX

Package io.github.palexdev.materialfx.collections

Class ObservableStack<E>

java.lang.Object

javafx.beans.binding.ListExpression<E>

javafx.beans.property.ReadOnlyListProperty<E>

javafx.beans.property.ListProperty<E>

javafx.beans.property.ListPropertyBase<E>

javafx.beans.property.SimpleListProperty<E>

io.github.palexdev.materialfx.collections.ObservableStack<E>

Type Parameters:

E - Any type

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>, Observable, Property<ObservableList<E>>, ReadOnlyProperty<ObservableList<E>>, ObservableListValue<E>, ObservableObjectValue<ObservableList<E>>, ObservableValue<ObservableList<E>>, WritableListValue<E>, WritableObjectValue<ObservableList<E>>, WritableValue<ObservableList<E>>, ObservableList<E>

public class ObservableStack<E>
extends SimpleListProperty<E>

A crude implementation of an observable stack It includes the main features of a stack namely: push and pop.

Property Summary

Properties inherited from class javafx.beans.property.ListPropertyBase

empty, size

Constructor Summary

Constructors

Constructor	Description
ObservableStack()

Method Summary

Modifier and Type	Method	Description
void	add(int i, E element)	Adds an element to the given index
boolean	add(E element)	Pushes the element to the top of the stack
boolean	addAll(int i, Collection<? extends E> elements)
boolean	addAll(E... elements)	Adds the contents of the array into the stack
boolean	addAll(Collection<? extends E> elements)	Adds the elements from the collection into the stack in the order they are specified
E	pop()
E	push(E item)	Places the item at the top of the stack
E	remove(int i)	Removes an element at the given index
void	remove(int from, int to)	Attempt to remove a range of objects from the stack, this is also not permitted
boolean	remove(Object obj)	Attempt to remove an arbitrary object from the stack is not permitted
boolean	removeAll()	Effectively empties the stack given that the stack is not already empty
boolean	removeAll(E... elements)
boolean	removeAll(Collection<?> objects)

Methods inherited from class javafx.beans.property.SimpleListProperty

getBean, getName

Methods inherited from class javafx.beans.property.ListPropertyBase

addListener, addListener, addListener, bind, emptyProperty, fireValueChangedEvent, fireValueChangedEvent, get, invalidated, isBound, removeListener, removeListener, removeListener, set, sizeProperty, toString, unbind

Methods inherited from class javafx.beans.property.ListProperty

bindBidirectional, setValue, unbindBidirectional

Methods inherited from class javafx.beans.property.ReadOnlyListProperty

bindContent, bindContentBidirectional, equals, hashCode, unbindContent, unbindContentBidirectional

Methods inherited from class javafx.beans.binding.ListExpression

asString, clear, contains, containsAll, get, getSize, getValue, indexOf, isEmpty, isEqualTo, isNotEqualTo, isNotNull, isNull, iterator, lastIndexOf, listExpression, listIterator, listIterator, retainAll, retainAll, set, setAll, setAll, size, subList, toArray, toArray, valueAt, valueAt

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface javafx.collections.ObservableList

filtered, retainAll, setAll, setAll, sorted, sorted

Methods inherited from interface javafx.beans.value.ObservableValue

getValue

Methods inherited from interface javafx.beans.value.WritableValue

getValue

Constructor Details

ObservableStack

public ObservableStack()

Method Details

push

public E push(E item)

Places the item at the top of the stack

Parameters:

item - the item

Returns:

the item that was just pushed

pop

public E pop()
      throws NoSuchElementException

Returns:

the item at the top of the stack granted that the stack is not empty

Throws:

NoSuchElementException - if the stack is empty

add

public boolean add(E element)

Pushes the element to the top of the stack

Specified by:

add in interface Collection<E>

Specified by:

add in interface List<E>

Overrides:

add in class ListExpression<E>

Parameters:

element - the element to add

Returns:

Always returns true

See Also:

• push(Object)

remove

public E remove(int i)
         throws IllegalArgumentException

Removes an element at the given index

Specified by:

remove in interface List<E>

Overrides:

remove in class ListExpression<E>

Parameters:

i - the index to remove from

Returns:

The element that was removed

Throws:

IllegalArgumentException - if i is not 0. The stack can only access the top element

See Also:

• pop()

removeAll

public boolean removeAll()
                  throws NoSuchElementException

Effectively empties the stack given that the stack is not already empty

Returns:

true if the stack was emptied

Throws:

NoSuchElementException - if the stack is already empty

add

public void add(int i,
 E element)
         throws IllegalArgumentException

Adds an element to the given index

Specified by:

add in interface List<E>

Overrides:

add in class ListExpression<E>

Parameters:

i - the index to add the element at

element - the element to add to the stack

Throws:

IllegalArgumentException - if the index specified is not 0. Only the top of the stack is accessible

See Also:

• push(Object)

addAll

public boolean addAll(Collection<? extends E> elements)
               throws NullPointerException

Adds the elements from the collection into the stack in the order they are specified

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface List<E>

Overrides:

addAll in class ListExpression<E>

Parameters:

elements - the collection to be added to this stack

Returns:

true

Throws:

NullPointerException - if the collection is null

addAll

public boolean addAll(E... elements)

Adds the contents of the array into the stack

Specified by:

addAll in interface ObservableList<E>

Overrides:

addAll in class ListExpression<E>

Parameters:

elements - the array of elements to add

Returns:

true

See Also:

• addAll(Collection)

addAll

public boolean addAll(int i,
 Collection<? extends E> elements)

Specified by:

addAll in interface List<E>

Overrides:

addAll in class ListExpression<E>

remove

public boolean remove(Object obj)
               throws UnsupportedOperationException

Attempt to remove an arbitrary object from the stack is not permitted

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface List<E>

Overrides:

remove in class ListExpression<E>

Parameters:

obj - The object to remove

Returns:

Nothing

Throws:

UnsupportedOperationException - Removing an arbitrary object is not permitted Use pop()

remove

public void remove(int from,
 int to)
            throws UnsupportedOperationException

Attempt to remove a range of objects from the stack, this is also not permitted

Specified by:

remove in interface ObservableList<E>

Overrides:

remove in class ListExpression<E>

Parameters:

from - Start removing from here

to - To here

Throws:

UnsupportedOperationException - remove(Object)

removeAll

public boolean removeAll(E... elements)

Specified by:

removeAll in interface ObservableList<E>

Overrides:

removeAll in class ListExpression<E>

removeAll

public boolean removeAll(Collection<?> objects)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface List<E>

Overrides:

removeAll in class ListExpression<E>