View Javadoc

1   /**
2    * Copyright 2005-2012 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  import org.kuali.rice.krad.datadictionary.parse.BeanTag;
19  import org.kuali.rice.krad.datadictionary.parse.BeanTagAttribute;
20  
21  /**
22   * The maskLiteral element is used to completely hide the field value for
23   * unauthorized users. The specified literal will be shown instead of the field
24   * value.
25   *
26   * @author Kuali Rice Team (rice.collab@kuali.org)
27   */
28  @BeanTag(name = "maskFormatterLiteral")
29  public class MaskFormatterLiteral implements MaskFormatter {
30      private static final long serialVersionUID = 3368293409242411693L;
31  
32      protected String literal;
33  
34      public String maskValue(Object value) {
35          return literal;
36      }
37  
38      /**
39       * Gets the literalString attribute.
40       *
41       * @return Returns the literal String.
42       */
43      @BeanTagAttribute(name = "literal")
44      public String getLiteral() {
45          return literal;
46      }
47  
48      /**
49       * Specify the string that will be shown instead of the actual value when masked.
50       */
51      public void setLiteral(String literal) {
52          this.literal = literal;
53      }
54  
55  }