CODEWITHSUNDEEP
javaspring
xelurg
xelurg

Reputation: 4304

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

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?

Upvotes: 115

Views: 145862

Answers (10)

exploder86
exploder86

Reputation: 61

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>

Upvotes: 0

krosenvold
krosenvold

Reputation: 77201

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!

Upvotes: 133

Yuci
Yuci

Reputation: 30149

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>

Upvotes: 1

Tsering
Tsering

Reputation: 549

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.

Upvotes: 45

Paul Rooney
Paul Rooney

Reputation: 111

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

Upvotes: 5

Mike R
Mike R

Reputation: 4538

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>

Upvotes: 0

George
George

Reputation: 319

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>

Upvotes: 6

Lucas
Lucas

Reputation: 14969

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.

Upvotes: 35

Fortyrunner
Fortyrunner

Reputation: 12782

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

Upvotes: 0

Jacob Mattison
Jacob Mattison

Reputation: 51062

You can just do "TYPE1".

Upvotes: 12

Related Questions