Skip to content

chore: java doc improvements #285

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.

Sign up for GitHub

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
markjschreiber merged 1 commit into from
Nov 8, 2023
Merged

chore: java doc improvements #285

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions src/main/java/software/amazon/nio/spi/s3/util/S3FileSystemInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,16 @@

package software.amazon.nio.spi.s3.util;

import java.net.URI;
import software.amazon.awssdk.services.s3.internal.BucketUtils;

import java.net.URI;

/**
* Populates fields with information extracted by the S3 URI provided. This
* implementation is for standard AWS buckets as described in section
* "Accessing a bucket using S3://" in https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html
*
* "Accessing a bucket using S3://"
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html">here</a>
* <br>
* It also computes the file system key that can be used to identify a runtime
* instance of a S3FileSystem (for caching purposes for example). In this
* implementation the key is the bucket name (which is unique in the AWS S3
Expand All @@ -42,7 +44,8 @@ protected S3FileSystemInfo() {}

/**
* Creates a new instance and populates it with key and bucket. The name of
* the bucket must follow AWS S3 bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html)
* the bucket must follow AWS S3
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html">bucket naming rules</a>)
*
* @param uri a S3 URI
*
Expand Down