1 /**
2 * Copyright 2005-2011 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.krad.datadictionary.mask;
17
18 /**
19 * The maskLiteral element is used to completely hide the field value for
20 * unauthorized users. The specified literal will be shown instead of the field
21 * value.
22 *
23 * @author Kuali Rice Team (rice.collab@kuali.org)
24 */
25 public class MaskFormatterLiteral implements MaskFormatter {
26 private static final long serialVersionUID = 3368293409242411693L;
27
28 protected String literal;
29
30 public String maskValue(Object value) {
31 return literal;
32 }
33
34 /**
35 * Gets the literalString attribute.
36 *
37 * @return Returns the literal String.
38 */
39 public String getLiteral() {
40 return literal;
41 }
42
43 /**
44 * Specify the string that will be shown instead of the actual value when masked.
45 */
46 public void setLiteral(String literal) {
47 this.literal = literal;
48 }
49
50 }