/*
 * Copyright 2007-2010 Sun Microsystems, Inc.
 *
 * This file is part of Project Darkstar Server.
 *
 * Project Darkstar Server is free software: you can redistribute it
 * and/or modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation and
 * distributed hereunder to you.
 *
 * Project Darkstar Server is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * --
 */

package com.sun.sgs.impl.util.lock;

/**
 * Records information about an entity that requests locks from a {@link
 * MultiLockManager}.
 *
 * @param	<K> the type of key
 */
public class MultiLocker<K> extends Locker<K> {

    /* -- Constructor -- */

    /**
     * Creates an instance of this class.
     *
     * @param	lockManager the lock manager for this locker
     */
    public MultiLocker(MultiLockManager<K> lockManager) {
	super(lockManager);
    }

    /* -- Package access methods -- */

    /**
     * {@inheritDoc} <p>
     *
     * This implementation returns the value for the current thread obtained
     * from the {@link MultiLockManager}.
     */
    @Override
    LockAttemptResult<K> getWaitingFor() {
	return ((MultiLockManager<K>) lockManager).getWaitingFor();
    }

    /**
     * {@inheritDoc} <p>
     *
     * This implementation sets the value for the current thread in the {@link
     * MultiLockManager}.
     *
     * @throws	IllegalArgumentException {@inheritDoc}
     */
    @Override
    void setWaitingFor(LockAttemptResult<K> waitingFor) {
	if (waitingFor != null && waitingFor.conflict == null) {
	    throw new IllegalArgumentException(
		"Attempt to specify a lock attempt result that is not a" +
		" conflict: " + waitingFor);
	}
	((MultiLockManager<K>) lockManager).setWaitingFor(waitingFor);
    }
}