Package ro.sync.exml.plugin.lock

Class LockException

java.lang.Object

java.lang.Throwable

java.lang.Exception

ro.sync.exml.plugin.lock.LockException

All Implemented Interfaces:

Serializable

@API(type=EXTENDABLE,
     src=PUBLIC)
public class LockException
extends Exception

Thrown when could not lock or unlock properly

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static final ro.sync.i18n.MessageBundle	messages	The messages resource bundle.

Constructor Summary

Constructors

Constructor	Description
LockException(String message, boolean acquire, String detailedMessage)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getCauseMessage()
String	getDetailedMessage()
String	getMessage()
String	getOpenErrorMessage(boolean close)
String	getOwnerName()
void	setOwnerName(String ownerName)	Sets the name of the lock owner.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

messages

protected static final ro.sync.i18n.MessageBundle messages

The messages resource bundle.

Constructor Details

LockException

public LockException(String message,
 boolean acquire,
 String detailedMessage)

Constructor.

Parameters:

message - The error message.

acquire - True if the exception occurred while trying to acquire the lock.

detailedMessage - The detailed exception message.

Method Details

setOwnerName

public void setOwnerName(String ownerName)

Sets the name of the lock owner.

Parameters:

ownerName - The name of the lock owner to set.

getOwnerName

public String getOwnerName()

Returns:

Returns the name of the lock owner.

getCauseMessage

public String getCauseMessage()

Returns:

The main cause for the exception.

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

See Also:

• Throwable.getMessage()

getDetailedMessage

public String getDetailedMessage()

Returns:

Returns the detailedMessage.

getOpenErrorMessage

public String getOpenErrorMessage(boolean close)

Parameters:

close - true if must advise to close the editor. Otherwise will advise to cancel the operation.

Returns:

Error message to show to user on open if lock failed.