jenkins.util.io

Class LinesStream

java.lang.Object

jenkins.util.io.LinesStream

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<String>

@CleanupObligation
public class LinesStream
extends Object
implements Closeable, Iterable<String>

Represents a stream over the lines of a text file.

Although LinesStream implements Iterable, it is intended to be first used to initialize a resource in a try-with-resources statement and then iterated, as in:

  try (LinesStream stream = new LinesStream(...)) {
      for (String line : stream) {
          ...
      }
  }
 

This pattern ensures that the underlying file handle is closed properly.

Like DirectoryStream, LinesStream supports creating at most one Iterator. Invoking iterator() to obtain a second or subsequent Iterator throws IllegalStateException.

Since:

2.111

Constructor Summary

Constructors

Constructor and Description
LinesStream(Path path) Opens the text file at path for reading using charset StandardCharsets.UTF_8.

Method Summary

Modifier and Type	Method and Description
void	close()
Iterator<String>	iterator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

LinesStream

public LinesStream(@NonNull
                   Path path)
            throws IOException

Opens the text file at path for reading using charset StandardCharsets.UTF_8.

Parameters:

path - Path to the file to open for reading.

Throws:

IOException - if the file at path cannot be opened for reading.

Method Detail

close

@DischargesObligation
public void close()
                                 throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>