Skip to content

[Hackathon] Create SdkExtensionMethod annotation #3066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package software.amazon.awssdk.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

/**
* {@link SdkExtensionMethod} indicates a method that has been explicitly added to a service client interface on behalf of the
* SDK. While most service clients are automatically and fully generated based upon the corresponding service's API model, the SDK
* may sometimes choose to extend a service's logical API in order to provide improved abstractions or convenience functions. As
* such, {@link SdkExtensionMethod} implementations may invoke one or more service requests to fulfil their behavior.
*/
@Target(ElementType.METHOD)
@SdkProtectedApi
public @interface SdkExtensionMethod {
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

package software.amazon.awssdk.services.s3.extensions;

import software.amazon.awssdk.annotations.SdkExtensionMethod;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.NoSuchBucketException;
Expand All @@ -36,6 +37,7 @@ public interface S3ClientExtensionMethods {
* @return true if the bucket exists and you have permission to access it; false if the bucket does not exist
* @throws S3Exception if the bucket exists but is not accessible
*/
@SdkExtensionMethod
default boolean doesBucketExist(String bucketName) {
Validate.notNull(bucketName, "bucketName");
S3Client s3Client = (S3Client) this;
Expand Down