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

Direct Known Subclasses:

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

Field Summary

Fields
Modifier and Type Field Description

protected Thread lock

protected long lockTime

protected String name

protected boolean privacy

Constructor Summary

Constructors
Constructor Description

Lock()

Lock(String name)

Lock(String name, boolean privacy)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Thread`	`getLocker()`
`long`	`getLockTime()`
`String`	`getName()`
`boolean`	`isLocked()`
`boolean`	`isPrivacy()`
`void`	`lock()`
`boolean`	`lock(long timeout)`
`void`	`lock(Runnable task)`	Run the given task in a locked environment.
`void`	`lock(Runnable task, long timeout)`	Run the given task in a locked environment.
`protected void`	`lockEvent(boolean locked)`	Overwrite this to get the lock events.
`void`	`lockWithException(long timeout)`
`protected void`	`register()`
`boolean`	`release()`	A synonym to unlock()
`void`	`setName(String name)`
`String`	`toString()`
`boolean`	`unlock()`	Unlock if the current thread is also the owner.
`void`	`unlockHard()`	Unlock in every case !!! This can break a locked area.
`void`	`waitUntilUnlock()`	Sleeps until the lock is released.
`boolean`	`waitUntilUnlock(long timeout)`
`void`	`waitWithException(long timeout)`

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
```

lockTime
```
protected long lockTime
```

Constructor Detail

Lock
```
public Lock()
```

Lock

public Lock(String name,
            boolean privacy)

Lock
```
public Lock(String name)
```

Method Detail

register
```
protected void register()
```

lock
```
public void lock()
```

lockEvent
```
protected void lockEvent(boolean locked)
```
Overwrite this to get the lock events.

Parameters:

locked -

lockWithException

public void lockWithException(long timeout)

lock
```
public boolean lock(long timeout)
```

lock
```
public void lock(Runnable task)
```
Run the given task in a locked environment.

Parameters:

task -

lock

public void lock(Runnable task,
                 long timeout)

Run the given task in a locked environment.

Parameters:: task -; timeout -

unlock
```
public boolean unlock()
```
Unlock if the current thread is also the owner.

Returns:

true if unlock was successful

release
```
public boolean release()
```
A synonym to unlock()

Returns:

true if unlock was successful

unlockHard
```
public void unlockHard()
```
Unlock in every case !!! This can break a locked area.

waitUntilUnlock
```
public void waitUntilUnlock()
```
Sleeps until the lock is released.

waitWithException

public void waitWithException(long timeout)

waitUntilUnlock

public boolean waitUntilUnlock(long timeout)

isLocked
```
public boolean isLocked()
```

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getLocker
```
public Thread getLocker()
```

isPrivacy
```
public boolean isPrivacy()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

getLockTime
```
public long getLockTime()
```

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

Constructor	Description
`Lock()`
`Lock(String name)`
`Lock(String name, boolean privacy)`

Class Lock

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

lock

name

privacy

lockTime

Constructor Detail

Lock

Lock

Lock

Method Detail

register

lock

lockEvent

lockWithException

lock

lock

lock

unlock

release

unlockHard

waitUntilUnlock

waitWithException

waitUntilUnlock

isLocked

getName

setName

getLocker

isPrivacy

toString

getLockTime