org.spf4j.base.CloseableIterable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spf4j-core Show documentation

A continuously growing collection of utilities to measure performance, get better diagnostics, improve performance, or do things more reliably, faster that other open source libraries...

The newest version!

/*
 * Copyright 2019 SPF4J.
 *
 * 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 org.spf4j.base;

import edu.umd.cs.findbugs.annotations.CleanupObligation;
import edu.umd.cs.findbugs.annotations.DischargesObligation;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.Closeable;
import java.util.Iterator;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;

/**
 * need to extend java.io.Closeable so that jaxrs does not interfere.
 * @author Zoltan Farkas
 */
@CleanupObligation
public interface CloseableIterable extends Closeable, Iterable {

  @DischargesObligation
  void close();

  static  CloseableIterable from(final CloseableIterator iterator) {
    return new CloseableIterable() {
      @Override
      public void close() {
        iterator.close();
      }

      @Override
      public Iterator iterator() {
        return iterator;
      }

    };
  }

  static  CloseableIterable from(final Iterable it) {
    return from(it, () -> { });
  }


  static  CloseableIterable from(final Iterable it, final AutoCloseable close) {
    return new CloseableIterable() {
      @Override
      @SuppressFBWarnings("EXS_EXCEPTION_SOFTENING_NO_CHECKED")
      public void close() {
        try {
          close.close();
        } catch (RuntimeException | Error e) {
          throw e;
        } catch (Exception ex) {
          throw new RuntimeException(ex);
        }
      }

      @Override
      public Iterator iterator() {
        return it.iterator();
      }
    };
  }

  default Stream toStream() {
    return toStream(false);
  }

  default Stream toStream(final boolean parallel) {
    return StreamSupport.stream(spliterator(), parallel).onClose(() -> this.close());
  }

}