001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.validator;
018
019import java.io.Serializable;
020
021/**
022 * <p>
023 * A default argument or an argument for a
024 * specific validator definition (ex: required)
025 * can be stored to pass into a message as parameters.  This can be used in a
026 * pluggable validator for constructing locale
027 * sensitive messages by using <code>java.text.MessageFormat</code>
028 * or an equivalent class.  The resource field can be
029 * used to determine if the value stored in the argument
030 * is a value to be retrieved from a locale sensitive
031 * message retrieval system like <code>java.util.PropertyResourceBundle</code>.
032 * The resource field defaults to 'true'.
033 * </p>
034 * <p>Instances of this class are configured with an &lt;arg&gt; xml element.</p>
035 *
036 * @version $Revision: 1713331 $
037 */
038//TODO mutable non-private fields
039public class Arg implements Cloneable, Serializable {
040
041    private static final long serialVersionUID = -8922606779669839294L;
042
043    /**
044     * The resource bundle name that this Arg's <code>key</code> should be
045     * resolved in (optional).
046     * @since Validator 1.1
047     */
048    protected String bundle = null;
049
050    /**
051     * The key or value of the argument.
052     */
053    protected String key = null;
054
055    /**
056     * The name dependency that this argument goes with (optional).
057     */
058    protected String name = null;
059
060    /**
061     * This argument's position in the message. Set postion=0 to
062     * make a replacement in this string: "some msg {0}".
063     * @since Validator 1.1
064     */
065    protected int position = -1;
066
067    /**
068     * Whether or not the key is a message resource (optional).  Defaults to
069     * true.  If it is 'true', the value will try to be resolved as a message
070     * resource.
071     */
072    protected boolean resource = true;
073
074    /**
075     * Creates and returns a copy of this object.
076     * @return A copy of this object.
077     */
078    public Object clone() {
079        try {
080            return super.clone();
081
082        } catch(CloneNotSupportedException e) {
083            throw new RuntimeException(e.toString());
084        }
085    }
086
087    /**
088     * Returns the resource bundle name.
089     * @return the bundle name.
090     * @since Validator 1.1
091     */
092    public String getBundle() {
093        return this.bundle;
094    }
095
096    /**
097     * Gets the key/value.
098     * @return the key value.
099     */
100    public String getKey() {
101        return this.key;
102    }
103
104    /**
105     * Gets the name of the dependency.
106     * @return the name of the dependency.
107     */
108    public String getName() {
109        return this.name;
110    }
111
112    /**
113     * Argument's replacement position.
114     * @return This argument's replacement position.
115     */
116    public int getPosition() {
117        return this.position;
118    }
119
120    /**
121     * Tests whether or not the key is a resource key or literal value.
122     * @return <code>true</code> if key is a resource key.
123     */
124    public boolean isResource() {
125        return this.resource;
126    }
127
128    /**
129     * Sets the resource bundle name.
130     * @param bundle The new bundle name.
131     * @since Validator 1.1
132     */
133    public void setBundle(String bundle) {
134        this.bundle = bundle;
135    }
136
137    /**
138     * Sets the key/value.
139     * @param key They to access the argument.
140     */
141    public void setKey(String key) {
142        this.key = key;
143    }
144
145    /**
146     * Sets the name of the dependency.
147     * @param name the name of the dependency.
148     */
149    public void setName(String name) {
150        this.name = name;
151    }
152
153    /**
154     * Set this argument's replacement position.
155     * @param position set this argument's replacement position.
156     */
157    public void setPosition(int position) {
158        this.position = position;
159    }
160
161    /**
162     * Sets whether or not the key is a resource.
163     * @param resource If true indicates the key is a resource.
164     */
165    public void setResource(boolean resource) {
166        this.resource = resource;
167    }
168
169    /**
170     * Returns a string representation of the object.
171     * @return a string representation of the object.
172     */
173    public String toString() {
174        StringBuilder results = new StringBuilder();
175
176        results.append("Arg: name=");
177        results.append(name);
178        results.append("  key=");
179        results.append(key);
180        results.append("  position=");
181        results.append(position);
182        results.append("  bundle=");
183        results.append(bundle);
184        results.append("  resource=");
185        results.append(resource);
186        results.append("\n");
187
188        return results.toString();
189    }
190
191}