All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.phloc.commons.collections.iterate.IterableIterator Maven / Gradle / Ivy

Go to download

phloc very basic stuff

There is a newer version: 5.0.0
Show newest version
/**
 * Copyright (C) 2006-2014 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.phloc.commons.collections.iterate;

import java.util.Iterator;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.phloc.commons.ValueEnforcer;
import com.phloc.commons.lang.GenericReflection;
import com.phloc.commons.string.ToStringGenerator;

/**
 * This class is used for simpler iteration over an Iterator via the new "for"
 * syntax.
 * 
 * @author Philip Helger
 * @param 
 *        The type of elements to iterate.
 */
public class IterableIterator  implements IIterableIterator 
{
  private static final IterableIterator  s_aEmpty = new IterableIterator  (EmptyIterator.getInstance ());

  private final Iterator  m_aIter;

  protected IterableIterator (@Nonnull final ELEMENTTYPE [] aCont)
  {
    this (ArrayIterator.create (aCont));
  }

  protected IterableIterator (@Nonnull final Iterable  aCont)
  {
    this (aCont.iterator ());
  }

  protected IterableIterator (@Nonnull final Iterator  aIter)
  {
    m_aIter = ValueEnforcer.notNull (aIter, "Iterator");
  }

  public final boolean hasNext ()
  {
    return m_aIter.hasNext ();
  }

  @Nullable
  public final ELEMENTTYPE next ()
  {
    return m_aIter.next ();
  }

  public final void remove ()
  {
    m_aIter.remove ();
  }

  @Nonnull
  public final Iterator  iterator ()
  {
    return m_aIter;
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("iter", m_aIter).toString ();
  }

  @Nonnull
  public static  IIterableIterator  createEmpty ()
  {
    return GenericReflection., IterableIterator > uncheckedCast (s_aEmpty);
  }

  @Nonnull
  public static  IIterableIterator  create (@Nonnull final ELEMENTTYPE [] aCont)
  {
    return new IterableIterator  (aCont);
  }

  @Nonnull
  public static  IIterableIterator  create (@Nonnull final Iterable  aCont)
  {
    return new IterableIterator  (aCont);
  }

  @Nonnull
  public static  IIterableIterator  create (@Nonnull final Iterator  aIter)
  {
    return new IterableIterator  (aIter);
  }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy