FrontInsertIter (Parallel Template Library (PTL)™ 4.0)

java.lang.Object
- Progeneric.Ptl.Iterators.FrontInsertIter<T,TContainer>

Type Parameters:
T - The type of objects to iterate.
TContainer - The type of container that contains the elements inserted into the front.

All Implemented Interfaces:

IBaseIter<FrontInsertIter<T,TContainer>>, IDisposable, IOutIter<T,FrontInsertIter<T,TContainer>>, IEquatable<FrontInsertIter<T,TContainer>>
```
public class FrontInsertIter<T,TContainer extends IFrontSequence<T>>
extends java.lang.Object
implements IOutIter<T,FrontInsertIter<T,TContainer>>
```
Defines an iterator adaptor that functions as an output iterator. It inserts, rather than overwrites, elements into the front of a sequence.

Constructor Summary

Constructors
Constructor and Description
`FrontInsertIter(FrontInsertIter<T,TContainer> x)` Constructs a new instance from another iterator.
`FrontInsertIter(TContainer cnt)` Constructs a FrontInsertIter that inserts elements before the first element in a container.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`Advance(int offset)` Used to implement the Advance method.
`void`	`Advance(long offset)` Used to implement the Advance method.
`IteratorCategory`	`Category()` Gets the iterator category.
`FrontInsertIter<T,TContainer>`	`Copy()` Creates and returns a copy of the current instance.
`void`	`Dispose()` Performs application-defined tasks associated with freeing, releasing, or resetting system resources or other cleanup.
`long`	`Distance(FrontInsertIter<T,TContainer> other)` Used to implement the Distance method.
`boolean`	`Equals(FrontInsertIter<T,TContainer> other)` Tests whether this instance is equal to a specified object.
`boolean`	`equals(java.lang.Object obj)` Tests whether this instance is equal to a specified object.
`int`	`hashCode()` Returns the hash code for this instance.
`void`	`Increment()` Used to implement the IOutIter Increment method.
`FrontInsertIter<T,TContainer>`	`Next()` Used to implement the IOutIter Next method.
`void`	`ResetBegin()` Used to implement the IOutIter ResetBegin method.
`void`	`ResetEnd()` Used to implement the IOutIter ResetEnd method.
`void`	`SetCurrent(T value)` Inserts an element at the front of the container.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FrontInsertIter
```
public FrontInsertIter(TContainer cnt)
```
    Constructs a FrontInsertIter that inserts elements before the first element in a container.
    Remarks: A FrontInsertIter must always be initialized with its container.
    
    Parameters:
    cnt - The container into which the FrontInsertIter is to insert elements.
    
    Throws:
    
    java.lang.NullPointerException - When the container is null.
  - FrontInsertIter
```
public FrontInsertIter(FrontInsertIter<T,TContainer> x)
```
    Constructs a new instance from another iterator.
    
    Parameters:
    x - The iterator to copy.
- Method Detail
  - Category
```
public IteratorCategory Category()
```
    Gets the iterator category.
    
    Specified by:
    
    Category in interface IBaseIter<FrontInsertIter<T,TContainer extends IFrontSequence<T>>>
    
    Returns:
    The iterator category.
  - Dispose
```
public void Dispose()
```
    Performs application-defined tasks associated with freeing, releasing, or resetting system resources or other cleanup.
    
    Specified by:
    
    Dispose in interface IDisposable
  - Copy
```
public FrontInsertIter<T,TContainer> Copy()
```
    Creates and returns a copy of the current instance.
    
    Specified by:
    
    Copy in interface IBaseIter<FrontInsertIter<T,TContainer extends IFrontSequence<T>>>
    
    Returns:
    A copy of the current instance.
  - SetCurrent
```
public void SetCurrent(T value)
```
    Inserts an element at the front of the container.
    
    Specified by:
    
    SetCurrent in interface IOutIter<T,FrontInsertIter<T,TContainer extends IFrontSequence<T>>>
    
    Parameters:
    value - The specified value to be inserted.
  - ResetBegin
```
public void ResetBegin()
```
    Used to implement the IOutIter ResetBegin method. This operation has no effect on the current instance.
    
    Specified by:
    
    ResetBegin in interface IBaseIter<FrontInsertIter<T,TContainer extends IFrontSequence<T>>>
  - ResetEnd
```
public void ResetEnd()
```
    Used to implement the IOutIter ResetEnd method. This operation has no effect on the current instance.
    
    Specified by:
    
    ResetEnd in interface IBaseIter<FrontInsertIter<T,TContainer extends IFrontSequence<T>>>
  - Increment
```
public void Increment()
```
    Used to implement the IOutIter Increment method. This operation has no effect on the current instance.
    
    Specified by:
    
    Increment in interface IBaseIter<FrontInsertIter<T,TContainer extends IFrontSequence<T>>>
  - Next
```
public FrontInsertIter<T,TContainer> Next()
```
    Used to implement the IOutIter Next method.
    
    Returns:
    The current instance.
  - Advance
```
public void Advance(int offset)
```
    Used to implement the Advance method. This operation has no effect on the current instance.
    
    Specified by:
    
    Advance in interface IBaseIter<FrontInsertIter<T,TContainer extends IFrontSequence<T>>>
    
    Parameters:
    offset - The number of positions the iterator is to be offset.
  - Advance
```
public void Advance(long offset)
```
    Used to implement the Advance method. This operation has no effect on the current instance.
    
    Specified by:
    
    Advance in interface IBaseIter<FrontInsertIter<T,TContainer extends IFrontSequence<T>>>
    
    Parameters:
    offset - The number of positions the iterator is to be offset.
  - Distance
```
public long Distance(FrontInsertIter<T,TContainer> other)
```
    Used to implement the Distance method.
    
    Specified by:
    
    Distance in interface IBaseIter<FrontInsertIter<T,TContainer extends IFrontSequence<T>>>
    
    Parameters:
    other - An input iterator addressing the position one past the final element in the range [this, other).
    
    Returns:
    Zero.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Tests whether this instance is equal to a specified object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    obj - An object to compare with this instance.
    
    Returns:
    True if obj is an instance of FrontInsertIter and equals the value of this instance; otherwise, false.
  - hashCode
```
public int hashCode()
```
    Returns the hash code for this instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    A 32-bit signed integer hash code.
  - Equals
```
public boolean Equals(FrontInsertIter<T,TContainer> other)
```
    Tests whether this instance is equal to a specified object.
    
    Specified by:
    
    Equals in interface IEquatable<FrontInsertIter<T,TContainer extends IFrontSequence<T>>>
    
    Parameters:
    other - An object to compare with this instance.
    
    Returns:
    True if other equals the value of this instance; otherwise, false.

Class FrontInsertIter<T,TContainer extends IFrontSequence<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FrontInsertIter

FrontInsertIter

Method Detail

Category

Dispose

Copy

SetCurrent

ResetBegin

ResetEnd

Increment

Next

Advance

Advance

Distance

equals

hashCode

Equals