org.omg.dds.type

Annotation Type SerializeAs

@Documented
@Retention(value=RUNTIME)
@Target(value={TYPE,ANNOTATION_TYPE,FIELD,METHOD})
public @interface SerializeAs

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
TypeKind	value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
long[]	bound The collection's or bit set's bound(s), if any, if this annotation is applied to a collection or bit set, or an empty array if not.
TypeKind	collectionElementKind The type of the elements to be stored in a collection (string, sequence, or map) or TypeKind.NO_TYPE if this annotation is not applied to a collection.
TypeKind	mapKeyElementKind The type of the "key" elements to be stored in a map or TypeKind.NO_TYPE if this annotation is not applied to a map.

Element Detail

value

public abstract TypeKind value

collectionElementKind

public abstract TypeKind collectionElementKind

The type of the elements to be stored in a collection (string, sequence, or map) or TypeKind.NO_TYPE if this annotation is not applied to a collection. If this annotation is applied to a map, it indicates the type of the map's "value" elements.

Default:

org.omg.dds.type.TypeKind.NO_TYPE

mapKeyElementKind

public abstract TypeKind mapKeyElementKind

The type of the "key" elements to be stored in a map or TypeKind.NO_TYPE if this annotation is not applied to a map.

Default:

org.omg.dds.type.TypeKind.NO_TYPE

bound

public abstract long[] bound

The collection's or bit set's bound(s), if any, if this annotation is applied to a collection or bit set, or an empty array if not. Strings, sequences, and maps have a bound with a single value; an empty array indicates an unbounded collection. Bit sets have a mandatory bound of a single value. Arrays may be multidimensional; each element of the array corresponds to one of these dimensions.

Default:

{}