diff --git a/spring-core/src/main/java/org/springframework/core/convert/support/AbstractConditionalEnumConverter.java b/spring-core/src/main/java/org/springframework/core/convert/support/AbstractConditionalEnumConverter.java new file mode 100644 index 00000000000..03e8196975b --- /dev/null +++ b/spring-core/src/main/java/org/springframework/core/convert/support/AbstractConditionalEnumConverter.java @@ -0,0 +1,48 @@ +/* + * Copyright 2002-2016 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.core.convert.support; + +import org.springframework.core.convert.ConversionService; +import org.springframework.core.convert.TypeDescriptor; +import org.springframework.core.convert.converter.ConditionalConverter; +import org.springframework.util.ClassUtils; + +/** + * A {@link ConditionalConverter} base implementation for enum-based converters. + * + * @author Stephane Nicoll + * @since 4.3 + */ +abstract class AbstractConditionalEnumConverter implements ConditionalConverter { + + private final ConversionService conversionService; + + protected AbstractConditionalEnumConverter(ConversionService conversionService) { + this.conversionService = conversionService; + } + + @Override + public boolean matches(TypeDescriptor sourceType, TypeDescriptor targetType) { + for (Class interfaceType : ClassUtils.getAllInterfacesForClass(sourceType.getType())) { + if (this.conversionService.canConvert(TypeDescriptor.valueOf(interfaceType), targetType)) { + return false; + } + } + return true; + } + +} diff --git a/spring-core/src/main/java/org/springframework/core/convert/support/ConversionUtils.java b/spring-core/src/main/java/org/springframework/core/convert/support/ConversionUtils.java index c4d41ec351d..e75cddac006 100644 --- a/spring-core/src/main/java/org/springframework/core/convert/support/ConversionUtils.java +++ b/spring-core/src/main/java/org/springframework/core/convert/support/ConversionUtils.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2011 the original author or authors. + * Copyright 2002-2016 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -25,6 +25,7 @@ import org.springframework.core.convert.converter.GenericConverter; * Internal utilities for the conversion package. * * @author Keith Donald + * @author Stephane Nicoll * @since 3.0 */ abstract class ConversionUtils { @@ -65,4 +66,16 @@ abstract class ConversionUtils { } } + public static Class getEnumType(Class targetType) { + Class enumType = targetType; + while (enumType != null && !enumType.isEnum()) { + enumType = enumType.getSuperclass(); + } + if (enumType == null) { + throw new IllegalArgumentException( + "The target type " + targetType.getName() + " does not refer to an enum"); + } + return enumType; + } + } diff --git a/spring-core/src/main/java/org/springframework/core/convert/support/DefaultConversionService.java b/spring-core/src/main/java/org/springframework/core/convert/support/DefaultConversionService.java index 57c742b88c6..86df6337f63 100644 --- a/spring-core/src/main/java/org/springframework/core/convert/support/DefaultConversionService.java +++ b/spring-core/src/main/java/org/springframework/core/convert/support/DefaultConversionService.java @@ -142,6 +142,9 @@ public class DefaultConversionService extends GenericConversionService { converterRegistry.addConverterFactory(new StringToEnumConverterFactory()); converterRegistry.addConverter(new EnumToStringConverter((ConversionService) converterRegistry)); + + converterRegistry.addConverterFactory(new IntegerToEnumConverterFactory()); + converterRegistry.addConverter(new EnumToIntegerConverter((ConversionService) converterRegistry)); converterRegistry.addConverter(new StringToLocaleConverter()); converterRegistry.addConverter(Locale.class, String.class, new ObjectToStringConverter()); diff --git a/spring-core/src/main/java/org/springframework/core/convert/support/EnumToIntegerConverter.java b/spring-core/src/main/java/org/springframework/core/convert/support/EnumToIntegerConverter.java new file mode 100644 index 00000000000..0028ef5489f --- /dev/null +++ b/spring-core/src/main/java/org/springframework/core/convert/support/EnumToIntegerConverter.java @@ -0,0 +1,40 @@ +/* + * Copyright 2002-2016 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.core.convert.support; + +import org.springframework.core.convert.ConversionService; +import org.springframework.core.convert.converter.Converter; + +/** + * Calls {@link Enum#ordinal()} to convert a source Enum to a Integer. + * This converter will not match enums with interfaces that can be converted. + * + * @author Yanming Zhou + * @since 4.3 + */ +final class EnumToIntegerConverter extends AbstractConditionalEnumConverter implements Converter, Integer> { + + public EnumToIntegerConverter(ConversionService conversionService) { + super(conversionService); + } + + @Override + public Integer convert(Enum source) { + return source.ordinal(); + } + +} diff --git a/spring-core/src/main/java/org/springframework/core/convert/support/EnumToStringConverter.java b/spring-core/src/main/java/org/springframework/core/convert/support/EnumToStringConverter.java index 02a5f19f29c..ccb06f51c7e 100644 --- a/spring-core/src/main/java/org/springframework/core/convert/support/EnumToStringConverter.java +++ b/spring-core/src/main/java/org/springframework/core/convert/support/EnumToStringConverter.java @@ -17,10 +17,7 @@ package org.springframework.core.convert.support; import org.springframework.core.convert.ConversionService; -import org.springframework.core.convert.TypeDescriptor; -import org.springframework.core.convert.converter.ConditionalConverter; import org.springframework.core.convert.converter.Converter; -import org.springframework.util.ClassUtils; /** * Calls {@link Enum#name()} to convert a source Enum to a String. @@ -30,24 +27,10 @@ import org.springframework.util.ClassUtils; * @author Phillip Webb * @since 3.0 */ -final class EnumToStringConverter implements Converter, String>, ConditionalConverter { - - private final ConversionService conversionService; - +final class EnumToStringConverter extends AbstractConditionalEnumConverter implements Converter, String> { public EnumToStringConverter(ConversionService conversionService) { - this.conversionService = conversionService; - } - - - @Override - public boolean matches(TypeDescriptor sourceType, TypeDescriptor targetType) { - for (Class interfaceType : ClassUtils.getAllInterfacesForClass(sourceType.getType())) { - if (this.conversionService.canConvert(TypeDescriptor.valueOf(interfaceType), targetType)) { - return false; - } - } - return true; + super(conversionService); } @Override diff --git a/spring-core/src/main/java/org/springframework/core/convert/support/IntegerToEnumConverterFactory.java b/spring-core/src/main/java/org/springframework/core/convert/support/IntegerToEnumConverterFactory.java new file mode 100644 index 00000000000..03204e73dbd --- /dev/null +++ b/spring-core/src/main/java/org/springframework/core/convert/support/IntegerToEnumConverterFactory.java @@ -0,0 +1,52 @@ +/* + * Copyright 2002-2016 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.core.convert.support; + +import org.springframework.core.convert.converter.Converter; +import org.springframework.core.convert.converter.ConverterFactory; + +/** + * Converts from a Integer to a {@link java.lang.Enum} by calling {@link Class#getEnumConstants()}. + * + * @author Yanming Zhou + * @author Stephane Nicoll + * @since 4.3 + */ +@SuppressWarnings({"unchecked", "rawtypes"}) +final class IntegerToEnumConverterFactory implements ConverterFactory { + + @Override + public Converter getConverter(Class targetType) { + return new IntegerToEnum(ConversionUtils.getEnumType(targetType)); + } + + + private class IntegerToEnum implements Converter { + + private final Class enumType; + + public IntegerToEnum(Class enumType) { + this.enumType = enumType; + } + + @Override + public T convert(Integer source) { + return this.enumType.getEnumConstants()[source]; + } + } + +} diff --git a/spring-core/src/main/java/org/springframework/core/convert/support/StringToEnumConverterFactory.java b/spring-core/src/main/java/org/springframework/core/convert/support/StringToEnumConverterFactory.java index 923239b919e..865d1e83a32 100644 --- a/spring-core/src/main/java/org/springframework/core/convert/support/StringToEnumConverterFactory.java +++ b/spring-core/src/main/java/org/springframework/core/convert/support/StringToEnumConverterFactory.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2014 the original author or authors. + * Copyright 2002-2016 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,6 +23,7 @@ import org.springframework.core.convert.converter.ConverterFactory; * Converts from a String to a {@link java.lang.Enum} by calling {@link Enum#valueOf(Class, String)}. * * @author Keith Donald + * @author Stephane Nicoll * @since 3.0 */ @SuppressWarnings({"unchecked", "rawtypes"}) @@ -30,15 +31,7 @@ final class StringToEnumConverterFactory implements ConverterFactory Converter getConverter(Class targetType) { - Class enumType = targetType; - while (enumType != null && !enumType.isEnum()) { - enumType = enumType.getSuperclass(); - } - if (enumType == null) { - throw new IllegalArgumentException( - "The target type " + targetType.getName() + " does not refer to an enum"); - } - return new StringToEnum(enumType); + return new StringToEnum(ConversionUtils.getEnumType(targetType)); } diff --git a/spring-core/src/test/java/org/springframework/core/convert/support/DefaultConversionServiceTests.java b/spring-core/src/test/java/org/springframework/core/convert/support/DefaultConversionServiceTests.java index 3d2a87d09f6..e7caf78bab8 100644 --- a/spring-core/src/test/java/org/springframework/core/convert/support/DefaultConversionServiceTests.java +++ b/spring-core/src/test/java/org/springframework/core/convert/support/DefaultConversionServiceTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2015 the original author or authors. + * Copyright 2002-2016 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -243,6 +243,26 @@ public class DefaultConversionServiceTests { public void testEnumToString() { assertEquals("BAR", conversionService.convert(Foo.BAR, String.class)); } + + @Test + public void testIntegerToEnum() throws Exception { + assertEquals(Foo.BAR, conversionService.convert(0, Foo.class)); + } + + @Test + public void testIntegerToEnumWithSubclass() throws Exception { + assertEquals(SubFoo.BAZ, conversionService.convert(1, SubFoo.BAR.getClass())); + } + + @Test + public void testIntegerToEnumNull() { + assertEquals(null, conversionService.convert(null, Foo.class)); + } + + @Test + public void testEnumToInteger() { + assertEquals(Integer.valueOf(0), conversionService.convert(Foo.BAR, Integer.class)); + } @Test public void testStringToEnumSet() throws Exception {