de.pheasn.blockown.protection

Class Protection

java.lang.Object

de.pheasn.blockown.protection.Protection

All Implemented Interfaces:

Runnable

public class Protection
extends Object
implements Runnable

Field Summary

Fields

Modifier and Type	Field and Description
protected ConcurrentLinkedQueue<ProtectAction>	queue

Constructor Summary

Constructors

Constructor and Description
Protection(Output output, File protectionFile)

Method Summary

Modifier and Type	Method and Description
void	disable() Needs to be called to make protection thread empty the queue before program ends
Thread	enqueue(ProtectAction protectAction) Enqueue a ProtectAction.
Set<User>	getFriends(User owner) Gets an immutable Set of friends for a user
Set<Material>	getLocks(User owner) Gets an immutable Set of locked materials for a user
Set<Material>	getProtections(User owner) Gets an immutable Set of protected materials for a user
boolean	hasAccess(User owner, Material material, User user) Checks whether a user can access an Ownable consisting of the specified material that is owned by the specified owner.
boolean	isFriend(User owner, User user) Checks whether owner has declared user as a friend.
boolean	isLocked(User owner, Material material) Checks whether the user has locked the access to the material
boolean	isProtected(User owner, Material material) Checks whether the material is protected
void	run()
protected void	syncedEnqueue(ProtectAction protectAction)

Methods inherited from class java.lang.Object

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

Field Detail

queue

protected final ConcurrentLinkedQueue<ProtectAction> queue

Constructor Detail

Protection

public Protection(Output output,
                  File protectionFile)
           throws IOException

Throws:

IOException

Method Detail

hasAccess

public boolean hasAccess(User owner,
                         Material material,
                         User user)

Checks whether a user can access an Ownable consisting of the specified material that is owned by the specified owner.

Parameters:

owner - the owner

material - the material

user - the user

Returns:

true, if allowed

isLocked

public boolean isLocked(User owner,
                        Material material)

Checks whether the user has locked the access to the material

Parameters:

owner - the owner

material - the material

Returns:

true, if is locked

isFriend

public boolean isFriend(User owner,
                        User user)

Checks whether owner has declared user as a friend. Please note that "user if friend of owner" doesn't imply "owner is friend of user"

Parameters:

owner - the owner

user - the user

Returns:

true, if is friend

isProtected

public boolean isProtected(User owner,
                           Material material)

Checks whether the material is protected

Parameters:

owner - the owner

material - the material

Returns:

True, if material is protected by owner

getFriends

public Set<User> getFriends(User owner)

Gets an immutable Set of friends for a user

Parameters:

owner - the User

Returns:

immutable Set, never null

getLocks

public Set<Material> getLocks(User owner)

Gets an immutable Set of locked materials for a user

Parameters:

owner - the User

Returns:

immutable Set, never null

getProtections

public Set<Material> getProtections(User owner)

Gets an immutable Set of protected materials for a user

Parameters:

owner - the User

Returns:

immutable Set, never null

enqueue

public final Thread enqueue(ProtectAction protectAction)

Enqueue a ProtectAction.

Parameters:

protectAction - the ProtectAction

Returns:

the enqueue thread

syncedEnqueue

protected final void syncedEnqueue(ProtectAction protectAction)

disable

public void disable()

Needs to be called to make protection thread empty the queue before program ends

run

public void run()

Specified by:

run in interface Runnable