Module org.mule.sdk.api

Package org.mule.sdk.api.annotation.deprecated

Annotation Interface Deprecated

@Target({TYPE,FIELD,METHOD,PARAMETER})
@Retention(RUNTIME)
@Documented
@MinMuleVersion("4.5.0")
@DoNotEnforceMinMuleVersion
public @interface Deprecated

Indicated that the current annotated member is deprecated from the extension. This annotation can be applied to: Operations, Parameters, Sources, Scopes, Routers, Functions, Configuration, Connection Providers and Extensions.

Since:

1.0

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	message
String	since

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	toRemoveIn

Element Details

message

String message

Returns:

a String that describes why something was deprecated, what can be used as substitute, or both.

since

String since

Returns:

a String which is the version of the extension in which the annotated member was deprecated.

toRemoveIn

String toRemoveIn

Returns:

a String which is the version of the extension in which the annotated member will be removed or is removed.

Default:

""