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

net.java.truecommons.shed.Stream Maven / Gradle / Ivy

Go to download

Hosts small but useful tools and utilities that didn't fit anywhere else.

There is a newer version: 2.5.0
Show newest version
/*
 * Copyright (C) 2005-2012 Schlichtherle IT Services.
 * All rights reserved. Use is subject to license terms.
 */
package net.java.truecommons.shed;

import edu.umd.cs.findbugs.annotations.*;

/**
 * A generic stream collection interface.
 * Mind you that you need to call {@link #close()} on this stream after use,
 * best with a {@code try}-with-resources statement.
 * For example, let's assume you would have an object named {@code container}
 * which has a method named {@code stream()} which returns a
 * {@code Stream}.
 * Then you should use this method like this:
 * 

 * 
{@code
 * try (Stream stream = container.stream()) {
 *     for (Object object : stream) {
 *         // Use object here...
 *     }
 * }
 * }
 * The {@code try}-with-resources statement ensures that {@code stream} gets
 * {@code close()}d after the {@code for}-loop, even if it terminates with an
 * exception.
 * 
 * @param   The type of the elements in the stream.
 * @since  TrueCommons 1.0.12
 * @author Christian Schlichtherle
 */
@CleanupObligation
public interface Stream extends Iterable, AutoCloseable {

    /**
     * Closes this stream.
     * It is an error to call any other method on this stream once this method
     * has terminated without an exception and the result of any violation is
     * undefined.
     * However, implementations are encouraged to throw an exception from any
     * other method to indicate this error condition.
     */
    @Override
    @DischargesObligation
    void close() throws Exception;
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy