1 /*
2 * Scope: a generic MVC framework.
3 * Copyright (c) 2000-2002, The Scope team
4 * All rights reserved.
5 *
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
14 * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * Neither the name "Scope" nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
27 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 *
35 *
36 * $Id: NullStringConvertor.java,v 1.3 2002/09/05 15:41:47 ludovicc Exp $
37 */
38 package org.scopemvc.util.convertor;
39
40
41 /***
42 * <P>
43 *
44 * Abstract base class for StringConvertors that recognise a presetn String
45 * value to represent <CODE>null</CODE>. </P>
46 *
47 * @author <A HREF="mailto:smeyfroi@users.sourceforge.net">Steve Meyfroidt</A>
48 * @author <A HREF="mailto:danmi@users.sourceforge.net">Daniel Michalik</A>
49 * @created 05 September 2002
50 * @version $Revision: 1.3 $ $Date: 2002/09/05 15:41:47 $
51 */
52 public abstract class NullStringConvertor implements StringConvertor {
53
54 private String nullString = "";
55
56
57 /***
58 * @return a String representation used when parameter in {@link
59 * #valueAsString(Object) valueAsString} is <code>null</code>. Default
60 * value is empty string.
61 */
62 public String getNullAsString() {
63 return nullString;
64 }
65
66
67 /***
68 * Sets String representation used when parameter in {@link
69 * #valueAsString(Object) valueAsString} is <code>null</code>. Method {@link
70 * #stringAsValue(String) stringAsValue} also uses this value: if parameter
71 * is equal to this representation, return value should be null. Default
72 * value is empty string.
73 *
74 * @param inNullString The new nullAsString value
75 * @throws IllegalArgumentException if passed value is null.
76 */
77 public void setNullAsString(String inNullString) throws IllegalArgumentException {
78 if (inNullString == null) {
79 throw new IllegalArgumentException("String representation of <null> cannot be null");
80 }
81 nullString = inNullString;
82 }
83
84
85 /***
86 * Does the passed String represent <CODE>null</CODE>.
87 *
88 * @param inString TODO: Describe the Parameter
89 * @return The null value
90 */
91 protected boolean isNull(String inString) {
92 return ((inString == null)
93 || (inString.length() == 0)
94 || (inString.equals(getNullAsString())));
95 }
96 }
This page was automatically generated by Maven