Package org.springframework.aot.test.generator.file

Class SourceFiles

java.lang.Object

org.springframework.aot.test.generator.file.SourceFiles

All Implemented Interfaces:

Iterable<SourceFile>

public final class SourceFiles
extends Object
implements Iterable<SourceFile>

An immutable collection of SourceFile instances.

Since:

6.0

Author:

Phillip Webb

Method Summary

Modifier and Type	Method	Description
SourceFiles	and(Iterable<SourceFile> sourceFiles)	Return a new SourceFiles instance that merges files from another array of SourceFile instances.
SourceFiles	and(SourceFile... sourceFiles)	Return a new SourceFiles instance that merges files from another array of SourceFile instances.
SourceFiles	and(SourceFiles sourceFiles)	Return a new SourceFiles instance that merges files from another SourceFiles instance.
boolean	equals(Object obj)
SourceFile	get(String path)	Get the SourceFile with the given DynamicFile#getPath() path.
SourceFile	getSingle()	Return the single source file contained in the collection.
SourceFile	getSingle(String pattern)	Return the single matching source file contained in the collection.
SourceFile	getSingleFromPackage(String packageName)	Return a single source file contained in the specified package.
int	hashCode()
boolean	isEmpty()	Returns true if this collection is empty.
Iterator<SourceFile>	iterator()
static SourceFiles	none()	Return a SourceFiles instance with no items.
static SourceFiles	of(SourceFile... sourceFiles)	Factory method that can be used to create a SourceFiles instance containing the specified files.
Stream<SourceFile>	stream()	Stream the SourceFile instances contained in this collection.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

none

public static SourceFiles none()

Return a SourceFiles instance with no items.

Returns:

the empty instance

of

public static SourceFiles of(SourceFile... sourceFiles)

Factory method that can be used to create a SourceFiles instance containing the specified files.

Parameters:

sourceFiles - the files to include

Returns:

a SourceFiles instance

and

public SourceFiles and(SourceFile... sourceFiles)

Return a new SourceFiles instance that merges files from another array of SourceFile instances.

Parameters:

sourceFiles - the instances to merge

Returns:

a new SourceFiles instance containing merged content

and

public SourceFiles and(Iterable<SourceFile> sourceFiles)

Return a new SourceFiles instance that merges files from another array of SourceFile instances.

Parameters:

sourceFiles - the instances to merge

Returns:

a new SourceFiles instance containing merged content

and

public SourceFiles and(SourceFiles sourceFiles)

Return a new SourceFiles instance that merges files from another SourceFiles instance.

Parameters:

sourceFiles - the instance to merge

Returns:

a new SourceFiles instance containing merged content

iterator

public Iterator<SourceFile> iterator()

Specified by:

iterator in interface Iterable<SourceFile>

stream

public Stream<SourceFile> stream()

Stream the SourceFile instances contained in this collection.

Returns:

a stream of file instances

isEmpty

public boolean isEmpty()

Returns true if this collection is empty.

Returns:

if this collection is empty

get

@Nullable
public SourceFile get(String path)

Get the SourceFile with the given DynamicFile#getPath() path.

Parameters:

path - the path to find

Returns:

a SourceFile instance or null

getSingle

public SourceFile getSingle()
                     throws IllegalStateException

Return the single source file contained in the collection.

Returns:

the single file

Throws:

IllegalStateException - if the collection doesn't contain exactly one file

getSingle

public SourceFile getSingle(String pattern)
                     throws IllegalStateException

Return the single matching source file contained in the collection.

Returns:

the single file

Throws:

IllegalStateException - if the collection doesn't contain exactly one file

getSingleFromPackage

public SourceFile getSingleFromPackage(String packageName)

Return a single source file contained in the specified package.

Returns:

the single file

Throws:

IllegalStateException - if the collection doesn't contain exactly one file

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object