hudson.slaves

Class WorkspaceList.Lease

java.lang.Object

hudson.slaves.WorkspaceList.Lease

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

WorkspaceList

public abstract static class WorkspaceList.Lease
extends Object
implements Closeable

Represents a leased workspace that needs to be returned later.

Field Summary

Fields

Modifier and Type	Field and Description
FilePath	path

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Lease(FilePath path)

Method Summary

Modifier and Type	Method and Description
void	close() By default, calls release(), but should be idempotent.
static WorkspaceList.Lease	createDummyLease(FilePath p) Creates a dummy WorkspaceList.Lease object that does no-op in the release.
static WorkspaceList.Lease	createLinkedDummyLease(FilePath p, WorkspaceList.Lease parent) Creates a WorkspaceList.Lease object that points to the specified path, but the lock is controlled by the given parent lease object.
abstract void	release() Releases this lease.

Methods inherited from class java.lang.Object

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

Field Detail

path

@NonNull
public final FilePath path

Constructor Detail

Lease

protected Lease(@NonNull
                FilePath path)

Method Detail

release

public abstract void release()

Releases this lease.

close

public void close()

By default, calls release(), but should be idempotent.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Since:

1.600

createDummyLease

public static WorkspaceList.Lease createDummyLease(@NonNull
                                                   FilePath p)

Creates a dummy WorkspaceList.Lease object that does no-op in the release.

createLinkedDummyLease

public static WorkspaceList.Lease createLinkedDummyLease(@NonNull
                                                         FilePath p,
                                                         WorkspaceList.Lease parent)

Creates a WorkspaceList.Lease object that points to the specified path, but the lock is controlled by the given parent lease object.