collection.go

package collection

// Collection is the root interface for this collections framework hierarchy.
type Collection[T any] interface {
	Iterable[T]

	// Add adds the specified element to this collection.
	Add(e T) bool

	// AddAll adds all of the elements in the this collection.
	AddAll(c ...T) bool

	// Clear removes all of the elements from this collection.
	Clear()

	// Contains returns true if this collection contains the specified element.
	Contains(e T) bool

	// ContainsAll returns true if this collection contains all of the elements in the specified
	// collection.
	ContainsAll(c ...T) bool

	// Equals compares this collection with the object pass from parameter.
	Equals(o any) bool

	// IsEmpty returns true if this collection contains no elements.
	IsEmpty() bool

	// Remove removes the specified element from this collection.
	Remove(e T) bool

	// RemoveAll removes all of the elements in the specified collection from this collection.
	RemoveAll(c ...T) bool

	// RemoveIf removes all of the elements of this collection that satisfy the given predicate.
	RemoveIf(f func(T) bool) bool

	// RetainAll retains only the elements in this collection that are contained in the specified
	// collection.
	RetainAll(c ...T) bool

	// Size returns the number of elements in this collection.
	Size() int

	// ToSlice returns a slice containing all of the elements in this collection.
	ToSlice() []T
}