Modifier and Type	Class and Description
public static @interface	Meta.AD The AD element in the Metatype specification.
public static @interface	Meta.OCD The OCD Annotation maps to the OCD element in the Metatype specification.
public static enum	Meta.Type

Modifier and Type	Field and Description
public static final String	NULL Constant NULL for default usage

NULL	back to summary
public static final String NULL Constant NULL for default usage

aQute.bnd.annotation.metatype back to summary

public @Interface Meta.AD

Annotations

@Target:METHOD
@Retention:RUNTIME

The AD element in the Metatype specification.

Method Summary

Modifier and Type	Method and Description
public int	Returns: the cardinality of the attribute cardinality() The cardinality of the attribute.
public String	Returns: the default value deflt() The default value.
public String	Returns: The description of the attribute. description() A description of the attribute.
public String	Returns: the id id() The id of the attribute.
public String	Returns: the max value max() The maximum value.
public String	Returns: the min value min() The minimum value.
public String	Returns: the name name() The name of the attribute.
public String[]	Returns: the option labels optionLabels() Provide labels for options.
public String[]	Returns: the option labels optionValues() The values of options.
public boolean	required() Indicates that this attribute is required.
public Meta.Type	Returns: the type to be used. type() The type of the field.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

cardinality	back to summary
public int cardinality() The cardinality of the attribute. If not explicitly set it will be derived from the attributes return type. Collections return Integer.MIN_VALUE and arrays use Integer.MAX_VALUE. If a single string needs to be converted to a Collection or array then the \| will be used as a separator to split the line. Returns:int the cardinality of the attribute

cardinality

back to summary

public int cardinality()

The cardinality of the attribute. If not explicitly set it will be derived from the attributes return type. Collections return Integer.MIN_VALUE and arrays use Integer.MAX_VALUE. If a single string needs to be converted to a Collection or array then the | will be used as a separator to split the line.

Returns:int: the cardinality of the attribute

deflt	back to summary
public String deflt() The default value. This value must be converted to the return type of the attribute. For multi valued returns use the \| as separator. Returns:String the default value

deflt

back to summary

public String deflt()

The default value. This value must be converted to the return type of the attribute. For multi valued returns use the | as separator.

Returns:String: the default value

description	back to summary
public String description() A description of the attribute. Default is empty. Returns:String The description of the attribute.

description

back to summary

public String description()

A description of the attribute. Default is empty.

Returns:String: The description of the attribute.

id	back to summary
public String id() The id of the attribute. By default the name of the method. The id is the key used to access the properties. This is the reason the AD is a runtime annotation so the runtime can find the proper key. Returns:String the id

back to summary

public String id()

The id of the attribute. By default the name of the method. The id is the key used to access the properties. This is the reason the AD is a runtime annotation so the runtime can find the proper key.

Returns:String: the id

max	back to summary
public String max() The maximum value. This string must be converted to the attribute type before comparison takes place. Returns:String the max value

max

back to summary

public String max()

The maximum value. This string must be converted to the attribute type before comparison takes place.

Returns:String: the max value

min	back to summary
public String min() The minimum value. This string must be converted to the attribute type before comparison takes place. Returns:String the min value

min

back to summary

public String min()

The minimum value. This string must be converted to the attribute type before comparison takes place.

Returns:String: the min value

name	back to summary
public String name() The name of the attribute. By default the un-camel cased version of the method name. Returns:String the name

name

back to summary

public String name()

The name of the attribute. By default the un-camel cased version of the method name.

Returns:String: the name

optionLabels	back to summary
public String[] optionLabels() Provide labels for options. These labels must match the values. If no labels are set, the un-cameled version of the values are used (if they are set of course). Returns:String[] the option labels

optionLabels

back to summary

public String[] optionLabels()

Provide labels for options. These labels must match the values. If no labels are set, the un-cameled version of the values are used (if they are set of course).

Returns:String[]: the option labels

optionValues	back to summary
public String[] optionValues() The values of options. If not set and the return type is an enum class then the values will be derived from this return type. Returns:String[] the option labels

optionValues

back to summary

public String[] optionValues()

The values of options. If not set and the return type is an enum class then the values will be derived from this return type.

Returns:String[]: the option labels

required	back to summary
public boolean required() Indicates that this attribute is required. By default attributes are required.

type	back to summary
public Meta.Type type() The type of the field. This must be one of the basic types in the metatype specification. By default, the type is derived from the return type of the method. This includes most collections and arrays. Unrecognized types are defaulted to String. Returns:Meta.Type the type to be used.

type

back to summary

public Meta.Type type()

The type of the field. This must be one of the basic types in the metatype specification. By default, the type is derived from the return type of the method. This includes most collections and arrays. Unrecognized types are defaulted to String.

Returns:Meta.Type: the type to be used.

aQute.bnd.annotation.metatype back to summary

public @Interface Meta.OCD

Annotations

extends Annotation

@Target:TYPE
@Retention:RUNTIME

The OCD Annotation maps to the OCD element in the Metatype specification. The only difference is that it is possible to create a Designate element as well.

Method Summary

Modifier and Type	Method and Description
public String	Returns: the description description() A description for this ocd.
public boolean	factory() Defines if this is for a factory or not.
public String	Returns: the id id() The id of the component.
public String	Returns: the localization prefix. localization() The localization prefix.
public String	Returns: The name of this component name() The name for this component.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

description	back to summary
public String description() A description for this ocd. The default is empty. Returns:String the description

description

back to summary

public String description()

A description for this ocd. The default is empty.

Returns:String: the description

factory	back to summary
public boolean factory() Defines if this is for a factory or not.

id	back to summary
public String id() The id of the component. Default the name of the class in FQN notation but with nested classes using the $ as separator (not .). The Felix webconsole always uses this id as the PID and not the pid in the Designate element. Reported as an error. Returns:String the id

back to summary

public String id()

The id of the component. Default the name of the class in FQN notation but with nested classes using the $ as separator (not .). The Felix webconsole always uses this id as the PID and not the pid in the Designate element. Reported as an error.

Returns:String: the id

localization	back to summary
public String localization() The localization prefix. The default localization prefix is the name of the class with a $ separator for nested classes. Returns:String the localization prefix.

localization

back to summary

public String localization()

The localization prefix. The default localization prefix is the name of the class with a $ separator for nested classes.

Returns:String: the localization prefix.

name	back to summary
public String name() The name for this component. The default name is a the short class name that us un-camel cased to make it more readable. Returns:String The name of this component

name

back to summary

public String name()

The name for this component. The default name is a the short class name that us un-camel cased to make it more readable.

Returns:String: The name of this component

aQute.bnd.annotation.metatype back to summary

public final Enum Meta.Type

Class Inheritance

extends Enum<Meta.Type>

java.lang.Object
java.lang.Enum
aQute.bnd.annotation.metatype.Meta.Type

Field Summary

Modifier and Type	Field and Description
public static final Meta.Type	Boolean
public static final Meta.Type	Byte
public static final Meta.Type	Character
public static final Meta.Type	Double
public static final Meta.Type	Float
public static final Meta.Type	Integer
public static final Meta.Type	Long
public static final Meta.Type	Password
public static final Meta.Type	Short
public static final Meta.Type	String

Constructor Summary

Access	Constructor and Description
private	Type()

Method Summary

Modifier and Type	Method and Description
public static Meta.Type	valueOf(String name)
public static Meta.Type[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

Boolean	back to summary
public static final Meta.Type Boolean

Byte	back to summary
public static final Meta.Type Byte

Character	back to summary
public static final Meta.Type Character

Double	back to summary
public static final Meta.Type Double

Float	back to summary
public static final Meta.Type Float

Integer	back to summary
public static final Meta.Type Integer

Long	back to summary
public static final Meta.Type Long

Password	back to summary
public static final Meta.Type Password

Short	back to summary
public static final Meta.Type Short

String	back to summary
public static final Meta.Type String

Constructor Detail

Type	back to summary
private Type()

Method Detail

valueOf	back to summary
public static Meta.Type valueOf(String name)

values	back to summary
public static Meta.Type[] values()

public Interface Meta

Nested and Inner Type Summary

Field Summary

Field Detail

public @Interface Meta.AD

Method Summary

Method Detail

public @Interface Meta.OCD

Method Summary

Method Detail

public final Enum Meta.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail