com.helger.commons.collection.iterate.IIterableIterator 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

The newest version!

/*
 * Copyright (C) 2014-2024 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.Iterator;
import java.util.function.Function;
import java.util.function.Predicate;

import javax.annotation.Nonnull;

import com.helger.commons.collection.impl.ICommonsIterable;

/**
 * This is a merged interface of {@link Iterator} and {@link Iterable} for
 * simpler usage of iterators in the new Java 1.5 "for" constructs.
 *
 * @author Philip Helger
 * @param 
 *        The type of object to iterate
 */
public interface IIterableIterator  extends ICommonsIterable , Iterator 
{
  @Nonnull
  default Iterator  iterator ()
  {
    return this;
  }

  @Nonnull
  default IIterableIterator  withFilter (@Nonnull final Predicate  aFilter)
  {
    return new FilterIterator <> (this, aFilter);
  }

  @Nonnull
  default  IIterableIterator  withMapper (@Nonnull final Function  aMapper)
  {
    return new MapperIterator <> (this, aMapper);
  }
}