Package org.beanio.annotation

Annotation Type Record

  • @Retention(RUNTIME)
@Target({TYPE,FIELD,METHOD})
public @interface Record
    Record annotation for classes, and for fields and methods in a class annotated by Group.
    Since:
    2.1.0

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.Class<?> collection
      The collection type for repeating records bound to a group class, if it cannot be determined from the annotated field or method declaration.
      java.lang.String getter
      The getter method on its parent group class.
      int maxLength
      The validated maximum length of the record.
      int maxOccurs
      The maximum occurrences of the record.
      int maxRidLength
      The maximum length of this record used to identify it.
      int minLength
      The validated minimum length of the record.
      int minOccurs
      The minimum occurrences of the record
      int minRidLength
      The minimum length of this record used to identify it.
      java.lang.String name
      The record name.
      int order
      The order of this record within its parent group.
      java.lang.String setter
      The setter method on its parent group class.
      java.lang.Class<?> type
      The record type, if it cannot be determined from the annotated field or method declaration.
      java.lang.String value
      The name of child component to use for the value of this record in lieu of a type.
      java.lang.String xmlName
      The XML attribute or element name.
      java.lang.String xmlNamespace
      The XML namespace URI of this record.
      java.lang.String xmlPrefix
      The XML namespace prefix of this record.
      XmlType xmlType
      The XML type of this record.

    • Element Detail

      • name

        java.lang.String name
        The record name.
        Returns:
        the record name
        Default:
        ""

      • getter

        java.lang.String getter
        The getter method on its parent group class.
        Returns:
        the method name
        Default:
        ""

      • setter

        java.lang.String setter
        The setter method on its parent group class.
        Returns:
        the method name
        Default:
        ""

      • type

        java.lang.Class<?> type
        The record type, if it cannot be determined from the annotated field or method declaration.
        Returns:
        the class type
        Default:
        java.lang.Void.class

      • collection

        java.lang.Class<?> collection
        The collection type for repeating records bound to a group class, if it cannot be determined from the annotated field or method declaration.
        Returns:
        the collection type
        Default:
        java.lang.Void.class

      • minRidLength

        int minRidLength
        The minimum length of this record used to identify it.
        Returns:
        the minimum length
        Default:
        -2147483648

      • maxRidLength

        int maxRidLength
        The maximum length of this record used to identify it.
        Returns:
        the maximum length
        Default:
        -2147483648

      • minLength

        int minLength
        The validated minimum length of the record.
        Returns:
        the minimum length
        Default:
        -2147483648

      • maxLength

        int maxLength
        The validated maximum length of the record.
        Returns:
        the maximum length
        Default:
        -2147483648

      • minOccurs

        int minOccurs
        The minimum occurrences of the record
        Returns:
        the minimum occurrences
        Default:
        -2147483648

      • maxOccurs

        int maxOccurs
        The maximum occurrences of the record.
        Returns:
        the maximum occurrences
        Default:
        -2147483648

      • order

        int order
        The order of this record within its parent group.
        Returns:
        the order
        Default:
        -2147483648

      • value

        java.lang.String value
        The name of child component to use for the value of this record in lieu of a type.
        Returns:
        the component name of the value
        Default:
        ""

      • xmlType

        XmlType xmlType
        The XML type of this record.
        Returns:
        the XmlType
        Default:
        org.beanio.builder.XmlType.DEFAULT

      • xmlName

        java.lang.String xmlName
        The XML attribute or element name.
        Returns:
        the XML name
        Default:
        "{undefined}"

      • xmlPrefix

        java.lang.String xmlPrefix
        The XML namespace prefix of this record.
        Returns:
        the namespace prefix
        Default:
        "{undefined}"

      • xmlNamespace

        java.lang.String xmlNamespace
        The XML namespace URI of this record.
        Returns:
        the namespace URI
        Default:
        "{undefined}"