Package org.springframework.boot.docker.compose.core

Class DockerComposeFile

java.lang.Object

org.springframework.boot.docker.compose.core.DockerComposeFile

public final class DockerComposeFile
extends Object

A reference to a Docker Compose file (usually named compose.yaml).

Since:

3.1.0

Author:

Moritz Halbritter, Andy Wilkinson, Phillip Webb

See Also:

• of(File)
• of(Collection)
• find(File)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static DockerComposeFile	find(File workingDirectory)	Find the Docker Compose file by searching in the given working directory.
List<File>	getFiles()	Returns the source Docker Compose files.
int	hashCode()
static DockerComposeFile	of(File file)	Create a new DockerComposeFile for the given File.
static DockerComposeFile	of(Collection<? extends File> files)	Creates a new DockerComposeFile for the given files.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getFiles

public List<File> getFiles()

Returns the source Docker Compose files.

Returns:

the source Docker Compose files

Since:

3.4.0

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

find

public static DockerComposeFile find(File workingDirectory)

Find the Docker Compose file by searching in the given working directory. Files are considered in the same order that docker compose uses, namely:

• compose.yaml
• compose.yml
• docker-compose.yaml
• docker-compose.yml

Parameters:

workingDirectory - the working directory to search or null to use the current directory

Returns:

the located file or null if no Docker Compose file can be found

of

public static DockerComposeFile of(File file)

Create a new DockerComposeFile for the given File.

Parameters:

file - the source file

Returns:

the Docker Compose file

of

public static DockerComposeFile of(Collection<? extends File> files)

Creates a new DockerComposeFile for the given files.

Parameters:

files - the source files

Returns:

the Docker Compose file

Since:

3.4.0