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

Class SigMask<T extends Signature>

java.lang.Object

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

Type Parameters:

T - The type of Signature to handle.

Direct Known Subclasses:

FieldSigMask, OperationSigMask

public abstract class SigMask<T extends Signature>
extends Object

Generic signature mask.

Author:

Clément Fournier

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<Signature.Visibility>	visMask Visibility mask.

Constructor Summary

Constructors

Constructor and Description
SigMask()

Method Summary

Methods

Modifier and Type	Method and Description
void	coverAllVisibilities() Sets the mask to cover all visibilities.
boolean	covers(T sig) Returns true if the parameter is covered by this mask.
void	forbid(Signature.Visibility... visibilities) Forbid all mentioned visibilities.
void	restrictVisibilitiesTo(Signature.Visibility... visibilities) Restricts the visibilities covered by the mask to the parameters.

Methods inherited from class java.lang.Object

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

Field Detail

visMask

protected Set<Signature.Visibility> visMask

Visibility mask.

Constructor Detail

SigMask

public SigMask()

Method Detail

restrictVisibilitiesTo

public void restrictVisibilitiesTo(Signature.Visibility... visibilities)

Restricts the visibilities covered by the mask to the parameters.

Parameters:

visibilities - The visibilities to cover.

coverAllVisibilities

public void coverAllVisibilities()

Sets the mask to cover all visibilities.

forbid

public void forbid(Signature.Visibility... visibilities)

Forbid all mentioned visibilities.

Parameters:

visibilities - The visibilities to forbid.

covers

public boolean covers(T sig)

Returns true if the parameter is covered by this mask.

Parameters:

sig - The signature to test.

Returns:

True if the parameter is covered by this mask