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.beanutils2.converters;
18
19 import java.util.UUID;
20
21 /**
22 * {@link org.apache.commons.beanutils2.Converter} implementation that handles conversion to and from <strong>java.util.UUID</strong> objects.
23 * <p>
24 * Can be configured to either return a <em>default value</em> or throw a {@code ConversionException} if a conversion error occurs.
25 *
26 * @since 2.0
27 */
28 public final class UUIDConverter extends AbstractConverter<UUID> {
29
30 /**
31 * Constructs a <strong>java.util.UUID</strong> <em>Converter</em> that throws a {@code ConversionException} if an error occurs.
32 */
33 public UUIDConverter() {
34 }
35
36 /**
37 * Constructs a <strong>java.util.UUID</strong> <em>Converter</em> that returns a default value if an error occurs.
38 *
39 * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
40 */
41 public UUIDConverter(final UUID defaultValue) {
42 super(defaultValue);
43 }
44
45 /**
46 * <p>
47 * Converts a java.util.UUID or object into a String.
48 * </p>
49 *
50 * @param <T> Target type of the conversion.
51 * @param type Data type to which this value should be converted.
52 * @param value The input value to be converted.
53 * @return The converted value.
54 * @throws Throwable if an error occurs converting to the specified type
55 * @since 2.0
56 */
57 @Override
58 protected <T> T convertToType(final Class<T> type, final Object value) throws Throwable {
59 if (UUID.class.equals(type)) {
60 return type.cast(UUID.fromString(String.valueOf(value)));
61 }
62
63 throw conversionException(type, value);
64 }
65
66 /**
67 * Gets the default type this {@code Converter} handles.
68 *
69 * @return The default type this {@code Converter} handles.
70 * @since 2.0
71 */
72 @Override
73 protected Class<UUID> getDefaultType() {
74 return UUID.class;
75 }
76
77 }