Package com.opencloud.tools.cgin.scenario.schema.annotations
This package defines annotations used to decorate the IN data type classes,
for consumption by CGIN scenario schema tool chain.
The adaptations provide information to help automate the building of schema types,
and methods to convert between the encoded and decoded forms.
See the AdaptationType annotation for an overview of usage.
-
Enum Summary Enum Description AdaptationConstraint AdaptationConstraints can be added to anAdaptationType
, to indicate a constraint which should be placed on the generated schema type. -
Annotation Types Summary Annotation Type Description AdaptationConstructor Marks the static method or constructor for creating an object of the annotated class, taking the adaptation fields as its parameter list.AdaptationDecoder Marks the static method or constructor for creating an object of the annotated class, taking the encoded form as a single parameter.AdaptationDescription Used to set a description for a schema adaptation type.AdaptationEncoder Marks the instance method to use for accessing the encoded form of an adaptation type.AdaptationForm Marks an adaptation field getter, setter or constructor parameter as representing a particular form, for example "encoded", "decoded", "standard", or "hex".AdaptationGetter Marks a method as being a getter method for a given adaptation field.AdaptationNullable Fields of an adaptation class which are optional (whose values may be null) mark their getter methods with the @AdaptationNullable annotation.AdaptationOrder AdaptationOrder annotations are added toAdaptationGetter
methods to determine the order of fields in the generated schema types.AdaptationParameter Used in conjunction with anAdaptationConstructor
annotation, to mark a single parameter of the constructor or method with the name of the corresponding adaptation field.AdaptationPresenceIndicator Marks a method as being a presence indicator setter or getter method for a given adaptation field.AdaptationSetter Marks a method as being a setter method for a given adaptation field.AdaptationType Used to mark a class as available for use as an "adaptation type", a data structure which is able to store a representation of a protocol data type in some structured form, and expose that structure of the type to the tools used to generate scenario schema adaptations.AdaptationVariants Indicates a particular protocol or schema variant to which a method applies.