com.helger.commons.annotation

Annotation Type ReturnsMutableObject

@Retention(value=CLASS)
@Target(value=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

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value

Element Detail

value

public abstract String value

Returns:

developer comment to explain why the mutable object is returned.