com.helger.commons.annotations

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 rturned and is mutable, please use the ReturnsMutableCopy annotation.

Author:

Philip Helger

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	reason Developer comment to explain why the mutable object is returned.

Element Detail

reason

public abstract String reason

Developer comment to explain why the mutable object is returned.