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

Question

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?

score 133 · Accepted Answer · edited May 04 '18 at 13:33

133

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!

edited May 04 '18 at 13:33

Michael

41,989
11
82
128

answered Feb 05 '09 at 17:18

krosenvold

75,535
32
152
208

1

Pretty strange that the fully qualified name doesn't work. – Ryan Stull May 24 '18 at 15:41
But what if I want to use something like "${tes.db.database:ORACLE}" , i.e defaulting a property. It fails to work. Please help – Shubhi224 Aug 09 '18 at 07:10

score 46 · Answer 2 · edited Sep 23 '15 at 14:13

46

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.}

edited Sep 23 '15 at 14:13

sleske

81,358
34
189
227

answered Jan 28 '10 at 20:35

Tsering

559
4
2

6

This works if Spring can't infer the actual type of the enum from the property (e.g. the property is just an interface) – araqnid Jan 19 '11 at 11:42
@araqnid: Good point. I took the liberty of adding it to the answer. – sleske Sep 23 '15 at 14:13
@Tsering : Can I use Spring EL within value tag? ${abc:ALIEN} – Shubhi224 Aug 09 '18 at 07:15

score 35 · Answer 3 · answered Jul 11 '12 at 23:27

35

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.

answered Jul 11 '12 at 23:27

Lucas

14,227
9
74
124

score 12 · Answer 4 · answered Feb 05 '09 at 17:22

12

You can just do "TYPE1".

answered Feb 05 '09 at 17:22

Jacob Mattison

50,258
9
107
126

score 6 · Answer 5 · answered Jul 04 '13 at 12:48

6

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>

answered Jul 04 '13 at 12:48

George

309
3
6

score 5 · Answer 6 · answered Jun 17 '15 at 08:36

5

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}"/>

answered Jun 17 '15 at 08:36

Paul Rooney

111
1
5

score 1 · Answer 7 · answered Feb 03 '17 at 11:33

1

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>

answered Feb 03 '17 at 11:33

Yuci

27,235
10
114
113

score 0 · Answer 8 · answered Aug 20 '13 at 04:48

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>

score 0 · Answer 9 · answered Feb 06 '09 at 23:50

0

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

answered Feb 06 '09 at 23:50

Fortyrunner

12,702
4
31
54

score 0 · Answer 10 · answered Dec 15 '22 at 16:09

If you have enum:

package my.pkg.types;

public enum MyEnumType {
    TYPE1,
    TYPE2
}

You may instantiate it as a bean within this xml config

<bean name="someName" class="my.pkg.types.MyEnumType" factory-method="valueOf">
    <constructor-arg value="TYPE1"/>
</bean>

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

10 Answers10

Linked