com.swirlds.common.threading.locks.internal.AcquiredResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-common Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.6

Show newest version

/*
 * Copyright (C) 2018-2024 Hedera Hashgraph, LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.swirlds.common.threading.locks.internal;

import com.swirlds.common.AutoCloseableNonThrowing;
import com.swirlds.common.threading.locks.locked.MaybeLockedResource;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;

/**
 * An instance which is returned by the {@link ResourceLock} when the lock is acquired. Provides access to the locked
 * resource.
 *
 * @param 
 * 		the type of resource
 */
public final class AcquiredResource implements MaybeLockedResource {
    private final AutoCloseableNonThrowing unlock;
    private T resource;

    public AcquiredResource(@NonNull final AutoCloseableNonThrowing unlock, @Nullable final T resource) {
        this.unlock = unlock;
        this.resource = resource;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    @Nullable
    public T getResource() {
        return resource;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setResource(@Nullable final T resource) {
        this.resource = resource;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isLockAcquired() {
        return true;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void close() {
        unlock.close();
    }
}