Adding @Deprecated annotation when API is marked as deprecated

[shorea]

This change generates the @deprecated annotation for all APIs marked as deprecated in the C2J model.

Motivation and Context

This adds clear guidance for deprecated APIs in the IDE.

N/A

Modifications

Modifies the code generator to add the @deprecated annotation to client/interface methods that correspond to a deprecated API.

Testing

Added deprecated trait to one of the existing poet test models and modified expected generation files.

Screenshots (if appropriate)

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• [ x] New feature (non-breaking change which adds functionality)

Checklist

• [ x] I have read the CONTRIBUTING document
• [x ] Local run of mvn install succeeds
• [x ] My code follows the code style of this project
• My change requires a change to the Javadoc documentation
• I have updated the Javadoc documentation accordingly
• [x ] I have added tests to cover my changes
• [x ] All new and existing tests passed
• I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
• My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

• [x ] I confirm that this pull request can be released under the Apache 2 license

[zoewangg]

Hey Andrew! 👋🏽

[zoewangg]

Looks like there's a deprecatedMessage field. Can we add it in the Javadocs?

[Bennett-Lynch]

We can probably update this utility class to support operation models as well:

aws-sdk-java-v2/codegen/src/main/java/software/amazon/awssdk/codegen/poet/model/DeprecationUtils.java

Lines 34 to 50 in a8ec3f8

	/**
	* If a given member is modeled as deprecated, add the {@link Deprecated} annotation to the method and, if the method
	* already has existing Javadoc, append a section with the {@code @deprecated} tag.
	*/
	public static MethodSpec checkDeprecated(MemberModel member, MethodSpec method) {
	if (!member.isDeprecated() || method.annotations.contains(DEPRECATED)) {
	return method;
	}
	MethodSpec.Builder builder = method.toBuilder().addAnnotation(DEPRECATED);
	if (!method.javadoc.isEmpty()) {
	builder.addJavadoc(LF + "@deprecated");
	if (StringUtils.isNotBlank(member.getDeprecatedMessage())) {
	builder.addJavadoc(" $L", member.getDeprecatedMessage());
	}
	}
	return builder.build();
	}

[shorea]

Oh nice @Bennett-Lynch this looks perfect, will make some tweaks to use that.

@zoewangg sure thing! :)

[shorea]

Added those changes. Let me know what you think!

[Bennett-Lynch]

LGTM!

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
2 Code Smells

89.7% Coverage
0.0% Duplication