View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.beanutils.converters;
18  
19  import java.net.URL;
20  
21  /***
22   * {@link org.apache.commons.beanutils.Converter} implementaion that handles conversion
23   * to and from <b>java.net.URL</b> objects.
24   * <p>
25   * Can be configured to either return a <i>default value</i> or throw a
26   * <code>ConversionException</code> if a conversion error occurs.
27   *
28   * @version $Revision: 555845 $ $Date: 2007-07-13 03:52:05 +0100 (Fri, 13 Jul 2007) $
29   * @since 1.3
30   */
31  public final class URLConverter extends AbstractConverter {
32  
33      /***
34       * Construct a <b>java.net.URL</b> <i>Converter</i> that throws
35       * a <code>ConversionException</code> if an error occurs.
36       */
37      public URLConverter() {
38          super(URL.class);
39      }
40  
41      /***
42       * Construct a <b>java.net.URL</b> <i>Converter</i> that returns
43       * a default value if an error occurs.
44       *
45       * @param defaultValue The default value to be returned
46       * if the value to be converted is missing or an error
47       * occurs converting the value.
48       */
49      public URLConverter(Object defaultValue) {
50          super(URL.class, defaultValue);
51      }
52  
53      /***
54       * <p>Convert a java.net.URL or object into a String.</p>
55       *
56       * @param type Data type to which this value should be converted.
57       * @param value The input value to be converted.
58       * @return The converted value.
59       * @throws Throwable if an error occurs converting to the specified type
60       */
61      protected Object convertToType(Class type, Object value) throws Throwable {
62          return new URL(value.toString());
63      }
64  
65  }