1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.commons.beanutils2.converters;
20
21 import java.net.InetAddress;
22 import java.net.UnknownHostException;
23
24 /**
25 * {@link org.apache.commons.beanutils2.Converter} implementation that handles conversion to and from {@link InetAddress}.
26 *
27 * @since 2.0.0
28 * @see <a href="https://en.wikipedia.org/wiki/Inet_address">IP Address on Wikipedia</a>
29 */
30 public class InetAddressConverter extends AbstractConverter<InetAddress> {
31
32 /**
33 * Construct a <strong>{@link InetAddress}</strong> <em>Converter</em> that throws a {@code ConversionException} if an error occurs.
34 */
35 public InetAddressConverter() {
36 }
37
38 /**
39 * Constructs a {@link org.apache.commons.beanutils2.Converter} that will return the specified default value if a conversion error occurs.
40 *
41 * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
42 */
43 public InetAddressConverter(final InetAddress defaultValue) {
44 super(defaultValue);
45 }
46
47 /**
48 * Converts the specified input object into an output object of the specified type.
49 *
50 * @param type Data type to which this value should be converted.
51 * @param value The String property value to convert.
52 * @return An {@link InetAddress} which represents the configuration property value.
53 * @throws NullPointerException If the value is null.
54 * @throws IllegalArgumentException If a host name was specified and the IP address couldn't be obtained.
55 */
56 @Override
57 protected <T> T convertToType(final Class<T> type, final Object value) throws Throwable {
58 if (InetAddress.class.isAssignableFrom(type)) {
59 final String stringValue = toString(value);
60
61 try {
62 return type.cast(InetAddress.getByName(stringValue));
63 } catch (final UnknownHostException ex) {
64 throw new IllegalArgumentException("Unable to get IP address of the named host.", ex);
65 }
66 }
67
68 throw conversionException(type, value);
69 }
70
71 /**
72 * Gets the default type this {@code Converter} handles.
73 *
74 * @return The default type this {@code Converter} handles.
75 * @since 2.0.0
76 */
77 @Override
78 protected Class<InetAddress> getDefaultType() {
79 return InetAddress.class;
80 }
81 }