How to assign bean's property an Enum value in Spring config file?

JavaSpring

Java Problem Overview


I have a standalone enum type defined, something like this:

package my.pkg.types;

public enum MyEnumType {
    TYPE1,
    TYPE2
}

Now, I want to inject a value of that type into a bean property:

<bean name="someName" class="my.pkg.classes">
   <property name="type" value="my.pkg.types.MyEnumType.TYPE1" />
</bean>

...and that didn't work :(

How should I Inject an Enum into a spring bean?

Java Solutions


Solution 1 - Java

Have you tried just "TYPE1"? I suppose Spring uses reflection to determine the type of "type" anyway, so the fully qualified name is redundant. Spring generally doesn't subscribe to redundancy!

Solution 2 - Java

Use the value child element instead of the value attribute and specify the Enum class name:

<property name="residence">
    <value type="SocialSecurity$Residence">ALIEN</value>
</property>

The advantage of this approach over just writing value="ALIEN" is that it also works if Spring can't infer the actual type of the enum from the property (e.g. the property's declared type is an interface).Adapted from araqnid's comment.

Solution 3 - Java

I know this is a really old question, but in case someone is looking for the newer way to do this, use the spring util namespace:

<util:constant static-field="my.pkg.types.MyEnumType.TYPE1" />

As described in the spring documentation.

Solution 4 - Java

You can just do "TYPE1".

Solution 5 - Java

This is what did it for me MessageDeliveryMode is the enum the bean will have the value PERSISTENT:

<bean class="org.springframework.amqp.core.MessageDeliveryMode" factory-method="valueOf">
	<constructor-arg value="PERSISTENT" />
</bean>

Solution 6 - Java

Using SPEL and P-NAMESPACE:

<beans...
xmlns:p="http://www.springframework.org/schema/p" ...>
..
<bean name="someName" class="my.pkg.classes"
    p:type="#{T(my.pkg.types.MyEnumType).TYPE1}"/>

Solution 7 - Java

To be specific, set the value to be the name of a constant of the enum type, e.g., "TYPE1" or "TYPE2" in your case, as shown below. And it will work:

<bean name="someName" class="my.pkg.classes">
   <property name="type" value="TYPE1" />
</bean>

Solution 8 - Java

You can write Bean Editors (details are in the Spring Docs) if you want to add further value and write to custom types.

Solution 9 - Java

Spring-integration example, routing based on a an Enum field:

public class BookOrder {

    public enum OrderType { DELIVERY, PICKUP } //enum
    public BookOrder(..., OrderType orderType) //orderType
    ...

config:

<router expression="payload.orderType" input-channel="processOrder">
    <mapping value="DELIVERY" channel="delivery"/>
    <mapping value="PICKUP" channel="pickup"/>
</router>

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionxelurgView Question on Stackoverflow
Solution 1 - JavakrosenvoldView Answer on Stackoverflow
Solution 2 - JavaTseringView Answer on Stackoverflow
Solution 3 - JavaLucasView Answer on Stackoverflow
Solution 4 - JavaJacob MattisonView Answer on Stackoverflow
Solution 5 - JavaGeorgeView Answer on Stackoverflow
Solution 6 - JavaPaul RooneyView Answer on Stackoverflow
Solution 7 - JavaYuciView Answer on Stackoverflow
Solution 8 - JavaFortyrunnerView Answer on Stackoverflow
Solution 9 - JavaMike RView Answer on Stackoverflow