com.palantir.lock.StringLockDescriptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lock-api-objects Show documentation

Palantir open source project

There is a newer version: 0.1193.0

/*
 * (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
 *
 * 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.palantir.lock;

import com.google.common.base.Charsets;
import com.google.common.base.Strings;
import com.palantir.logsafe.Preconditions;
import java.util.concurrent.locks.ReadWriteLock;

/**
 * A descriptor for a {@link ReadWriteLock}, identified by a lock ID (a unique
 * string).
 *
 * @author jtamer
 */
public final class StringLockDescriptor {

    private StringLockDescriptor() {
        // cannot instantiate
    }

    /** Returns a {@code LockDescriptor} instance for the given lock ID. */
    @SuppressWarnings("checkstyle:jdkStandardCharsets") // StandardCharsets only in JDK 1.7+
    public static LockDescriptor of(String lockId) {
        Preconditions.checkNotNull(lockId, "lockId should not be null");
        Preconditions.checkArgument(!Strings.isNullOrEmpty(lockId));
        return new LockDescriptor(lockId.getBytes(Charsets.UTF_8));
    }
}