Module dev.metaschema.databind
Package dev.metaschema.databind.model.annotations

Annotation Type BoundFlag

@Documented @Retention(RUNTIME) @Target({FIELD,METHOD}) public @interface BoundFlag
Identifies that the annotation target is a bound property that represents a Module flag.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    defaultValue
    The default value of the flag represented as a string.
    String
    description
    Get the documentary description of the flag.
    String
    formalName
    Get the documentary formal name of the flag.
    String
    name
    The model name to use for singleton values.
    Property[]
    properties
    An optional set of associated properties.
    String
    remarks
    Get any remarks for this flag.
    boolean
    required
    Specifies if the XML Schema attribute is optional or required.
    Class<? extends dev.metaschema.core.datatype.IDataTypeAdapter<?>>
    typeAdapter
    The Module data type adapter for the field's value.
    int
    useIndex
    The binary use name of the flag.
    ValueConstraints
    valueConstraints
    Get the value constraints defined for this Metaschema flag inline definition.

  • Element Details

    • formalName

      @NonNull String formalName
      Get the documentary formal name of the flag.

      If the value is "##none", then the description will be considered null.

      Returns:
      a markdown string or "##none" if no formal name is provided
      Default:
      "##none"

    • description

      @NonNull String description
      Get the documentary description of the flag.

      If the value is "##none", then the description will be considered null.

      Returns:
      a markdown string or "##none" if no description is provided
      Default:
      "##none"

    • name

      @NonNull String name
      The model name to use for singleton values. This name will be used for associated XML attributes and JSON properties.

      If the value is "##none", then element name is derived from the JavaBean property name.

      Returns:
      the name
      Default:
      "##none"

    • useIndex

      int useIndex
      The binary use name of the flag.

      The value Integer.MIN_VALUE indicates that there is no use name.

      Returns:
      the index value
      Default:
      -2147483648

    • defaultValue

      @NonNull String defaultValue
      The default value of the flag represented as a string.

      The value ModelUtil.NULL_VALUE is used to indicate if no default value is provided.

      Returns:
      the default value
      Default:
      "\u0000"

    • required

      boolean required
      Specifies if the XML Schema attribute is optional or required. If true, then the JavaBean property is mapped to a XML Schema attribute that is required. Otherwise it is mapped to a XML Schema attribute that is optional.
      Returns:
      true if the flag must occur, or false otherwise
      Default:
      false

    • typeAdapter

      @NonNull Class<? extends dev.metaschema.core.datatype.IDataTypeAdapter<?>> typeAdapter
      The Module data type adapter for the field's value.
      Returns:
      the data type adapter
      Default:
      dev.metaschema.databind.model.annotations.NullJavaTypeAdapter.class

    • properties

      Property[] properties
      An optional set of associated properties.
      Returns:
      the properties or an empty array with no properties
      Default:
      {}

    • remarks

      @NonNull String remarks
      Get any remarks for this flag.
      Returns:
      a markdown string or "##none" if no remarks are provided
      Default:
      "##none"

    • valueConstraints

      ValueConstraints valueConstraints
      Get the value constraints defined for this Metaschema flag inline definition.
      Returns:
      the value constraints
      Default:
      @dev.metaschema.databind.model.annotations.ValueConstraints