net.sourceforge.pmd.lang.java.oom.signature

Class OperationSigMask

java.lang.Object

net.sourceforge.pmd.lang.java.oom.signature.SigMask<OperationSignature>

net.sourceforge.pmd.lang.java.oom.signature.OperationSigMask

public final class OperationSigMask
extends SigMask<OperationSignature>

Signature mask for an operation. Newly created masks cover any operation that is not abstract.

Author:

Clément Fournier

Field Summary

Fields inherited from class net.sourceforge.pmd.lang.java.oom.signature.SigMask

visMask

Constructor Summary

Constructors

Constructor and Description
OperationSigMask()

Method Summary

Methods

Modifier and Type	Method and Description
void	coverAbstract(boolean coverAbstract) Forbid all mentioned visibilities.
void	coverAllRoles() Sets the mask to cover all roles.
boolean	covers(OperationSignature sig) Returns true if the parameter is covered by this mask.
void	forbid(OperationSignature.Role... roles) Forbid all mentioned roles.
void	restrictRolesTo(OperationSignature.Role... roles) Restricts the roles covered by the mask to the parameters.

Methods inherited from class net.sourceforge.pmd.lang.java.oom.signature.SigMask

coverAllVisibilities, forbid, restrictVisibilitiesTo

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationSigMask

public OperationSigMask()

Method Detail

restrictRolesTo

public void restrictRolesTo(OperationSignature.Role... roles)

Restricts the roles covered by the mask to the parameters.

Parameters:

roles - The roles to cover.

coverAllRoles

public void coverAllRoles()

Sets the mask to cover all roles.

forbid

public void forbid(OperationSignature.Role... roles)

Forbid all mentioned roles.

Parameters:

roles - The roles to forbid.

coverAbstract

public void coverAbstract(boolean coverAbstract)

Forbid all mentioned visibilities.

Parameters:

coverAbstract - The visibilities to forbid.

covers

public boolean covers(OperationSignature sig)

Description copied from class: SigMask

Returns true if the parameter is covered by this mask.

Overrides:

covers in class SigMask<OperationSignature>

Parameters:

sig - The signature to test.

Returns:

True if the parameter is covered by this mask