org.kuali.rice.kns.datadictionary.mask
Class Mask

java.lang.Object
  org.kuali.rice.kns.datadictionary.mask.Mask

All Implemented Interfaces:

Serializable

public class Mask
extends Object
implements Serializable

The displayMask element specifies the type of masking to be used to hide the value from un-authorized users. There are three types of masking.

See Also:

Serialized Form

Field Summary

protected MaskFormatter	maskFormatter
protected Class<? extends MaskFormatter>	maskFormatterClass

Constructor Summary

Mask()

Method Summary

MaskFormatter	getMaskFormatter() Gets the maskFormatter attribute.
Class<? extends MaskFormatter>	getMaskFormatterClass() Gets the maskFormatterClass attribute.
String	maskValue(Object value) Masks a data value with the configured maskFormatter;
void	setMaskFormatter(MaskFormatter maskFormatter)
void	setMaskFormatterClass(Class<? extends MaskFormatter> maskFormatterClass)

Methods inherited from class java.lang.Object

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

Field Detail

maskFormatter

protected MaskFormatter maskFormatter

maskFormatterClass

protected Class<? extends MaskFormatter> maskFormatterClass

Constructor Detail

Mask

public Mask()

Method Detail

maskValue

public String maskValue(Object value)

Masks a data value with the configured maskFormatter;

Parameters:

value - of the object

Returns:

string value of the masked object

getMaskFormatter

public MaskFormatter getMaskFormatter()

Gets the maskFormatter attribute.

Returns:

Returns the maskFormatter.

setMaskFormatter

public void setMaskFormatter(MaskFormatter maskFormatter)

Parameters:

maskFormatter - instance to be used for masking field values.

getMaskFormatterClass

public Class<? extends MaskFormatter> getMaskFormatterClass()

Gets the maskFormatterClass attribute.

Returns:

Returns the maskFormatterClass.

setMaskFormatterClass

public void setMaskFormatterClass(Class<? extends MaskFormatter> maskFormatterClass)

Parameters:

maskFormatterClass - element is used when a custom masking algorithm is desired. This element specifies the name of a class that will perform the masking for unauthorized users.