Lock (mhu-lib-core 3.2.9 API)

java.lang.Object
- de.mhus.lib.core.concurrent.Lock

Direct Known Subclasses:

ThreadLock
```
public class Lock
extends Object
```
Lock class.

Since:

3.2.9

Version:

$Id: $Id

Author:

mikehummel

Field Summary

Fields
Modifier and Type Field and Description

protected Thread lock

protected String name

protected boolean privacy

Fields
Modifier and Type	Field and Description
`protected Thread`	`lock`
`protected String`	`name`
`protected boolean`	`privacy`

Constructor Summary

Constructors
Constructor and Description

Lock()
Constructor for Lock.

Lock(String name)
Constructor for Lock.

Lock(String name, boolean privacy)
Constructor for Lock.

Constructors
Constructor and Description
`Lock()` Constructor for Lock.
`Lock(String name)` Constructor for Lock.
`Lock(String name, boolean privacy)` Constructor for Lock.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Thread`	`getLocker()` getLocker.
`String`	`getName()` Getter for the field `name`.
`boolean`	`isLocked()` isLocked.
`boolean`	`isPrivacy()` isPrivacy.
`void`	`lock()` lock.
`boolean`	`lock(long timeout)` lock.
`void`	`lockWithException(long timeout)` lockWithException.
`void`	`setName(String name)` Setter for the field `name`.
`String`	`toString()`
`void`	`unlockHard()` unlockHard.
`boolean`	`unlockOwned()` unlockOwned.
`void`	`waitUntilUnlock()` waitUntilUnlock.
`boolean`	`waitUntilUnlock(long timeout)` waitUntilUnlock.
`void`	`waitWithException(long timeout)` waitWithException.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - lock
```
protected Thread lock
```
  - name
```
protected String name
```
  - privacy
```
protected boolean privacy
```
- Constructor Detail
  - Lock
```
public Lock()
```
    Constructor for Lock.
  - Lock
```
public Lock(String name,
            boolean privacy)
```
    Constructor for Lock.
    
    Parameters:
    
    name - a String object.
    
    privacy - a boolean.
  - Lock
```
public Lock(String name)
```
    Constructor for Lock.
    
    Parameters:
    
    name - a String object.
- Method Detail
  - lock
```
public void lock()
```
    lock.
  - lockWithException
```
public void lockWithException(long timeout)
```
    lockWithException.
    
    Parameters:
    
    timeout - a long.
  - lock
```
public boolean lock(long timeout)
```
    lock.
    
    Parameters:
    
    timeout - a long.
    
    Returns:
    
    a boolean.
  - unlockOwned
```
public boolean unlockOwned()
```
    unlockOwned.
    
    Returns:
    
    a boolean.
  - unlockHard
```
public void unlockHard()
```
    unlockHard.
  - waitUntilUnlock
```
public void waitUntilUnlock()
```
    waitUntilUnlock.
  - waitWithException
```
public void waitWithException(long timeout)
```
    waitWithException.
    
    Parameters:
    
    timeout - a long.
  - waitUntilUnlock
```
public boolean waitUntilUnlock(long timeout)
```
    waitUntilUnlock.
    
    Parameters:
    
    timeout - a long.
    
    Returns:
    
    a boolean.
  - isLocked
```
public boolean isLocked()
```
    isLocked.
    
    Returns:
    
    a boolean.
  - getName
```
public String getName()
```
    Getter for the field name.
    
    Returns:
    
    a String object.
  - setName
```
public void setName(String name)
```
    Setter for the field name.
    
    Parameters:
    
    name - a String object.
  - getLocker
```
public Thread getLocker()
```
    getLocker.
    
    Returns:
    
    a Thread object.
  - isPrivacy
```
public boolean isPrivacy()
```
    isPrivacy.
    
    Returns:
    
    a boolean.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Lock

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

lock

name

privacy

Constructor Detail

Lock

Lock

Lock

Method Detail

lock

lockWithException

lock

unlockOwned

unlockHard

waitUntilUnlock

waitWithException

waitUntilUnlock

isLocked

getName

setName

getLocker

isPrivacy

toString