View Javadoc

1   /*
2     Copyright (c) 2003, Vilmantas Baranauskas
3     All rights reserved.
4   
5     Redistribution and use in source and binary forms, with or without
6     modification, are permitted provided that the following conditions are met:
7       * Redistributions of source code must retain the above copyright notice,
8         this list of conditions and the following disclaimer.
9       * Redistributions in binary form must reproduce the above copyright notice,
10        this list of conditions and the following disclaimer in the documentation
11        and/or other materials provided with the distribution.
12      * The names of its contributors may not be used to endorse or promote
13        products derived from this software without specific prior written
14        permission.
15  
16    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26    POSSIBILITY OF SUCH DAMAGE.
27  */
28  package org.sovt.impl;
29  
30  import org.sovt.Validator;
31  
32  /***
33   * This validator provides storage for single message. All subclassed
34   * validators do not need to create setMsg(String) method.
35   *
36   * You can specify optional "msg" or "message" parameter in an xml
37   * configuration file for such validators.
38   *
39   * @author Vilmantas Baranauskas (vilmantas_baranauskas@yahoo.com)
40   */
41  public abstract class AbstractValidator implements Validator {
42     //-- constants -------------------------------------------------------------
43     //-- variables -------------------------------------------------------------
44     /***
45      * Message in case of failure.
46      */
47     private String message;
48  
49     //-- constructors ----------------------------------------------------------
50     //-- methods ---------------------------------------------------------------
51  
52     /***
53      * Just returns super.clone(). There is no need to do a deep-cloning.
54      *
55      * @return clone of itself.
56      * @throws CloneNotSupportedException
57      */
58     public Object clone() throws CloneNotSupportedException {
59        return super.clone();
60     }
61  
62     /***
63      * Returns stored message.
64      *
65      * @return stored message.
66      */
67     public String getMessage() {
68        return message;
69     }
70  
71     /***
72      * Set message in case of failure.
73      *
74      * @param pMessage used in case of failure.
75      */
76     public void setMsg(String pMessage) {
77        setMessage(pMessage);
78     }
79  
80     /***
81      * Set message in case of failure.
82      *
83      * @param pMessage used in case of failure.
84      */
85     public void setMessage(String pMessage) {
86        this.message = pMessage;
87     }
88  }