Package com.helger.commons.annotation

Annotation Type ReturnsMutableObject

@Retention(CLASS) @Target(METHOD) @Documented public @interface ReturnsMutableObject
Indicates that a method returns a mutable object. This annotation is meant to indicate that the internal object is returned in a mutable way. If a copy of the internal object is returned and is mutable, please use the ReturnsMutableCopy annotation.
Author:
Philip Helger

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
     

  • Element Details

    • value

      String value
      Returns:
      developer comment to explain why the mutable object is returned.
      Default:
      ""