Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util.internal

Class TimeoutSemaphoreImpl.Token

java.lang.Object

org.tquadrat.foundation.util.internal.TimeoutSemaphoreImpl.Token

All Implemented Interfaces:

AutoCloseable

Enclosing class:

TimeoutSemaphoreImpl

@ClassVersion(sourceVersion="$Id: TimeoutSemaphoreImpl.java 1136 2024-05-30 18:25:38Z tquadrat $")
@API(status=INTERNAL,
     since="0.4.8")
private final class TimeoutSemaphoreImpl.Token
extends Object
implements AutoCloseable

The token that holds the permits to be released when a try-with-resources block is left or the timeout has expired.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: TimeoutSemaphoreImpl.java 1136 2024-05-30 18:25:38Z tquadrat $

Since:

0.4.8

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.util.internal.TimeoutSemaphoreImpl.Token"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Instant	m_EndOfLife	The end-of-life for this permit.
private final UUID	m_Id	The id for this permit.
private final int	m_Permits	The number of permits to release on close.

Constructor Summary

Constructors

Constructor	Description
Token(int permits, Instant endOfLife)	Creates a new instance of Token.

Method Summary

Modifier and Type	Method	Description
final void	close()
final Instant	getEndOfLife()	Returns the time for the end-of-life.
final UUID	getId()	Returns the id of the token.
final int	getPermits()	Returns the number of permits for this token.

Methods inherited from class java.lang.Object

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

Field Details

m_EndOfLife

private final Instant m_EndOfLife

The end-of-life for this permit.

m_Id

private final UUID m_Id

The id for this permit.

m_Permits

private final int m_Permits

The number of permits to release on close.

Constructor Details

Token

public Token(int permits,
 Instant endOfLife)

Creates a new instance of Token.

Parameters:

permits - The number of the acquired permits.

endOfLife - The end-of-life for this permit.

Method Details

close

public final void close()
                 throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

getEndOfLife

public final Instant getEndOfLife()

Returns the time for the end-of-life.

Returns:

The end-of-life instant.

getId

public final UUID getId()

Returns the id of the token.

Returns:

The id.

getPermits

public final int getPermits()

Returns the number of permits for this token.

Returns:

The number of permits.