Package org.springframework.core.test.tools

Class ResourceFiles

java.lang.Object

org.springframework.core.test.tools.ResourceFiles

All Implemented Interfaces:

Iterable<ResourceFile>

public final class ResourceFiles
extends Object
implements Iterable<ResourceFile>

An immutable collection of ResourceFile instances.

Since:

6.0

Author:

Phillip Webb

Method Summary

Modifier and Type	Method	Description
ResourceFiles	and(Iterable<ResourceFile> resourceFiles)	Return a new ResourceFiles instance that merges files from another iterable of ResourceFiles instances.
ResourceFiles	and(ResourceFile... resourceFiles)	Return a new ResourceFiles instance that merges files from another array of ResourceFile instances.
ResourceFiles	and(ResourceFiles ResourceFiles)	Return a new ResourceFiles instance that merges files from another ResourceFiles instance.
boolean	equals(Object obj)
ResourceFile	get(String path)	Get the ResourceFile with the given path.
ResourceFile	getSingle()	Return the single ResourceFile contained in the collection.
int	hashCode()
boolean	isEmpty()	Returns true if this collection is empty.
Iterator<ResourceFile>	iterator()
static ResourceFiles	none()	Return a DynamicFiles instance with no items.
static ResourceFiles	of(ResourceFile... ResourceFiles)	Factory method that can be used to create a ResourceFiles instance containing the specified files.
Stream<ResourceFile>	stream()	Stream the ResourceFile 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 ResourceFiles none()

Return a DynamicFiles instance with no items.

Returns:

the empty instance

of

public static ResourceFiles of(ResourceFile... ResourceFiles)

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

Parameters:

ResourceFiles - the files to include

Returns:

a ResourceFiles instance

and

public ResourceFiles and(ResourceFile... resourceFiles)

Return a new ResourceFiles instance that merges files from another array of ResourceFile instances.

Parameters:

resourceFiles - the instances to merge

Returns:

a new ResourceFiles instance containing merged content

and

public ResourceFiles and(Iterable<ResourceFile> resourceFiles)

Return a new ResourceFiles instance that merges files from another iterable of ResourceFiles instances.

Parameters:

resourceFiles - the instances to merge

Returns:

a new ResourceFiles instance containing merged content

and

public ResourceFiles and(ResourceFiles ResourceFiles)

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

Parameters:

ResourceFiles - the instance to merge

Returns:

a new ResourceFiles instance containing merged content

iterator

public Iterator<ResourceFile> iterator()

Specified by:

iterator in interface Iterable<ResourceFile>

stream

public Stream<ResourceFile> stream()

Stream the ResourceFile 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 ResourceFile get(String path)

Get the ResourceFile with the given path.

Parameters:

path - the path to find

Returns:

a ResourceFile instance or null

getSingle

public ResourceFile getSingle()
                       throws IllegalStateException

Return the single ResourceFile contained in the collection.

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