001/*
002 * ModeShape (http://www.modeshape.org)
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *       http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.modeshape.schematic;
017
018import java.util.Arrays;
019import java.util.List;
020
021/**
022 * A {@link SchematicDb} which has the ability to lock.
023 * 
024 * @author Horia Chiorean (hchiorea@redhat.com)
025 */
026public interface Lockable {
027
028    /**
029     * Locks a list of keys exclusively, for writing.
030     * 
031     * @param locks a list of locks
032     * @return {@code true} if the operation was successful and the locks were obtained, false otherwise
033     */
034    boolean lockForWriting( List<String> locks );
035
036    /**
037     * @see Lockable#lockForWriting(List) 
038     */
039    default boolean lockForWriting( String...locks ) {
040        return lockForWriting(Arrays.asList(locks));        
041    }
042}