com.helger.commons.collection.iterate.EnumerationFromIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.8+ Library with tons of utility classes required in all projects

There is a newer version: 11.1.10

/*
 * Copyright (C) 2014-2022 Philip Helger (www.helger.com)
 * philip[at]helger[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.helger.commons.collection.iterate;

import java.util.Enumeration;
import java.util.Iterator;

import javax.annotation.Nonnull;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.string.ToStringGenerator;

/**
 * This is a helper class to create an {@link Enumeration} from an existing
 * {@link Iterator}
 *
 * @author Philip Helger
 * @param 
 *        Type to be enumerated
 */
public final class EnumerationFromIterator  implements Enumeration 
{
  private final Iterator  m_aIter;

  public EnumerationFromIterator (@Nonnull final Iterable  aCont)
  {
    this (aCont.iterator ());
  }

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

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

  public ELEMENTTYPE nextElement ()
  {
    return m_aIter.next ();
  }

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

  @Nonnull
  public static  EnumerationFromIterator  create (@Nonnull final Iterator  aIter)
  {
    return new EnumerationFromIterator <> (aIter);
  }

  @Nonnull
  public static  EnumerationFromIterator  create (@Nonnull final Iterable  aCont)
  {
    return new EnumerationFromIterator <> (aCont);
  }
}