net.openhft.chronicle.core.annotation

Annotation Type ScopeConfined

@Documented
 @Retention(value=RUNTIME)
 @Target(value={METHOD,FIELD,PARAMETER,LOCAL_VARIABLE,TYPE_USE})
public @interface ScopeConfined

Indicates that the value consumer, value mapper, structure etc. should not make the object available outside the annotated scope. The meaning of "the object" should also be construed to include any and all descendant non-immutable Object properties recursively dereferenced from the original object.

In other words, object contents would be purposely overwritten after they are passed to the receiver and consequently cannot be kept after the invocation.

This annotation can be used for entities that are dealing with reused-objects. The term make available also includes making the object or any of its descendant objects available to another Thread.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	value Returns a comment as to why this value must meet the condition.

Element Detail

value

public abstract String value

Returns a comment as to why this value must meet the condition.

Returns:

a comment as to why this value must meet the condition

Default:

""