one.microstream.collections.View<E>

All Implemented Interfaces:: Iterable<E>, CapacityCarrying, ExtendedCollection<E>, Sized, XGettingCollection<E>, XIterable<E>, XJoinable<E>, Copyable

public class View<E>
extends Object
implements XGettingCollection<E>

Nested Class Summary

Nested classes/interfaces inherited from interface one.microstream.typing.Copyable
Copyable.Static

Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingCollection
XGettingCollection.Creator<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable
XIterable.Executor<E>
Constructor Summary

Constructors

Constructor Description

View(XGettingCollection<E> collection)

Method Summary

Modifier and Type	Method	Description
`boolean`	`applies(Predicate<? super E> predicate)`
`boolean`	`contains(E element)`
`boolean`	`containsAll(XGettingCollection<? extends E> elements)`
`boolean`	`containsId(E element)`	Special version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic. This method has the same behavior as `XGettingCollection.containsSearched(Predicate)` with a `Predicate` implementation that checks for object identity.
`boolean`	`containsSearched(Predicate<? super E> predicate)`
`View<E>`	`copy()`	Creates a true copy of this collection which references the same elements as this collection does at the time the method is called.
`<C extends Consumer<? super E>> C`	`copyTo(C target)`
`long`	`count(E element)`
`long`	`countBy(Predicate<? super E> predicate)`
`<C extends Consumer<? super E>> C`	`distinct(C target)`
`<C extends Consumer<? super E>> C`	`distinct(C target, Equalator<? super E> equalator)`
`Equalator<? super E>`	`equality()`
`boolean`	`equals(Object o)`	Deprecated.
`boolean`	`equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)`	Returns `true` if the passed collection is of the same type as this collection and`this.equalsContent(list, equalator)` yields `true`.
`boolean`	`equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)`	Returns `true` if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.
`<C extends Consumer<? super E>> C`	`except(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)`
`<C extends Consumer<? super E>> C`	`filterTo(C target, Predicate<? super E> predicate)`
`E`	`get()`	Gets one element from the collection.
`int`	`hashCode()`	Deprecated.
`boolean`	`hasVolatileElements()`	Tells if this collection contains volatile elements. An element is volatile, if it can become no longer reachable by the collection without being removed from the collection.
`XImmutableCollection<E>`	`immure()`	Provides an instance of an immutable collection type with equal behavior and data as this instance.
`<C extends Consumer<? super E>> C`	`intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)`
`boolean`	`isEmpty()`
`boolean`	`isFull()`	Returns true if the current capacity cannot be increased any more.
`<P extends Consumer<? super E>> P`	`iterate(P procedure)`
`Iterator<E>`	`iterator()`
`<A> A`	`join(BiConsumer<? super E,? super A> joiner, A aggregate)`
`E`	`max(Comparator<? super E> comparator)`
`long`	`maximumCapacity()`	Returns the maximum amount of elements this carrier instance can contain. The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g.
`E`	`min(Comparator<? super E> comparator)`
`boolean`	`nullAllowed()`
`boolean`	`nullContained()`
`OldCollection<E>`	`old()`
`long`	`remainingCapacity()`	Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.
`E`	`search(Predicate<? super E> predicate)`
`E`	`seek(E sample)`	Returns the first contained element matching the passed sample as defined by the collection's equality logic or null, if no fitting element is contained.
`long`	`size()`
`Object[]`	`toArray()`
`E[]`	`toArray(Class<E> type)`
`<C extends Consumer<? super E>> C`	`union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)`
`XGettingCollection<E>`	`view()`

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface one.microstream.collections.types.XGettingCollection

intSize

Constructor Details
- View
  
  public View(XGettingCollection<E> collection)
Method Details
- get
  
  public E get()
  
  Description copied from interface: XGettingCollection
  
  Gets one element from the collection. If the collection is not ordered XGettingSequence, then it is undefined which element is returned. If the collection is ordered, the element at index 0 is returned.
  
  Specified by:
  
  get in interface XGettingCollection<E>
  
  Returns:
  
  the first / any element.
- equality
  
  public Equalator<? super E> equality()
  
  Specified by:
  
  equality in interface XGettingCollection<E>
- hasVolatileElements
  
  public boolean hasVolatileElements()
  
  Description copied from interface: XGettingCollection
  
  Tells if this collection contains volatile elements.
  An element is volatile, if it can become no longer reachable by the collection without being removed from the collection. Examples are WeakReference of SoftReference or implementations of collection entries that remove the element contained in an entry by some means outside the collection.
  Note that WeakReference instances that are added to a a simple (non-volatile) implementation of a collection do NOT make the collection volatile, as the elements themselves (the reference instances) are still strongly referenced.
  
  Specified by:
  
  hasVolatileElements in interface ExtendedCollection<E>
  
  Specified by:
  
  hasVolatileElements in interface XGettingCollection<E>
  
  Returns:
  
  true if the collection contains volatile elements.
- containsSearched
  
  public boolean containsSearched(Predicate<? super E> predicate)
  
  Specified by:
  
  containsSearched in interface XGettingCollection<E>
- applies
  
  public boolean applies(Predicate<? super E> predicate)
  
  Specified by:
  
  applies in interface XGettingCollection<E>
- nullAllowed
  
  public boolean nullAllowed()
  
  Specified by:
  
  nullAllowed in interface ExtendedCollection<E>
- nullContained
  
  public boolean nullContained()
  
  Specified by:
  
  nullContained in interface XGettingCollection<E>
- containsAll
  
  public boolean containsAll(XGettingCollection<? extends E> elements)
  
  Specified by:
  
  containsAll in interface XGettingCollection<E>
- contains
  
  public boolean contains(E element)
  
  Specified by:
  
  contains in interface XGettingCollection<E>
- containsId
  
  public boolean containsId(E element)
  
  Description copied from interface: XGettingCollection
  
  Special version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic.
  This method has the same behavior as XGettingCollection.containsSearched(Predicate) with a Predicate implementation that checks for object identity. The only difference is a performance and usability advantage
  
  Specified by:
  
  containsId in interface XGettingCollection<E>
  
  Parameters:
  
  element - the element to be searched in the collection by identity.
  
  Returns:
  
  whether this collection contains exactely the given element.
- copy
  
  public View<E> copy()
  
  Description copied from interface: XGettingCollection
  
  Creates a true copy of this collection which references the same elements as this collection does at the time the method is called. The elements themselves are NOT copied (no deep copying).
  The type of the returned set is the same as of this list if possible.
  
  Specified by:
  
  copy in interface Copyable
  
  Specified by:
  
  copy in interface XGettingCollection<E>
  
  Returns:
  
  a copy of this list
- filterTo
  
  public <C extends Consumer<? super E>> C filterTo(C target, Predicate<? super E> predicate)
  
  Specified by:
  
  filterTo in interface XGettingCollection<E>
- copyTo
  
  public <C extends Consumer<? super E>> C copyTo(C target)
  
  Specified by:
  
  copyTo in interface XGettingCollection<E>
- count
  
  public long count(E element)
  
  Specified by:
  
  count in interface XGettingCollection<E>
- countBy
  
  public long countBy(Predicate<? super E> predicate)
  
  Specified by:
  
  countBy in interface XGettingCollection<E>
- distinct
  
  public <C extends Consumer<? super E>> C distinct(C target, Equalator<? super E> equalator)
  
  Specified by:
  
  distinct in interface XGettingCollection<E>
- distinct
  
  public <C extends Consumer<? super E>> C distinct(C target)
  
  Specified by:
  
  distinct in interface XGettingCollection<E>
- equals
  
  public boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
  
  Description copied from interface: XGettingCollection
  
  Returns true if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator) yields true.
  
  Specified by:
  
  equals in interface XGettingCollection<E>
- equalsContent
  
  public boolean equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
  
  Description copied from interface: XGettingCollection
  
  Returns true if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.
  Note that for colletion types that don't have a defined order of elements, this method is hardly usable (as is XGettingCollection.equals(Object) for them as defined in Collection). The core problem of comparing collections that have no defined order is that they aren't really reliably comparable to any other collection.
  
  Specified by:
  
  equalsContent in interface XGettingCollection<E>
  
  equalator - the equalator to use to determine the equality of each element
  
  Returns:
  
  true if this list is equal to the passed list, false otherwise
- except
  
  public <C extends Consumer<? super E>> C except(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)
  
  Specified by:
  
  except in interface XGettingCollection<E>
- iterate
  
  public final <P extends Consumer<? super E>> P iterate(P procedure)
  
  Specified by:
  
  iterate in interface XIterable<E>
- join
  
  public final <A> A join(BiConsumer<? super E,? super A> joiner, A aggregate)
  
  Specified by:
  
  join in interface XGettingCollection<E>
  
  Specified by:
  
  join in interface XJoinable<E>
- intersect
  
  public <C extends Consumer<? super E>> C intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)
  
  Specified by:
  
  intersect in interface XGettingCollection<E>
- max
  
  public E max(Comparator<? super E> comparator)
  
  Specified by:
  
  max in interface XGettingCollection<E>
- min
  
  public E min(Comparator<? super E> comparator)
  
  Specified by:
  
  min in interface XGettingCollection<E>
- seek
  
  public E seek(E sample)
  
  Description copied from interface: XGettingCollection
  
  Returns the first contained element matching the passed sample as defined by the collection's equality logic or null, if no fitting element is contained. (For collections using referential equality, this method is basically just a variation of XGettingCollection.contains(Object) with a different return type. For collections with data-dependant equality, the returned element might be the same as the passed one or a data-wise equal one, depending on the content of the collection)
  
  Specified by:
  
  seek in interface XGettingCollection<E>
- search
  
  public E search(Predicate<? super E> predicate)
  
  Specified by:
  
  search in interface XGettingCollection<E>
- toArray
  
  public E[] toArray(Class<E> type)
  
  Specified by:
  
  toArray in interface XGettingCollection<E>
- union
  
  public <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)
  
  Specified by:
  
  union in interface XGettingCollection<E>
- hashCode
  
  @Deprecated public int hashCode()
  
  Deprecated.
  
  Specified by:
  
  hashCode in interface XGettingCollection<E>
  
  Overrides:
  
  hashCode in class Object
- equals
  
  @Deprecated public boolean equals(Object o)
  
  Deprecated.
  
  Description copied from interface: XGettingCollection
  
  Performs an equality comparison according to the specification in Collection.
  Note that it is this interface's author opinion that the whole concept of equals() in standard Java, especially in the collection implementations, is flawed.
  The reason is because all different kinds of comparison types that actually depend on the situation have to be mixed up in a harcoded fashion in one method, from identity comparison over data indentity comparison to content comparison.
  In order to get the right behavior in every situation, one has to distinct between different types of equality
  
  This means several things:
  1.) You can't just say for example an ArrayList is the "same" as a LinkedList just because they contain the same content.
  There are different implementations for a good reason, so you have to distinct them when comparing. There are simple code examples which create massive misbehavior that will catastrophically ruin the runtime behavior of a programm due to this error in Java / JDK / Sun / whatever.
  2.) You can't always determine equality of two collections by determining equality of each element as Collection defines it.
  As a conclusion: don't use this method!
  Be clear what type of comparison you really need, then use one of the following methods and proper comparators:
  XGettingCollection.equals(XGettingCollection,Equalator)
  XGettingCollection.equalsContent(XGettingCollection,Equalator)
  
  Specified by:
  
  equals in interface XGettingCollection<E>
  
  Overrides:
  
  equals in class Object
- isEmpty
  
  public boolean isEmpty()
  
  Specified by:
  
  isEmpty in interface Sized
- size
  
  public long size()
  
  Specified by:
  
  size in interface Sized
  
  Specified by:
  
  size in interface XGettingCollection<E>
- maximumCapacity
  
  public long maximumCapacity()
  
  Description copied from interface: CapacityCarrying
  
  Returns the maximum amount of elements this carrier instance can contain.
  The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g. Integer.MAX_VALUE)
  
  Specified by:
  
  maximumCapacity in interface CapacityCarrying
  
  Returns:
  
  the maximum amount of elements this carrier instance can contain.
- isFull
  
  public boolean isFull()
  
  Description copied from interface: CapacityCarrying
  
  Returns true if the current capacity cannot be increased any more.
  
  Specified by:
  
  isFull in interface CapacityCarrying
- remainingCapacity
  
  public long remainingCapacity()
  
  Description copied from interface: CapacityCarrying
  
  Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.
  
  Specified by:
  
  remainingCapacity in interface CapacityCarrying
- toArray
  
  public Object[] toArray()
  
  Specified by:
  
  toArray in interface XGettingCollection<E>
- immure
  
  public XImmutableCollection<E> immure()
  
  Description copied from interface: XGettingCollection
  
  Provides an instance of an immutable collection type with equal behavior and data as this instance.
  If this instance already is of an immutable collection type, it returns itself.
  
  Specified by:
  
  immure in interface XGettingCollection<E>
  
  Returns:
  
  an immutable copy of this collection instance.
- view
  
  public XGettingCollection<E> view()
  
  Specified by:
  
  view in interface XGettingCollection<E>
- iterator
  
  public Iterator<E> iterator()
  
  Specified by:
  
  iterator in interface Iterable<E>
  
  Specified by:
  
  iterator in interface XGettingCollection<E>
- old
  
  public OldCollection<E> old()
  
  Specified by:
  
  old in interface XGettingCollection<E>

Class View<E>

Nested Class Summary

Nested classes/interfaces inherited from interface one.microstream.typing.Copyable

Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingCollection

Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Methods inherited from interface one.microstream.collections.types.XGettingCollection

Constructor Details

Method Details