Package com.exedio.cope.instrument

Annotation Type Wrapper

@Repeatable(WrapperRepeated.class) @Target(FIELD) @Retention(SOURCE) public @interface Wrapper

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    wrap
    The name of the 'wrap' that is being configured.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    asFinal
    Makes the generated wrapper method final.
    boolean
    booleanAsIs
     
    boolean
    internal
    Appends "Internal" to the name of the generated wrapper method.
    boolean
    override
    Annotates the generated wrapper method with @Override.
    Class<?>[]
    parameters
    If several wrapper methods with the same wrap() get generated, but your Wrapper annotation should only affect one of them, it can be restricted by setting this field to the parameter list of the method.
    Visibility
    visibility
    Overrides the visibility of the generated wrapper method.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ALL_WRAPS
     

  • Field Details

  • Element Details

    • wrap

      String wrap
      The name of the 'wrap' that is being configured. Use wrap="*" to influence all wraps of the field.
      See Also:

    • parameters

      Class<?>[] parameters
      If several wrapper methods with the same wrap() get generated, but your Wrapper annotation should only affect one of them, it can be restricted by setting this field to the parameter list of the method.
      Default:
      {com.exedio.cope.instrument.WrapperParametersDefault.class}

    • visibility

      Visibility visibility
      Overrides the visibility of the generated wrapper method. The visibility defaults to the visibility of the feature, unless internal is set.
      Default:
      DEFAULT

    • internal

      boolean internal
      Appends "Internal" to the name of the generated wrapper method. So for instance getName becomes getNameInternal. Additionally changes the visibility to private, if visibility is set to DEFAULT.

      This is typically needed if you want to provide your own implementation of the generated method, but you still want to call the generated code.

      Default:
      false

    • booleanAsIs

      boolean booleanAsIs
      Default:
      false

    • asFinal

      boolean asFinal
      Makes the generated wrapper method final.
      Default:
      true

    • override

      boolean override
      Annotates the generated wrapper method with @Override.
      Default:
      false