Skip to content

Commit

Permalink
Fix Java 21 Javadocs (#43107)
Browse files Browse the repository at this point in the history
Fix Java 21 Javadocs
  • Loading branch information
alzimmermsft authored Nov 26, 2024
1 parent 7a84cea commit 498b14a
Show file tree
Hide file tree
Showing 193 changed files with 2,641 additions and 829 deletions.
1 change: 0 additions & 1 deletion sdk/identity/azure-identity-broker/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
--add-exports com.azure.core/com.azure.core.implementation.util=ALL-UNNAMED
--add-exports com.azure.core/com.azure.core.implementation=com.azure.identity.broker
</javaModulesSurefireArgLine>
<doclintMissingInclusion>-</doclintMissingInclusion>
<checkstyle.suppressionsLocation>checkstyle-suppressions.xml</checkstyle.suppressionsLocation>

<spotbugs.skip>false</spotbugs.skip>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@
* <!-- end com.azure.identity.broker.interactivebrowserbrokercredentialbuilder.construct -->
*/
public class InteractiveBrowserBrokerCredentialBuilder extends InteractiveBrowserCredentialBuilder {
/**
* Creates a new instance of {@link InteractiveBrowserBrokerCredentialBuilder}.
*/
public InteractiveBrowserBrokerCredentialBuilder() {
}

/**
* Sets the parent window handle used by the broker. For use on Windows only.
*
Expand Down
1 change: 0 additions & 1 deletion sdk/storage/azure-storage-blob-batch/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@

<spotbugs.skip>false</spotbugs.skip>
<spotbugs.excludeFilterFile>spotbugs-exclude.xml</spotbugs.excludeFilterFile>
<doclintMissingInclusion>-</doclintMissingInclusion>
</properties>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
*/
@Fluent
public class BlobBatchSetBlobAccessTierOptions {

private static final ClientLogger LOGGER = new ClientLogger(BlobBatchSetBlobAccessTierOptions.class);

private final BlobUrlParts blobUrlParts;
Expand All @@ -26,8 +25,11 @@ public class BlobBatchSetBlobAccessTierOptions {
private String tagsConditions;

/**
* Creates a new instance of {@link BlobBatchSetBlobAccessTierOptions}.
*
* @param blobUrl Url of the blob to set access tier. Blob names must be encoded to UTF-8.
* @param tier {@link AccessTier} to set on each blob.
* @throws NullPointerException If {@code blobUrl} or {@code tier} is null.
*/
public BlobBatchSetBlobAccessTierOptions(String blobUrl, AccessTier tier) {
StorageImplUtils.assertNotNull("blobUrl", blobUrl);
Expand All @@ -37,9 +39,12 @@ public BlobBatchSetBlobAccessTierOptions(String blobUrl, AccessTier tier) {
}

/**
* Creates a new instance of {@link BlobBatchSetBlobAccessTierOptions}.
*
* @param containerName Name of the container to set access tier.
* @param blobName Name of the blob to set access tier. Blob names must be encoded to UTF-8.
* @param tier {@link AccessTier} to set on each blob.
* @throws NullPointerException If {@code containerName}, {@code blobName}, or {@code tier} is null.
*/
public BlobBatchSetBlobAccessTierOptions(String containerName, String blobName, AccessTier tier) {
StorageImplUtils.assertNotNull("containerName", containerName);
Expand All @@ -52,27 +57,35 @@ public BlobBatchSetBlobAccessTierOptions(String containerName, String blobName,
}

/**
* Get the URL of the blob to set its access tier.
*
* @return Url of the blob to set its access tier.
*/
public String getBlobUrl() {
return blobUrlParts.toUrl().toString();
}

/**
* Gets the container name of the blob to set its access tier.
*
* @return Container of the blob to set its access tier.
*/
public String getBlobContainerName() {
return blobUrlParts.getBlobContainerName();
}

/**
* Gets the name of the blob to set its access tier.
*
* @return Name of the blob to set its access tier.
*/
public String getBlobName() {
return blobUrlParts.getBlobName();
}

/**
* Gets the identifier of the blob to set its access tier.
*
* @return Identifier of the blob to set its access tier.
*/
public String getBlobIdentifier() {
Expand All @@ -94,13 +107,17 @@ public String getBlobIdentifier() {
}

/**
* Gets the version id of the blob to set its access tier.
*
* @return Version id of the blob to set its access tier.
*/
public String getVersionId() {
return blobUrlParts.getVersionId();
}

/**
* Sets the version id of the blob to set its access tier.
*
* @param versionId Version id of the blob to set its access tier.
* @return The updated BlobBatchSetBlobsAccessTierOptions.
*/
Expand All @@ -110,13 +127,17 @@ public BlobBatchSetBlobAccessTierOptions setVersionId(String versionId) {
}

/**
* Gets the snapshot of the blob to set its access tier.
*
* @return Snapshot of the blob to set its access tier.
*/
public String getSnapshot() {
return blobUrlParts.getSnapshot();
}

/**
* Sets the snapshot of the blob to set its access tier.
*
* @param snapshot Snapshot of the blob to set its access tier.
* @return The updated BlobBatchSetBlobsAccessTierOptions.
*/
Expand All @@ -126,20 +147,26 @@ public BlobBatchSetBlobAccessTierOptions setSnapshot(String snapshot) {
}

/**
* Gets the tier to set for the blob.
*
* @return The new tier for the blob.
*/
public AccessTier getTier() {
return tier;
}

/**
* Gets the priority to set for re-hydrating blob.
*
* @return Priority to set for re-hydrating blob.
*/
public RehydratePriority getPriority() {
return priority;
}

/**
* Sets the priority to set for re-hydrating blob.
*
* @param priority Priority to set for re-hydrating blob.
* @return The updated BlobBatchSetBlobsAccessTierOptions.
*/
Expand All @@ -149,13 +176,17 @@ public BlobBatchSetBlobAccessTierOptions setPriority(RehydratePriority priority)
}

/**
* Gets the lease ID the active lease on the blob must match.
*
* @return The lease ID the active lease on the blob must match.
*/
public String getLeaseId() {
return leaseId;
}

/**
* Sets the lease ID the active lease on the blobs must match.
*
* @param leaseId The lease ID the active lease on the blobs must match.
* @return The updated BlobBatchSetBlobsAccessTierOptions.
*/
Expand All @@ -165,13 +196,17 @@ public BlobBatchSetBlobAccessTierOptions setLeaseId(String leaseId) {
}

/**
* Gets the SQL statement that apply to the tags of the blob.
*
* @return The SQL statement that apply to the tags of the blob.
*/
public String getTagsConditions() {
return tagsConditions;
}

/**
* Sets the SQL statement that apply to the tags of the blob.
*
* @param tagsConditions The SQL statement that apply to the tags of the blob.
* @return The updated BlobBatchSetBlobsAccessTierOptions.
*/
Expand Down
1 change: 0 additions & 1 deletion sdk/storage/azure-storage-blob-changefeed/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@

<spotbugs.skip>false</spotbugs.skip>
<spotbugs.excludeFilterFile>spotbugs-exclude.xml</spotbugs.excludeFilterFile>
<doclintMissingInclusion>-</doclintMissingInclusion>
</properties>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,41 +11,57 @@
public interface BlobChangefeedEvent {

/**
* Gets the topic.
*
* @return the topic.
*/
String getTopic();

/**
* Gets the subject.
*
* @return the subject.
*/
String getSubject();

/**
* Gets the {@link BlobChangefeedEventType}.
*
* @return {@link BlobChangefeedEventType}
*/
BlobChangefeedEventType getEventType();

/**
* Gets the {@link OffsetDateTime event time}.
*
* @return The {@link OffsetDateTime event time}.
*/
OffsetDateTime getEventTime();

/**
* Gets the identifier.
*
* @return the identifier.
*/
String getId();

/**
* Gets the {@link BlobChangefeedEventData}.
*
* @return {@link BlobChangefeedEventData}.
*/
BlobChangefeedEventData getData();

/**
* Gets the data version.
*
* @return the data version.
*/
Long getDataVersion();

/**
* Gets the metadata version.
*
* @return the metadata version.
*/
String getMetadataVersion();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,66 +11,92 @@
public interface BlobChangefeedEventData {

/**
* Gets the api.
*
* @return The api.
*/
String getApi();

/**
* Gets the client request id.
*
* @return The client request id.
*/
String getClientRequestId();

/**
* Gets the request id.
*
* @return The request id.
*/
String getRequestId();

/**
* Gets the eTag.
*
* @return The eTag.
*/
String getETag();

/**
* Gets the content type.
*
* @return The content type.
*/
String getContentType();

/**
* Gets the content length.
*
* @return The content length.
*/
Long getContentLength();

/**
* Gets the {@link BlobType}.
*
* @return {@link BlobType}.
*/
BlobType getBlobType();

/**
* Gets the content offset.
*
* @return The content offset.
*/
Long getContentOffset();

/**
* Gets the destination url.
*
* @return The destination url.
*/
String getDestinationUrl();

/**
* Gets the source url.
*
* @return The source url.
*/
String getSourceUrl();

/**
* Gets the blob url.
*
* @return The blob url.
*/
String getBlobUrl();

/**
* @return Whether or not this operation was recursive.
* Gets whether this operation was recursive.
*
* @return Whether this operation was recursive.
*/
boolean isRecursive();

/**
* Gets the sequencer.
*
* @return The sequencer.
*/
String getSequencer();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@ public final class BlobChangefeedEventType extends ExpandableStringEnum<BlobChan
*/
public static final BlobChangefeedEventType BLOB_DELETED = fromString("BlobDeleted");

/**
* Creates a new instance of {@link BlobChangefeedEventType} with no string value.
*
* @deprecated Please use {@link #fromString(String)} to create an instance of BlobChangefeedEventType.
*/
@Deprecated
public BlobChangefeedEventType() {
}

/**
* Creates or finds a BlobChangefeedEventType from its string representation.
*
Expand All @@ -33,6 +42,8 @@ public static BlobChangefeedEventType fromString(String name) {
}

/**
* Gets known BlobChangefeedEventType values.
*
* @return known BlobChangefeedEventType values.
*/
public static Collection<BlobChangefeedEventType> values() {
Expand Down
1 change: 0 additions & 1 deletion sdk/storage/azure-storage-blob-cryptography/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@

<spotbugs.skip>false</spotbugs.skip>
<spotbugs.excludeFilterFile>spotbugs-exclude.xml</spotbugs.excludeFilterFile>
<doclintMissingInclusion>-</doclintMissingInclusion>
</properties>

<dependencies>
Expand Down
Loading

0 comments on commit 498b14a

Please sign in to comment.