Package nl.pim16aap2.lightkeeper.runtime

Class IdeRuntimePaths

java.lang.Object

nl.pim16aap2.lightkeeper.runtime.IdeRuntimePaths

public final class IdeRuntimePaths
extends Object

Canonical path policy for generated IDE test setup state.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DISCOVERY_FILE_NAME	Name of the discovery metadata document.
static final String	IDE_DIRECTORY_NAME	Name of the IDE test setup directory within the generated state directory.
static final String	LOCK_FILE_NAME	Name of the operating-system lock used for IDE setup and launches.
static final String	PROVENANCE_FILE_NAME	Name of the provenance metadata document stored with a prepared runtime.
static final String	STATE_DIRECTORY_NAME	Name of the generated project-local state directory.

Method Summary

Modifier and Type	Method	Description
static Path	discoveryFile(Path moduleDirectory)	Returns the discovery metadata path for a Maven module.
static Path	ideDirectory(Path moduleDirectory)	Returns the IDE test setup directory owned by a Maven module.
static Path	lockFile(Path moduleDirectory)	Returns the module-wide runtime lock path.
static Path	preparationsDirectory(Path moduleDirectory)	Returns the root containing immutable IDE runtime preparations.
static Path	stateDirectory(Path moduleDirectory)	Returns the generated state directory owned by a Maven module.

Methods inherited from class java.lang.Object

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

Field Details

STATE_DIRECTORY_NAME

public static final String STATE_DIRECTORY_NAME

Name of the generated project-local state directory.

See Also:

• Constant Field Values

IDE_DIRECTORY_NAME

public static final String IDE_DIRECTORY_NAME

Name of the IDE test setup directory within the generated state directory.

See Also:

• Constant Field Values

DISCOVERY_FILE_NAME

public static final String DISCOVERY_FILE_NAME

Name of the discovery metadata document.

See Also:

• Constant Field Values

PROVENANCE_FILE_NAME

public static final String PROVENANCE_FILE_NAME

Name of the provenance metadata document stored with a prepared runtime.

See Also:

• Constant Field Values

LOCK_FILE_NAME

public static final String LOCK_FILE_NAME

Name of the operating-system lock used for IDE setup and launches.

See Also:

• Constant Field Values

Method Details

stateDirectory

public static Path stateDirectory(Path moduleDirectory)

Returns the generated state directory owned by a Maven module.

Parameters:

moduleDirectory - Maven module directory.

Returns:

The generated state directory.

ideDirectory

public static Path ideDirectory(Path moduleDirectory)

Returns the IDE test setup directory owned by a Maven module.

Parameters:

moduleDirectory - Maven module directory.

Returns:

The IDE test setup directory.

discoveryFile

public static Path discoveryFile(Path moduleDirectory)

Returns the discovery metadata path for a Maven module.

Parameters:

moduleDirectory - Maven module directory.

Returns:

The discovery metadata path.

preparationsDirectory

public static Path preparationsDirectory(Path moduleDirectory)

Returns the root containing immutable IDE runtime preparations.

Parameters:

moduleDirectory - Maven module directory.

Returns:

The preparations directory.

lockFile

public static Path lockFile(Path moduleDirectory)

Returns the module-wide runtime lock path.

Parameters:

moduleDirectory - Maven module directory.

Returns:

The lock file path.