collection

type DList interface {
	// Size of the this dlist as a count of the elements in it.
	Size() int
	// Head of the list.
	Head() *DListElement
	// IsHead of the list.
	IsHead(element *DListElement) bool
	// Tail of the list.
	Tail() *DListElement
	// IsTail of the list.
	IsTail(element *DListElement) bool
	// InsertNext inserts the passed data after the passed element. If the list is empty a 'nil' element is allowed
	// otherwise an error will be returned.
	InsertNext(element *DListElement, data interface{}) (*DListElement, error)
	// InsertPrevious inserts the passed data before the passed element in the list. If the list is empty a 'nil' element
	// is allowed, otherwise an error will be returned.
	InsertPrevious(element *DListElement, data interface{}) (*DListElement, error)
	// Remove the element from the list.
	Remove(element *DListElement) (data interface{}, err error)
}

type DListElement struct {
	// contains filtered or unexported fields
}

type EmptyListError struct {
	// contains filtered or unexported fields
}

type Index interface {
	// Add the passed indexable to the index
	Add(obj Indexable)
	// Update the passed indexable in the index
	Update(obj Indexable)
	// Remove the passed indexable from the index (removed by ID)
	Remove(obj Indexable)
	// LookupValue in the index and return the ID's that correspond to it
	LookupValue(fieldValue interface{}) []string
}

type Indexable interface {
	GetID() string
	GetField(string) interface{}
}

type Indexer interface {
	// Index the field name for all objects added to this indexer
	Index(fieldName string)
	// Contains the passed id
	Contains(id string) bool
	// Add the passed indexable to all the indices
	Add(obj Indexable)
	// Remove the passed indexable from all indices
	Remove(obj Indexable)
	// Values in the indexes that have the fieldName assigned the fieldValue, returns
	// false if there is no index supporting the passed field name.
	Values(fieldName string, fieldValue interface{}) ([]Indexable, bool)
	// Get the indexable for the passed ID form this indexer.
	Get(id string) (Indexable, bool)
	// Count the number of distinct records in this indexer
	Count() int
	// Iterate all values in this indexer
	Iterate() []Indexable
}

type List interface {
	// Head (first element) of the list.
	Head() *ListElement
	// Tail (last element) of the list.
	Tail() (element *ListElement)
	// IsHead returns a boolean indicating whether the passed element is the first element in the list.
	IsHead(element *ListElement) bool
	// IsTail returns a boolean indicating if the passed element is the last element in the list.
	IsTail(element *ListElement) bool
	// Size of the list (number of elements).
	Size() int
	// InsertNext data into the list after the passed element. If the element is nil, the data will be inserted at
	// the head of the list.
	InsertNext(element *ListElement, data interface{}) *ListElement
	// RemoveNext element from the list and return it's data. If passed element is 'nil' the head will be removed
	// from the list.
	RemoveNext(element *ListElement) (data interface{}, err error)
}

type ListElement struct {
	// contains filtered or unexported fields
}

type ListNonEmptyError struct {
	// contains filtered or unexported fields
}

type NoElementError struct {
	// contains filtered or unexported fields
}

type NoMemberError struct {
	// contains filtered or unexported fields
}

type Queue interface {
	// Size of the queue represented as a count of the elements in the queue.
	Size() int
	// Push a new data element onto the queue.
	Push(data interface{})
	// Pop the most recently pushed data element off the queue.
	Pop() (interface{}, error)
	// Peek returns the most recently pushed element without modifying the queue
	Peek() (interface{}, error)
}

type Set interface {
	// Add the passed objects to the set
	Add(objs ...interface{}) Set
	// Remove the passed objects from the set
	Remove(objs ...interface{}) Set
	// Contains the passed object
	Contains(interface{}) bool
	// Elements in this set
	Elements() []interface{}
	// Size of this set (number of elements)
	Size() int
	// New set of the same type as this set
	New() Set
}

type Stack interface {
	// Size of the stack represented as a count of the elements in the stack.
	Size() int
	// Push a new data element onto the stack.
	Push(data interface{})
	// Pop the most recently pushed data element off the stack.
	Pop() (interface{}, error)
	// Peek returns the most recently pushed element without modifying the stack
	Peek() (interface{}, error)
}

type StringQueue interface {
	// Size of the queue represented as a count of the elements in the queue.
	Size() int
	// Push a new data element onto the queue.
	Push(data string)
	// Pop the most recently pushed data element off the queue.
	Pop() (string, error)
	// Peek returns the most recently pushed element without modifying the queue
	Peek() (string, error)
}

type StringSet interface {
	// Add the passed objects to the set
	Add(objs ...string) StringSet
	// Remove the passed objects from the set
	Remove(objs ...string) StringSet
	// Contains the passed object
	Contains(string) bool
	// Elements in this set
	Elements() []string
	// Size of this set (number of elements)
	Size() int
	// New set of the same type as this set
	New() StringSet
}

type StringStack interface {
	// Size of the stack represented as a count of the elements in the stack.
	Size() int
	// Push a new data element onto the stack.
	Push(data string)
	// Pop the most recently pushed data element off the stack.
	Pop() (string, error)
	// Peek returns the most recently pushed element without modifying the stack
	Peek() (string, error)
}