001    /**
002     * Copyright 2005-2012 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.rice.krad.datadictionary.mask;
017    
018    import java.io.Serializable;
019    
020    /**
021     * Defines interface for a class that mask data values
022     * 
023     * @author Kuali Rice Team (rice.collab@kuali.org)
024     */
025    public interface MaskFormatter extends Serializable {
026    
027        /**
028         * Takes in the real data value and returns a masked string.
029         * 
030         * @param value - data value
031         * @return String - masked value
032         */
033        public String maskValue(Object value);
034    
035    }