org.apache.felix.dm.annotation.api

Annotation Type Property

@Retention(value=CLASS)
 @Target(value={TYPE,ANNOTATION_TYPE})
 @Repeatable(value=RepeatableProperty.class)
public @interface Property

Annotation used to describe a property key-value(s) pair. It is used for example when declaring Component.properties() attribute.

Property value(s) type is String by default, and the type is scalar if the value is single-valued, or an array if the value is multi-valued. You can apply this annotation on a component class multiple times (it's a java8 repeatable property). Eight primitive types are supported:

• String (default type)
• Long
• Double
• Float
• Integer
• Byte
• Boolean
• Short

You can specify the type of a property either using a combination of value and type attributes, or using one of the longValue/doubleValue/floatValue/intValue/byteValue/charValue/booleanValue/shortValue attributes. Notice that you can also specify service properties dynamically by returning a Map from a method annotated with Start.

Usage Examples

 @Component
 @Property(name="p1", value="v")                      // String value type (scalar)
 @Property(name="p2", value={"s1", "s2"})             // Array of Strings
 @Property(name="service.ranking", intValue=10)       // Integer value type (scalar)
 @Property(name="p3", intValue={1,2})                 // Array of Integers
 @Property(name="p3", value="1", type=Long.class)     // Long value (scalar)
 class ServiceImpl implements Service {
 }
 

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name Returns the property name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean[]	booleanValue A Boolean value or an array of Boolean values.
byte[]	byteValue A Byte value or an array of Byte values.
char[]	charValue A Character value or an array of Character values.
double[]	doubleValue A Double value or an array of Double values.
float[]	floatValue A Float value or an array of Float values.
int[]	intValue An Integer value or an array of Integer values.
long[]	longValue A Long value or an array of Long values.
short[]	shortValue A Short value or an array of Short values.
java.lang.Class<?>	type Specifies how the value() or values() attributes are parsed.
java.lang.String[]	value Returns the property value(s).
java.lang.String[]	values Deprecated. use value() attribute.

Element Detail

name

public abstract java.lang.String name

Returns the property name.

Returns:

this property name

value

public abstract java.lang.String[] value

Returns the property value(s). The property value(s) is (are) parsed using the valueOf method of the class specified in the #type attribute (which is String by default). When the property value is single-value, then the value type is scalar (not an array). If the property value is multi-valued, then the value type is an array of the type specified in the type() attribute (String by default).

Returns:

this property value(s).

Default:

{}

type

public abstract java.lang.Class<?> type

Specifies how the value() or values() attributes are parsed.

Returns:

the property value type (String by default) used to parse value() or values() attribtues

Default:

java.lang.String.class

longValue

public abstract long[] longValue

A Long value or an array of Long values.

Returns:

the long value(s).

Default:

{}

doubleValue

public abstract double[] doubleValue

A Double value or an array of Double values.

Returns:

the double value(s).

Default:

{}

floatValue

public abstract float[] floatValue

A Float value or an array of Float values.

Returns:

the float value(s).

Default:

{}

intValue

public abstract int[] intValue

An Integer value or an array of Integer values.

Returns:

the int value(s).

Default:

{}

byteValue

public abstract byte[] byteValue

A Byte value or an array of Byte values.

Returns:

the byte value(s).

Default:

{}

charValue

public abstract char[] charValue

A Character value or an array of Character values.

Returns:

the char value(s).

Default:

{}

booleanValue

public abstract boolean[] booleanValue

A Boolean value or an array of Boolean values.

Returns:

the boolean value(s).

Default:

{}

shortValue

public abstract short[] shortValue

A Short value or an array of Short values.

Returns:

the short value(s).

Default:

{}

values

public abstract java.lang.String[] values

Deprecated. use value() attribute.

Returns an array of property values. The property value are parsed using the valueOf method of the class specified in the #type attribute (which is String by default).

Returns:

an array of property values.

Default:

{}