From 0d99c5fadedb3a57265bc15fc29f5c5415487bde Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 16 Jul 2024 22:05:11 +0000 Subject: [PATCH] Deploy to GitHub pages --- allclasses-index.html | 1669 +++ allclasses.html | 320 + allpackages-index.html | 196 + .../b2/client/B2AccountAuthorizer.html | 270 + ...B2AccountAuthorizerSimpleImpl.Builder.html | 310 + .../client/B2AccountAuthorizerSimpleImpl.html | 327 + .../b2/client/B2AlreadyStoredPartStorer.html | 411 + .../b2/client/B2CancellableContentSource.html | 424 + .../b2/client/B2CancellationToken.html | 268 + .../b2/client/B2ClientConfig.Builder.html | 353 + com/backblaze/b2/client/B2ClientConfig.html | 417 + .../b2/client/B2CopyingPartStorer.html | 431 + .../b2/client/B2DefaultRetryPolicy.html | 407 + com/backblaze/b2/client/B2FilePolicy.html | 315 + .../b2/client/B2LargeFileStorer.html | 385 + .../b2/client/B2ListFileNamesIterable.html | 308 + .../b2/client/B2ListFileVersionsIterable.html | 308 + .../b2/client/B2ListFilesIterable.html | 223 + .../B2ListFilesIterableBase.IterBase.html | 335 + .../b2/client/B2ListFilesIterableBase.html | 321 + .../b2/client/B2ListKeysIterable.html | 325 + .../b2/client/B2ListKeysIterator.html | 298 + .../b2/client/B2ListPartsIterable.html | 223 + .../B2ListPartsIterableBase.IterBase.html | 335 + .../b2/client/B2ListPartsIterableBase.html | 321 + .../b2/client/B2ListPartsIterableImpl.html | 308 + .../B2ListUnfinishedLargeFilesIterable.html | 308 + com/backblaze/b2/client/B2PartSpec.html | 371 + com/backblaze/b2/client/B2PartStorer.html | 314 + com/backblaze/b2/client/B2RetryPolicy.html | 409 + com/backblaze/b2/client/B2Sdk.html | 328 + com/backblaze/b2/client/B2StorageClient.html | 2479 ++++ .../b2/client/B2StorageClientFactory.html | 333 + .../B2StorageClientFactoryPathBasedImpl.html | 294 + .../b2/client/B2StorageClientImpl.html | 2035 +++ .../b2/client/B2StorageClientWebifier.html | 999 ++ .../client/B2StorageClientWebifierImpl.html | 1109 ++ .../b2/client/B2UploadingPartStorer.html | 416 + .../B2ContentFileWriter.Builder.html | 282 + .../contentHandlers/B2ContentFileWriter.html | 357 + .../B2ContentMemoryWriter.Builder.html | 322 + .../B2ContentMemoryWriter.html | 434 + .../B2ContentOutputStreamWriter.Builder.html | 268 + .../B2ContentOutputStreamWriter.Helper.html | 365 + .../B2ContentOutputStreamWriter.html | 427 + .../client/contentHandlers/B2ContentSink.html | 278 + .../contentHandlers/B2ContentWriter.html | 431 + .../contentHandlers/package-summary.html | 224 + .../client/contentHandlers/package-tree.html | 177 + .../B2ByteArrayContentSource.Builder.html | 342 + .../B2ByteArrayContentSource.html | 433 + .../contentSources/B2ContentSource.html | 391 + .../client/contentSources/B2ContentTypes.html | 284 + .../B2FileContentSource.Builder.html | 288 + .../contentSources/B2FileContentSource.html | 429 + .../b2/client/contentSources/B2Headers.html | 1308 ++ .../contentSources/B2HeadersImpl.Builder.html | 324 + .../client/contentSources/B2HeadersImpl.html | 400 + .../contentSources/package-summary.html | 219 + .../client/contentSources/package-tree.html | 174 + .../credentialsSources/B2Credentials.html | 278 + .../B2CredentialsFromEnvironmentSource.html | 314 + .../credentialsSources/B2CredentialsImpl.html | 296 + .../B2CredentialsSource.html | 259 + .../credentialsSources/package-summary.html | 199 + .../credentialsSources/package-tree.html | 169 + .../exceptions/B2BadRequestException.html | 390 + .../exceptions/B2CannotComputeException.html | 332 + .../exceptions/B2ConnectFailedException.html | 354 + .../B2ConnectionBrokenException.html | 353 + .../b2/client/exceptions/B2Exception.html | 488 + .../exceptions/B2ForbiddenException.html | 392 + .../exceptions/B2InternalErrorException.html | 418 + .../client/exceptions/B2LocalException.html | 383 + .../exceptions/B2NetworkBaseException.html | 283 + .../client/exceptions/B2NetworkException.html | 354 + .../exceptions/B2NetworkTimeoutException.html | 354 + .../exceptions/B2NotFoundException.html | 405 + .../exceptions/B2RequestTimeoutException.html | 390 + .../client/exceptions/B2RuntimeException.html | 315 + .../B2ServiceUnavailableException.html | 390 + .../B2SignatureVerificationException.html | 370 + .../B2TooManyRequestsException.html | 390 + ...UnauthorizedException.RequestCategory.html | 393 + .../exceptions/B2UnauthorizedException.html | 465 + .../b2/client/exceptions/package-summary.html | 277 + .../b2/client/exceptions/package-tree.html | 213 + com/backblaze/b2/client/package-summary.html | 361 + com/backblaze/b2/client/package-tree.html | 218 + .../structures/B2AccountAuthorization.html | 491 + .../b2/client/structures/B2Allowed.html | 472 + .../client/structures/B2ApplicationKey.html | 453 + .../B2AuthorizationFilteredResponseField.html | 353 + .../B2AuthorizeAccountRequest.Builder.html | 310 + .../structures/B2AuthorizeAccountRequest.html | 399 + .../b2/client/structures/B2Bucket.html | 630 + .../structures/B2BucketDefaultRetention.html | 391 + .../B2BucketDefaultRetentionPeriod.html | 374 + .../B2BucketFileLockConfiguration.html | 434 + .../B2BucketReplicationConfiguration.html | 469 + .../B2BucketServerSideEncryption.html | 374 + .../b2/client/structures/B2BucketTypes.html | 274 + .../B2CancelLargeFileRequest.Builder.html | 308 + .../structures/B2CancelLargeFileRequest.html | 337 + .../structures/B2CancelLargeFileResponse.html | 376 + .../b2/client/structures/B2Capabilities.html | 705 + .../structures/B2CopyFileRequest.Builder.html | 436 + .../client/structures/B2CopyFileRequest.html | 543 + .../structures/B2CopyPartRequest.Builder.html | 354 + .../client/structures/B2CopyPartRequest.html | 411 + .../client/structures/B2CorsRule.Builder.html | 296 + .../b2/client/structures/B2CorsRule.html | 431 + .../B2CreateBucketRequest.Builder.html | 352 + .../structures/B2CreateBucketRequest.html | 455 + .../structures/B2CreateBucketRequestReal.html | 351 + .../B2CreateKeyRequest.Builder.html | 310 + .../client/structures/B2CreateKeyRequest.html | 395 + .../structures/B2CreateKeyRequestReal.html | 416 + .../structures/B2CreatedApplicationKey.html | 492 + .../B2DeleteBucketRequest.Builder.html | 308 + .../structures/B2DeleteBucketRequest.html | 337 + .../structures/B2DeleteBucketRequestReal.html | 356 + .../B2DeleteFileVersionRequest.Builder.html | 324 + .../B2DeleteFileVersionRequest.html | 411 + .../B2DeleteFileVersionResponse.html | 374 + .../B2DeleteKeyRequest.Builder.html | 308 + .../client/structures/B2DeleteKeyRequest.html | 377 + .../structures/B2DownloadAuthorization.html | 336 + .../B2DownloadByIdRequest.Builder.html | 394 + .../structures/B2DownloadByIdRequest.html | 478 + .../B2DownloadByNameRequest.Builder.html | 394 + .../structures/B2DownloadByNameRequest.html | 536 + .../client/structures/B2ErrorStructure.html | 356 + .../structures/B2EventNotification.html | 486 + .../structures/B2EventNotificationEvent.html | 554 + .../structures/B2EventNotificationRule.html | 502 + ...2EventNotificationTargetConfiguration.html | 314 + .../b2/client/structures/B2FileRetention.html | 442 + .../structures/B2FileRetentionMode.html | 265 + .../structures/B2FileRetentionPeriodUnit.html | 265 + .../structures/B2FileSseForRequest.html | 432 + .../structures/B2FileSseForResponse.html | 413 + .../b2/client/structures/B2FileVersion.html | 794 ++ .../B2FinishLargeFileRequest.Builder.html | 310 + .../structures/B2FinishLargeFileRequest.html | 395 + ...ucketNotificationRulesRequest.Builder.html | 308 + .../B2GetBucketNotificationRulesRequest.html | 355 + ...cketNotificationRulesResponse.Builder.html | 310 + .../B2GetBucketNotificationRulesResponse.html | 413 + ...tDownloadAuthorizationRequest.Builder.html | 410 + .../B2GetDownloadAuthorizationRequest.html | 453 + .../B2GetFileInfoByNameRequest.Builder.html | 282 + .../B2GetFileInfoByNameRequest.html | 426 + .../B2GetFileInfoRequest.Builder.html | 308 + .../structures/B2GetFileInfoRequest.html | 337 + .../B2GetUploadPartUrlRequest.Builder.html | 308 + .../structures/B2GetUploadPartUrlRequest.html | 337 + .../B2GetUploadUrlRequest.Builder.html | 308 + .../structures/B2GetUploadUrlRequest.html | 337 + .../structures/B2HideFileRequest.Builder.html | 310 + .../client/structures/B2HideFileRequest.html | 353 + .../b2/client/structures/B2LegalHold.html | 271 + .../structures/B2LifecycleRule.Builder.html | 350 + .../b2/client/structures/B2LifecycleRule.html | 398 + .../B2ListBucketsRequest.Builder.html | 350 + .../structures/B2ListBucketsRequest.html | 379 + .../structures/B2ListBucketsResponse.html | 340 + .../B2ListFileNamesRequest.Builder.html | 378 + .../structures/B2ListFileNamesRequest.html | 407 + .../structures/B2ListFileNamesResponse.html | 387 + .../B2ListFileVersionsRequest.Builder.html | 394 + .../structures/B2ListFileVersionsRequest.html | 421 + .../B2ListFileVersionsResponse.html | 403 + .../structures/B2ListFilesResponse.html | 274 + .../structures/B2ListKeysRequest.Builder.html | 336 + .../client/structures/B2ListKeysRequest.html | 393 + .../structures/B2ListKeysRequestReal.html | 377 + .../client/structures/B2ListKeysResponse.html | 356 + .../B2ListPartsRequest.Builder.html | 349 + .../client/structures/B2ListPartsRequest.html | 423 + .../structures/B2ListPartsResponse.html | 374 + ...stUnfinishedLargeFilesRequest.Builder.html | 363 + .../B2ListUnfinishedLargeFilesRequest.html | 439 + .../B2ListUnfinishedLargeFilesResponse.html | 387 + .../structures/B2OverrideableHeaders.html | 323 + .../b2/client/structures/B2Part.html | 454 + .../client/structures/B2ReplicationRule.html | 443 + .../structures/B2ReplicationStatus.html | 301 + .../B2ServerSideEncryptionMode.html | 265 + ...ucketNotificationRulesRequest.Builder.html | 310 + .../B2SetBucketNotificationRulesRequest.html | 371 + ...cketNotificationRulesResponse.Builder.html | 310 + .../B2SetBucketNotificationRulesResponse.html | 413 + .../B2StartLargeFileRequest.Builder.html | 389 + .../structures/B2StartLargeFileRequest.html | 462 + .../B2StoreLargeFileRequest.Builder.html | 282 + .../structures/B2StoreLargeFileRequest.html | 387 + .../b2/client/structures/B2TestMode.html | 406 + .../B2UpdateBucketRequest.Builder.html | 380 + .../structures/B2UpdateBucketRequest.html | 477 + .../B2UpdateFileLegalHoldRequest.Builder.html | 312 + .../B2UpdateFileLegalHoldRequest.html | 439 + .../B2UpdateFileLegalHoldResponse.html | 460 + .../B2UpdateFileRetentionRequest.Builder.html | 326 + .../B2UpdateFileRetentionRequest.html | 467 + .../B2UpdateFileRetentionResponse.html | 460 + .../B2UploadFileRequest.Builder.html | 368 + .../structures/B2UploadFileRequest.html | 433 + .../client/structures/B2UploadListener.html | 291 + .../B2UploadPartRequest.Builder.html | 282 + .../structures/B2UploadPartRequest.html | 367 + .../structures/B2UploadPartUrlResponse.html | 372 + .../client/structures/B2UploadProgress.html | 550 + .../b2/client/structures/B2UploadState.html | 442 + .../structures/B2UploadUrlResponse.html | 372 + .../structures/B2WebhookConfiguration.html | 446 + .../structures/B2WebhookCustomHeader.html | 401 + .../b2/client/structures/package-summary.html | 762 ++ .../b2/client/structures/package-tree.html | 309 + .../client/webApiClients/B2WebApiClient.html | 397 + .../client/webApiClients/package-summary.html | 164 + .../b2/client/webApiClients/package-tree.html | 161 + com/backblaze/b2/json/B2Json.constructor.html | 312 + .../B2Json.defaultForInvalidEnumValue.html | 190 + .../b2/json/B2Json.defaultForUnknownType.html | 243 + .../b2/json/B2Json.firstVersion.html | 241 + com/backblaze/b2/json/B2Json.html | 1470 ++ com/backblaze/b2/json/B2Json.ignored.html | 187 + com/backblaze/b2/json/B2Json.optional.html | 284 + .../b2/json/B2Json.optionalWithDefault.html | 321 + com/backblaze/b2/json/B2Json.required.html | 187 + com/backblaze/b2/json/B2Json.sensitive.html | 188 + .../b2/json/B2Json.serializedName.html | 264 + com/backblaze/b2/json/B2Json.type.html | 298 + com/backblaze/b2/json/B2Json.union.html | 250 + .../b2/json/B2Json.unionSubtypes.html | 243 + .../b2/json/B2Json.unionSubtypes.type.html | 257 + .../b2/json/B2Json.versionRange.html | 260 + .../b2/json/B2JsonAtomicLongArrayHandler.html | 436 + .../b2/json/B2JsonBadValueException.html | 313 + .../b2/json/B2JsonBigDecimalHandler.html | 455 + .../b2/json/B2JsonBigIntegerHandler.html | 455 + .../b2/json/B2JsonBooleanArrayHandler.html | 436 + .../b2/json/B2JsonBooleanHandler.html | 453 + .../B2JsonBoundedByteArrayOutputStream.html | 517 + .../b2/json/B2JsonByteArrayHandler.html | 436 + com/backblaze/b2/json/B2JsonByteHandler.html | 453 + .../b2/json/B2JsonCharArrayHandler.html | 436 + .../b2/json/B2JsonCharSquenceHandler.html | 458 + .../b2/json/B2JsonCharacterHandler.html | 453 + .../b2/json/B2JsonConcurrentMapHandler.html | 443 + .../b2/json/B2JsonDoubleArrayHandler.html | 436 + .../b2/json/B2JsonDoubleHandler.html | 453 + com/backblaze/b2/json/B2JsonEnumHandler.html | 461 + .../b2/json/B2JsonEnumSetHandler.html | 437 + com/backblaze/b2/json/B2JsonException.html | 311 + .../b2/json/B2JsonFloatArrayHandler.html | 436 + com/backblaze/b2/json/B2JsonFloatHandler.html | 453 + com/backblaze/b2/json/B2JsonHandlerMap.html | 327 + .../b2/json/B2JsonInitializedTypeHandler.html | 375 + .../b2/json/B2JsonIntArrayHandler.html | 436 + .../b2/json/B2JsonIntegerHandler.html | 453 + .../b2/json/B2JsonLinkedHashSetHandler.html | 436 + com/backblaze/b2/json/B2JsonListHandler.html | 436 + .../b2/json/B2JsonLocalDateHandler.html | 454 + .../b2/json/B2JsonLocalDateTimeHandler.html | 454 + .../b2/json/B2JsonLongArrayHandler.html | 436 + com/backblaze/b2/json/B2JsonLongHandler.html | 453 + com/backblaze/b2/json/B2JsonMapHandler.html | 443 + .../b2/json/B2JsonNonUrlTypeHandler.html | 343 + .../b2/json/B2JsonObjectArrayHandler.html | 442 + .../b2/json/B2JsonObjectHandler.html | 548 + .../b2/json/B2JsonOptions.Builder.html | 365 + .../json/B2JsonOptions.ExtraFieldOption.html | 381 + .../B2JsonOptions.SerializationOption.html | 384 + com/backblaze/b2/json/B2JsonOptions.html | 437 + com/backblaze/b2/json/B2JsonReader.html | 709 + com/backblaze/b2/json/B2JsonSetHandler.html | 437 + .../b2/json/B2JsonStringHandler.html | 453 + .../b2/json/B2JsonTreeSetHandler.html | 436 + com/backblaze/b2/json/B2JsonTypeHandler.html | 378 + .../json/B2JsonTypeHandlerWithDefaults.html | 362 + .../b2/json/B2JsonUnionBaseHandler.html | 479 + .../b2/json/B2JsonUnionTypeMap.Builder.html | 298 + com/backblaze/b2/json/B2JsonUnionTypeMap.html | 316 + com/backblaze/b2/json/B2JsonUtil.html | 350 + com/backblaze/b2/json/B2JsonWriter.html | 497 + com/backblaze/b2/json/B2TypeResolver.html | 376 + .../b2/json/FieldInfo.FieldRequirement.html | 393 + com/backblaze/b2/json/FieldInfo.html | 563 + com/backblaze/b2/json/VersionRange.html | 358 + com/backblaze/b2/json/package-summary.html | 592 + com/backblaze/b2/json/package-tree.html | 276 + .../b2/util/B2ByteProgressListener.html | 313 + com/backblaze/b2/util/B2ByteRange.html | 546 + com/backblaze/b2/util/B2Clock.html | 399 + com/backblaze/b2/util/B2ClockImpl.html | 356 + com/backblaze/b2/util/B2ClockSim.html | 385 + com/backblaze/b2/util/B2Collections.html | 417 + com/backblaze/b2/util/B2DateTimeUtil.html | 510 + com/backblaze/b2/util/B2ExecutorUtils.html | 328 + ...B2FlushAndSyncFileOnCloseOutputStream.html | 427 + .../b2/util/B2InputStreamExcerpt.html | 484 + ...B2InputStreamWithByteProgressListener.html | 449 + com/backblaze/b2/util/B2IoUtils.html | 360 + com/backblaze/b2/util/B2Md5.html | 385 + com/backblaze/b2/util/B2Preconditions.html | 304 + com/backblaze/b2/util/B2Sha1.html | 413 + .../b2/util/B2Sha1AppenderInputStream.html | 306 + com/backblaze/b2/util/B2Sha1InputStream.html | 458 + com/backblaze/b2/util/B2StringUtil.html | 523 + com/backblaze/b2/util/B2Utf8Util.html | 350 + com/backblaze/b2/util/package-summary.html | 279 + com/backblaze/b2/util/package-tree.html | 195 + constant-values.html | 1328 ++ deprecated-list.html | 213 + element-list | 9 + help-doc.html | 272 + index-all.html | 5648 ++++++++ index.html | 192 + jquery-ui.overrides.css | 35 + jquery/external/jquery/jquery.js | 10872 +++++++++++++++ jquery/jquery-3.6.1.min.js | 2 + jquery/jquery-ui.min.css | 6 + jquery/jquery-ui.min.js | 6 + jquery/jszip-utils/dist/jszip-utils-ie.js | 56 + jquery/jszip-utils/dist/jszip-utils-ie.min.js | 10 + jquery/jszip-utils/dist/jszip-utils.js | 118 + jquery/jszip-utils/dist/jszip-utils.min.js | 10 + jquery/jszip/dist/jszip.js | 11370 ++++++++++++++++ jquery/jszip/dist/jszip.min.js | 13 + legal/ADDITIONAL_LICENSE_INFO | 37 + legal/ASSEMBLY_EXCEPTION | 27 + legal/LICENSE | 347 + legal/jquery.md | 72 + legal/jqueryUI.md | 49 + legal/jszip.md | 653 + legal/pako.md | 45 + member-search-index.js | 1 + member-search-index.zip | Bin 0 -> 19845 bytes overview-summary.html | 23 + overview-tree.html | 552 + package-search-index.js | 1 + package-search-index.zip | Bin 0 -> 310 bytes resources/glass.png | Bin 0 -> 499 bytes resources/x.png | Bin 0 -> 394 bytes script.js | 149 + search.js | 326 + serialized-form.html | 293 + stylesheet.css | 910 ++ type-search-index.js | 1 + type-search-index.zip | Bin 0 -> 2328 bytes 352 files changed, 159309 insertions(+) create mode 100644 allclasses-index.html create mode 100644 allclasses.html create mode 100644 allpackages-index.html create mode 100644 com/backblaze/b2/client/B2AccountAuthorizer.html create mode 100644 com/backblaze/b2/client/B2AccountAuthorizerSimpleImpl.Builder.html create mode 100644 com/backblaze/b2/client/B2AccountAuthorizerSimpleImpl.html create mode 100644 com/backblaze/b2/client/B2AlreadyStoredPartStorer.html create mode 100644 com/backblaze/b2/client/B2CancellableContentSource.html create mode 100644 com/backblaze/b2/client/B2CancellationToken.html create mode 100644 com/backblaze/b2/client/B2ClientConfig.Builder.html create mode 100644 com/backblaze/b2/client/B2ClientConfig.html create mode 100644 com/backblaze/b2/client/B2CopyingPartStorer.html create mode 100644 com/backblaze/b2/client/B2DefaultRetryPolicy.html create mode 100644 com/backblaze/b2/client/B2FilePolicy.html create mode 100644 com/backblaze/b2/client/B2LargeFileStorer.html create mode 100644 com/backblaze/b2/client/B2ListFileNamesIterable.html create mode 100644 com/backblaze/b2/client/B2ListFileVersionsIterable.html create mode 100644 com/backblaze/b2/client/B2ListFilesIterable.html create mode 100644 com/backblaze/b2/client/B2ListFilesIterableBase.IterBase.html create mode 100644 com/backblaze/b2/client/B2ListFilesIterableBase.html create mode 100644 com/backblaze/b2/client/B2ListKeysIterable.html create mode 100644 com/backblaze/b2/client/B2ListKeysIterator.html create mode 100644 com/backblaze/b2/client/B2ListPartsIterable.html create mode 100644 com/backblaze/b2/client/B2ListPartsIterableBase.IterBase.html create mode 100644 com/backblaze/b2/client/B2ListPartsIterableBase.html create mode 100644 com/backblaze/b2/client/B2ListPartsIterableImpl.html create mode 100644 com/backblaze/b2/client/B2ListUnfinishedLargeFilesIterable.html create mode 100644 com/backblaze/b2/client/B2PartSpec.html create mode 100644 com/backblaze/b2/client/B2PartStorer.html create mode 100644 com/backblaze/b2/client/B2RetryPolicy.html create mode 100644 com/backblaze/b2/client/B2Sdk.html create mode 100644 com/backblaze/b2/client/B2StorageClient.html create mode 100644 com/backblaze/b2/client/B2StorageClientFactory.html create mode 100644 com/backblaze/b2/client/B2StorageClientFactoryPathBasedImpl.html create mode 100644 com/backblaze/b2/client/B2StorageClientImpl.html create mode 100644 com/backblaze/b2/client/B2StorageClientWebifier.html create mode 100644 com/backblaze/b2/client/B2StorageClientWebifierImpl.html create mode 100644 com/backblaze/b2/client/B2UploadingPartStorer.html create mode 100644 com/backblaze/b2/client/contentHandlers/B2ContentFileWriter.Builder.html create mode 100644 com/backblaze/b2/client/contentHandlers/B2ContentFileWriter.html create mode 100644 com/backblaze/b2/client/contentHandlers/B2ContentMemoryWriter.Builder.html create mode 100644 com/backblaze/b2/client/contentHandlers/B2ContentMemoryWriter.html create mode 100644 com/backblaze/b2/client/contentHandlers/B2ContentOutputStreamWriter.Builder.html create mode 100644 com/backblaze/b2/client/contentHandlers/B2ContentOutputStreamWriter.Helper.html create mode 100644 com/backblaze/b2/client/contentHandlers/B2ContentOutputStreamWriter.html create mode 100644 com/backblaze/b2/client/contentHandlers/B2ContentSink.html create mode 100644 com/backblaze/b2/client/contentHandlers/B2ContentWriter.html create mode 100644 com/backblaze/b2/client/contentHandlers/package-summary.html create mode 100644 com/backblaze/b2/client/contentHandlers/package-tree.html create mode 100644 com/backblaze/b2/client/contentSources/B2ByteArrayContentSource.Builder.html create mode 100644 com/backblaze/b2/client/contentSources/B2ByteArrayContentSource.html create mode 100644 com/backblaze/b2/client/contentSources/B2ContentSource.html create mode 100644 com/backblaze/b2/client/contentSources/B2ContentTypes.html create mode 100644 com/backblaze/b2/client/contentSources/B2FileContentSource.Builder.html create mode 100644 com/backblaze/b2/client/contentSources/B2FileContentSource.html create mode 100644 com/backblaze/b2/client/contentSources/B2Headers.html create mode 100644 com/backblaze/b2/client/contentSources/B2HeadersImpl.Builder.html create mode 100644 com/backblaze/b2/client/contentSources/B2HeadersImpl.html create mode 100644 com/backblaze/b2/client/contentSources/package-summary.html create mode 100644 com/backblaze/b2/client/contentSources/package-tree.html create mode 100644 com/backblaze/b2/client/credentialsSources/B2Credentials.html create mode 100644 com/backblaze/b2/client/credentialsSources/B2CredentialsFromEnvironmentSource.html create mode 100644 com/backblaze/b2/client/credentialsSources/B2CredentialsImpl.html create mode 100644 com/backblaze/b2/client/credentialsSources/B2CredentialsSource.html create mode 100644 com/backblaze/b2/client/credentialsSources/package-summary.html create mode 100644 com/backblaze/b2/client/credentialsSources/package-tree.html create mode 100644 com/backblaze/b2/client/exceptions/B2BadRequestException.html create mode 100644 com/backblaze/b2/client/exceptions/B2CannotComputeException.html create mode 100644 com/backblaze/b2/client/exceptions/B2ConnectFailedException.html create mode 100644 com/backblaze/b2/client/exceptions/B2ConnectionBrokenException.html create mode 100644 com/backblaze/b2/client/exceptions/B2Exception.html create mode 100644 com/backblaze/b2/client/exceptions/B2ForbiddenException.html create mode 100644 com/backblaze/b2/client/exceptions/B2InternalErrorException.html create mode 100644 com/backblaze/b2/client/exceptions/B2LocalException.html create mode 100644 com/backblaze/b2/client/exceptions/B2NetworkBaseException.html create mode 100644 com/backblaze/b2/client/exceptions/B2NetworkException.html create mode 100644 com/backblaze/b2/client/exceptions/B2NetworkTimeoutException.html create mode 100644 com/backblaze/b2/client/exceptions/B2NotFoundException.html create mode 100644 com/backblaze/b2/client/exceptions/B2RequestTimeoutException.html create mode 100644 com/backblaze/b2/client/exceptions/B2RuntimeException.html create mode 100644 com/backblaze/b2/client/exceptions/B2ServiceUnavailableException.html create mode 100644 com/backblaze/b2/client/exceptions/B2SignatureVerificationException.html create mode 100644 com/backblaze/b2/client/exceptions/B2TooManyRequestsException.html create mode 100644 com/backblaze/b2/client/exceptions/B2UnauthorizedException.RequestCategory.html create mode 100644 com/backblaze/b2/client/exceptions/B2UnauthorizedException.html create mode 100644 com/backblaze/b2/client/exceptions/package-summary.html create mode 100644 com/backblaze/b2/client/exceptions/package-tree.html create mode 100644 com/backblaze/b2/client/package-summary.html create mode 100644 com/backblaze/b2/client/package-tree.html create mode 100644 com/backblaze/b2/client/structures/B2AccountAuthorization.html create mode 100644 com/backblaze/b2/client/structures/B2Allowed.html create mode 100644 com/backblaze/b2/client/structures/B2ApplicationKey.html create mode 100644 com/backblaze/b2/client/structures/B2AuthorizationFilteredResponseField.html create mode 100644 com/backblaze/b2/client/structures/B2AuthorizeAccountRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2AuthorizeAccountRequest.html create mode 100644 com/backblaze/b2/client/structures/B2Bucket.html create mode 100644 com/backblaze/b2/client/structures/B2BucketDefaultRetention.html create mode 100644 com/backblaze/b2/client/structures/B2BucketDefaultRetentionPeriod.html create mode 100644 com/backblaze/b2/client/structures/B2BucketFileLockConfiguration.html create mode 100644 com/backblaze/b2/client/structures/B2BucketReplicationConfiguration.html create mode 100644 com/backblaze/b2/client/structures/B2BucketServerSideEncryption.html create mode 100644 com/backblaze/b2/client/structures/B2BucketTypes.html create mode 100644 com/backblaze/b2/client/structures/B2CancelLargeFileRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2CancelLargeFileRequest.html create mode 100644 com/backblaze/b2/client/structures/B2CancelLargeFileResponse.html create mode 100644 com/backblaze/b2/client/structures/B2Capabilities.html create mode 100644 com/backblaze/b2/client/structures/B2CopyFileRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2CopyFileRequest.html create mode 100644 com/backblaze/b2/client/structures/B2CopyPartRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2CopyPartRequest.html create mode 100644 com/backblaze/b2/client/structures/B2CorsRule.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2CorsRule.html create mode 100644 com/backblaze/b2/client/structures/B2CreateBucketRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2CreateBucketRequest.html create mode 100644 com/backblaze/b2/client/structures/B2CreateBucketRequestReal.html create mode 100644 com/backblaze/b2/client/structures/B2CreateKeyRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2CreateKeyRequest.html create mode 100644 com/backblaze/b2/client/structures/B2CreateKeyRequestReal.html create mode 100644 com/backblaze/b2/client/structures/B2CreatedApplicationKey.html create mode 100644 com/backblaze/b2/client/structures/B2DeleteBucketRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2DeleteBucketRequest.html create mode 100644 com/backblaze/b2/client/structures/B2DeleteBucketRequestReal.html create mode 100644 com/backblaze/b2/client/structures/B2DeleteFileVersionRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2DeleteFileVersionRequest.html create mode 100644 com/backblaze/b2/client/structures/B2DeleteFileVersionResponse.html create mode 100644 com/backblaze/b2/client/structures/B2DeleteKeyRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2DeleteKeyRequest.html create mode 100644 com/backblaze/b2/client/structures/B2DownloadAuthorization.html create mode 100644 com/backblaze/b2/client/structures/B2DownloadByIdRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2DownloadByIdRequest.html create mode 100644 com/backblaze/b2/client/structures/B2DownloadByNameRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2DownloadByNameRequest.html create mode 100644 com/backblaze/b2/client/structures/B2ErrorStructure.html create mode 100644 com/backblaze/b2/client/structures/B2EventNotification.html create mode 100644 com/backblaze/b2/client/structures/B2EventNotificationEvent.html create mode 100644 com/backblaze/b2/client/structures/B2EventNotificationRule.html create mode 100644 com/backblaze/b2/client/structures/B2EventNotificationTargetConfiguration.html create mode 100644 com/backblaze/b2/client/structures/B2FileRetention.html create mode 100644 com/backblaze/b2/client/structures/B2FileRetentionMode.html create mode 100644 com/backblaze/b2/client/structures/B2FileRetentionPeriodUnit.html create mode 100644 com/backblaze/b2/client/structures/B2FileSseForRequest.html create mode 100644 com/backblaze/b2/client/structures/B2FileSseForResponse.html create mode 100644 com/backblaze/b2/client/structures/B2FileVersion.html create mode 100644 com/backblaze/b2/client/structures/B2FinishLargeFileRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2FinishLargeFileRequest.html create mode 100644 com/backblaze/b2/client/structures/B2GetBucketNotificationRulesRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2GetBucketNotificationRulesRequest.html create mode 100644 com/backblaze/b2/client/structures/B2GetBucketNotificationRulesResponse.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2GetBucketNotificationRulesResponse.html create mode 100644 com/backblaze/b2/client/structures/B2GetDownloadAuthorizationRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2GetDownloadAuthorizationRequest.html create mode 100644 com/backblaze/b2/client/structures/B2GetFileInfoByNameRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2GetFileInfoByNameRequest.html create mode 100644 com/backblaze/b2/client/structures/B2GetFileInfoRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2GetFileInfoRequest.html create mode 100644 com/backblaze/b2/client/structures/B2GetUploadPartUrlRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2GetUploadPartUrlRequest.html create mode 100644 com/backblaze/b2/client/structures/B2GetUploadUrlRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2GetUploadUrlRequest.html create mode 100644 com/backblaze/b2/client/structures/B2HideFileRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2HideFileRequest.html create mode 100644 com/backblaze/b2/client/structures/B2LegalHold.html create mode 100644 com/backblaze/b2/client/structures/B2LifecycleRule.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2LifecycleRule.html create mode 100644 com/backblaze/b2/client/structures/B2ListBucketsRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2ListBucketsRequest.html create mode 100644 com/backblaze/b2/client/structures/B2ListBucketsResponse.html create mode 100644 com/backblaze/b2/client/structures/B2ListFileNamesRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2ListFileNamesRequest.html create mode 100644 com/backblaze/b2/client/structures/B2ListFileNamesResponse.html create mode 100644 com/backblaze/b2/client/structures/B2ListFileVersionsRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2ListFileVersionsRequest.html create mode 100644 com/backblaze/b2/client/structures/B2ListFileVersionsResponse.html create mode 100644 com/backblaze/b2/client/structures/B2ListFilesResponse.html create mode 100644 com/backblaze/b2/client/structures/B2ListKeysRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2ListKeysRequest.html create mode 100644 com/backblaze/b2/client/structures/B2ListKeysRequestReal.html create mode 100644 com/backblaze/b2/client/structures/B2ListKeysResponse.html create mode 100644 com/backblaze/b2/client/structures/B2ListPartsRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2ListPartsRequest.html create mode 100644 com/backblaze/b2/client/structures/B2ListPartsResponse.html create mode 100644 com/backblaze/b2/client/structures/B2ListUnfinishedLargeFilesRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2ListUnfinishedLargeFilesRequest.html create mode 100644 com/backblaze/b2/client/structures/B2ListUnfinishedLargeFilesResponse.html create mode 100644 com/backblaze/b2/client/structures/B2OverrideableHeaders.html create mode 100644 com/backblaze/b2/client/structures/B2Part.html create mode 100644 com/backblaze/b2/client/structures/B2ReplicationRule.html create mode 100644 com/backblaze/b2/client/structures/B2ReplicationStatus.html create mode 100644 com/backblaze/b2/client/structures/B2ServerSideEncryptionMode.html create mode 100644 com/backblaze/b2/client/structures/B2SetBucketNotificationRulesRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2SetBucketNotificationRulesRequest.html create mode 100644 com/backblaze/b2/client/structures/B2SetBucketNotificationRulesResponse.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2SetBucketNotificationRulesResponse.html create mode 100644 com/backblaze/b2/client/structures/B2StartLargeFileRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2StartLargeFileRequest.html create mode 100644 com/backblaze/b2/client/structures/B2StoreLargeFileRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2StoreLargeFileRequest.html create mode 100644 com/backblaze/b2/client/structures/B2TestMode.html create mode 100644 com/backblaze/b2/client/structures/B2UpdateBucketRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2UpdateBucketRequest.html create mode 100644 com/backblaze/b2/client/structures/B2UpdateFileLegalHoldRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2UpdateFileLegalHoldRequest.html create mode 100644 com/backblaze/b2/client/structures/B2UpdateFileLegalHoldResponse.html create mode 100644 com/backblaze/b2/client/structures/B2UpdateFileRetentionRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2UpdateFileRetentionRequest.html create mode 100644 com/backblaze/b2/client/structures/B2UpdateFileRetentionResponse.html create mode 100644 com/backblaze/b2/client/structures/B2UploadFileRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2UploadFileRequest.html create mode 100644 com/backblaze/b2/client/structures/B2UploadListener.html create mode 100644 com/backblaze/b2/client/structures/B2UploadPartRequest.Builder.html create mode 100644 com/backblaze/b2/client/structures/B2UploadPartRequest.html create mode 100644 com/backblaze/b2/client/structures/B2UploadPartUrlResponse.html create mode 100644 com/backblaze/b2/client/structures/B2UploadProgress.html create mode 100644 com/backblaze/b2/client/structures/B2UploadState.html create mode 100644 com/backblaze/b2/client/structures/B2UploadUrlResponse.html create mode 100644 com/backblaze/b2/client/structures/B2WebhookConfiguration.html create mode 100644 com/backblaze/b2/client/structures/B2WebhookCustomHeader.html create mode 100644 com/backblaze/b2/client/structures/package-summary.html create mode 100644 com/backblaze/b2/client/structures/package-tree.html create mode 100644 com/backblaze/b2/client/webApiClients/B2WebApiClient.html create mode 100644 com/backblaze/b2/client/webApiClients/package-summary.html create mode 100644 com/backblaze/b2/client/webApiClients/package-tree.html create mode 100644 com/backblaze/b2/json/B2Json.constructor.html create mode 100644 com/backblaze/b2/json/B2Json.defaultForInvalidEnumValue.html create mode 100644 com/backblaze/b2/json/B2Json.defaultForUnknownType.html create mode 100644 com/backblaze/b2/json/B2Json.firstVersion.html create mode 100644 com/backblaze/b2/json/B2Json.html create mode 100644 com/backblaze/b2/json/B2Json.ignored.html create mode 100644 com/backblaze/b2/json/B2Json.optional.html create mode 100644 com/backblaze/b2/json/B2Json.optionalWithDefault.html create mode 100644 com/backblaze/b2/json/B2Json.required.html create mode 100644 com/backblaze/b2/json/B2Json.sensitive.html create mode 100644 com/backblaze/b2/json/B2Json.serializedName.html create mode 100644 com/backblaze/b2/json/B2Json.type.html create mode 100644 com/backblaze/b2/json/B2Json.union.html create mode 100644 com/backblaze/b2/json/B2Json.unionSubtypes.html create mode 100644 com/backblaze/b2/json/B2Json.unionSubtypes.type.html create mode 100644 com/backblaze/b2/json/B2Json.versionRange.html create mode 100644 com/backblaze/b2/json/B2JsonAtomicLongArrayHandler.html create mode 100644 com/backblaze/b2/json/B2JsonBadValueException.html create mode 100644 com/backblaze/b2/json/B2JsonBigDecimalHandler.html create mode 100644 com/backblaze/b2/json/B2JsonBigIntegerHandler.html create mode 100644 com/backblaze/b2/json/B2JsonBooleanArrayHandler.html create mode 100644 com/backblaze/b2/json/B2JsonBooleanHandler.html create mode 100644 com/backblaze/b2/json/B2JsonBoundedByteArrayOutputStream.html create mode 100644 com/backblaze/b2/json/B2JsonByteArrayHandler.html create mode 100644 com/backblaze/b2/json/B2JsonByteHandler.html create mode 100644 com/backblaze/b2/json/B2JsonCharArrayHandler.html create mode 100644 com/backblaze/b2/json/B2JsonCharSquenceHandler.html create mode 100644 com/backblaze/b2/json/B2JsonCharacterHandler.html create mode 100644 com/backblaze/b2/json/B2JsonConcurrentMapHandler.html create mode 100644 com/backblaze/b2/json/B2JsonDoubleArrayHandler.html create mode 100644 com/backblaze/b2/json/B2JsonDoubleHandler.html create mode 100644 com/backblaze/b2/json/B2JsonEnumHandler.html create mode 100644 com/backblaze/b2/json/B2JsonEnumSetHandler.html create mode 100644 com/backblaze/b2/json/B2JsonException.html create mode 100644 com/backblaze/b2/json/B2JsonFloatArrayHandler.html create mode 100644 com/backblaze/b2/json/B2JsonFloatHandler.html create mode 100644 com/backblaze/b2/json/B2JsonHandlerMap.html create mode 100644 com/backblaze/b2/json/B2JsonInitializedTypeHandler.html create mode 100644 com/backblaze/b2/json/B2JsonIntArrayHandler.html create mode 100644 com/backblaze/b2/json/B2JsonIntegerHandler.html create mode 100644 com/backblaze/b2/json/B2JsonLinkedHashSetHandler.html create mode 100644 com/backblaze/b2/json/B2JsonListHandler.html create mode 100644 com/backblaze/b2/json/B2JsonLocalDateHandler.html create mode 100644 com/backblaze/b2/json/B2JsonLocalDateTimeHandler.html create mode 100644 com/backblaze/b2/json/B2JsonLongArrayHandler.html create mode 100644 com/backblaze/b2/json/B2JsonLongHandler.html create mode 100644 com/backblaze/b2/json/B2JsonMapHandler.html create mode 100644 com/backblaze/b2/json/B2JsonNonUrlTypeHandler.html create mode 100644 com/backblaze/b2/json/B2JsonObjectArrayHandler.html create mode 100644 com/backblaze/b2/json/B2JsonObjectHandler.html create mode 100644 com/backblaze/b2/json/B2JsonOptions.Builder.html create mode 100644 com/backblaze/b2/json/B2JsonOptions.ExtraFieldOption.html create mode 100644 com/backblaze/b2/json/B2JsonOptions.SerializationOption.html create mode 100644 com/backblaze/b2/json/B2JsonOptions.html create mode 100644 com/backblaze/b2/json/B2JsonReader.html create mode 100644 com/backblaze/b2/json/B2JsonSetHandler.html create mode 100644 com/backblaze/b2/json/B2JsonStringHandler.html create mode 100644 com/backblaze/b2/json/B2JsonTreeSetHandler.html create mode 100644 com/backblaze/b2/json/B2JsonTypeHandler.html create mode 100644 com/backblaze/b2/json/B2JsonTypeHandlerWithDefaults.html create mode 100644 com/backblaze/b2/json/B2JsonUnionBaseHandler.html create mode 100644 com/backblaze/b2/json/B2JsonUnionTypeMap.Builder.html create mode 100644 com/backblaze/b2/json/B2JsonUnionTypeMap.html create mode 100644 com/backblaze/b2/json/B2JsonUtil.html create mode 100644 com/backblaze/b2/json/B2JsonWriter.html create mode 100644 com/backblaze/b2/json/B2TypeResolver.html create mode 100644 com/backblaze/b2/json/FieldInfo.FieldRequirement.html create mode 100644 com/backblaze/b2/json/FieldInfo.html create mode 100644 com/backblaze/b2/json/VersionRange.html create mode 100644 com/backblaze/b2/json/package-summary.html create mode 100644 com/backblaze/b2/json/package-tree.html create mode 100644 com/backblaze/b2/util/B2ByteProgressListener.html create mode 100644 com/backblaze/b2/util/B2ByteRange.html create mode 100644 com/backblaze/b2/util/B2Clock.html create mode 100644 com/backblaze/b2/util/B2ClockImpl.html create mode 100644 com/backblaze/b2/util/B2ClockSim.html create mode 100644 com/backblaze/b2/util/B2Collections.html create mode 100644 com/backblaze/b2/util/B2DateTimeUtil.html create mode 100644 com/backblaze/b2/util/B2ExecutorUtils.html create mode 100644 com/backblaze/b2/util/B2FlushAndSyncFileOnCloseOutputStream.html create mode 100644 com/backblaze/b2/util/B2InputStreamExcerpt.html create mode 100644 com/backblaze/b2/util/B2InputStreamWithByteProgressListener.html create mode 100644 com/backblaze/b2/util/B2IoUtils.html create mode 100644 com/backblaze/b2/util/B2Md5.html create mode 100644 com/backblaze/b2/util/B2Preconditions.html create mode 100644 com/backblaze/b2/util/B2Sha1.html create mode 100644 com/backblaze/b2/util/B2Sha1AppenderInputStream.html create mode 100644 com/backblaze/b2/util/B2Sha1InputStream.html create mode 100644 com/backblaze/b2/util/B2StringUtil.html create mode 100644 com/backblaze/b2/util/B2Utf8Util.html create mode 100644 com/backblaze/b2/util/package-summary.html create mode 100644 com/backblaze/b2/util/package-tree.html create mode 100644 constant-values.html create mode 100644 deprecated-list.html create mode 100644 element-list create mode 100644 help-doc.html create mode 100644 index-all.html create mode 100644 index.html create mode 100644 jquery-ui.overrides.css create mode 100644 jquery/external/jquery/jquery.js create mode 100644 jquery/jquery-3.6.1.min.js create mode 100644 jquery/jquery-ui.min.css create mode 100644 jquery/jquery-ui.min.js create mode 100644 jquery/jszip-utils/dist/jszip-utils-ie.js create mode 100644 jquery/jszip-utils/dist/jszip-utils-ie.min.js create mode 100644 jquery/jszip-utils/dist/jszip-utils.js create mode 100644 jquery/jszip-utils/dist/jszip-utils.min.js create mode 100644 jquery/jszip/dist/jszip.js create mode 100644 jquery/jszip/dist/jszip.min.js create mode 100644 legal/ADDITIONAL_LICENSE_INFO create mode 100644 legal/ASSEMBLY_EXCEPTION create mode 100644 legal/LICENSE create mode 100644 legal/jquery.md create mode 100644 legal/jqueryUI.md create mode 100644 legal/jszip.md create mode 100644 legal/pako.md create mode 100644 member-search-index.js create mode 100644 member-search-index.zip create mode 100644 overview-summary.html create mode 100644 overview-tree.html create mode 100644 package-search-index.js create mode 100644 package-search-index.zip create mode 100644 resources/glass.png create mode 100644 resources/x.png create mode 100644 script.js create mode 100644 search.js create mode 100644 serialized-form.html create mode 100644 stylesheet.css create mode 100644 type-search-index.js create mode 100644 type-search-index.zip diff --git a/allclasses-index.html b/allclasses-index.html new file mode 100644 index 000000000..bfc96196e --- /dev/null +++ b/allclasses-index.html @@ -0,0 +1,1669 @@ + + + + + +All Classes (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

All Classes

+
+
+ +
+
+ + + diff --git a/allclasses.html b/allclasses.html new file mode 100644 index 000000000..fb6cc602d --- /dev/null +++ b/allclasses.html @@ -0,0 +1,320 @@ + + + + + +All Classes (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + +
+

All Classes

+
+ +
+
+ + diff --git a/allpackages-index.html b/allpackages-index.html new file mode 100644 index 000000000..d57c1e05b --- /dev/null +++ b/allpackages-index.html @@ -0,0 +1,196 @@ + + + + + +All Packages (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

All Packages

+
+
+ +
+
+ + + diff --git a/com/backblaze/b2/client/B2AccountAuthorizer.html b/com/backblaze/b2/client/B2AccountAuthorizer.html new file mode 100644 index 000000000..b937bc1fc --- /dev/null +++ b/com/backblaze/b2/client/B2AccountAuthorizer.html @@ -0,0 +1,270 @@ + + + + + +B2AccountAuthorizer (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2AccountAuthorizer

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    B2AccountAuthorizerSimpleImpl
    +
    +
    +
    public interface B2AccountAuthorizer
    +
    B2AccountAuthorizer provides a mechanism to get an accountId and + a corresponding B2AccountAuthorization. The accountId is expected + to never change. The B2AccountAuthorization is required to make + a new authorization every time it is called.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        authorize

        +
        B2AccountAuthorization authorize​(B2StorageClientWebifier webifier)
        +                          throws B2Exception
        +
        This will be called to get a new B2AccountAuthorization instance.
        +
        +
        Parameters:
        +
        webifier - in case it's useful. :)
        +
        Returns:
        +
        an account authorization for the account this represents.
        +
        Throws:
        +
        B2Exception - if it throws a B2UnauthorizedException, it must + ensure that the requestCategory is set to + ACCOUNT_AUTHORIZATION, so retries work properly.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2AccountAuthorizerSimpleImpl.Builder.html b/com/backblaze/b2/client/B2AccountAuthorizerSimpleImpl.Builder.html new file mode 100644 index 000000000..380380946 --- /dev/null +++ b/com/backblaze/b2/client/B2AccountAuthorizerSimpleImpl.Builder.html @@ -0,0 +1,310 @@ + + + + + +B2AccountAuthorizerSimpleImpl.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2AccountAuthorizerSimpleImpl.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2AccountAuthorizerSimpleImpl
    +
    +
    +
    public static class B2AccountAuthorizerSimpleImpl.Builder
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      Builder​(java.lang.String applicationKeyId, + java.lang.String applicationKey) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder​(java.lang.String applicationKeyId,
        +               java.lang.String applicationKey)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2AccountAuthorizerSimpleImpl.html b/com/backblaze/b2/client/B2AccountAuthorizerSimpleImpl.html new file mode 100644 index 000000000..f367b2123 --- /dev/null +++ b/com/backblaze/b2/client/B2AccountAuthorizerSimpleImpl.html @@ -0,0 +1,327 @@ + + + + + +B2AccountAuthorizerSimpleImpl (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2AccountAuthorizerSimpleImpl

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2AccountAuthorizer
    +
    +
    +
    public class B2AccountAuthorizerSimpleImpl
    +extends java.lang.Object
    +implements B2AccountAuthorizer
    +
    B2AccountAuthorizerSimpleImpl is the usual implementation of authorizing. + Almost everyone is expected to use this right now.
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2AlreadyStoredPartStorer.html b/com/backblaze/b2/client/B2AlreadyStoredPartStorer.html new file mode 100644 index 000000000..526b659f0 --- /dev/null +++ b/com/backblaze/b2/client/B2AlreadyStoredPartStorer.html @@ -0,0 +1,411 @@ + + + + + +B2AlreadyStoredPartStorer (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2AlreadyStoredPartStorer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2PartStorer
    +
    +
    +
    public class B2AlreadyStoredPartStorer
    +extends java.lang.Object
    +implements B2PartStorer
    +
    This implementation "stores" a part that has already been successfully + stored in B2. Its intended use is in retrying or resuming the storage + of a large file, after an attempt where some, but not all, parts were + successfully stored. + + When resuming the storage of a large part, use this class for parts + that are already stored, and do not need to be stored again.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2AlreadyStoredPartStorer

        +
        public B2AlreadyStoredPartStorer​(B2Part part)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPartSizeOrThrow

        +
        public long getPartSizeOrThrow()
        +
        +
        Specified by:
        +
        getPartSizeOrThrow in interface B2PartStorer
        +
        Returns:
        +
        The size of the part that this object will store, or throw if that + cannot be determined.
        +
        +
      • +
      + + + +
        +
      • +

        getPartNumber

        +
        public int getPartNumber()
        +
        +
        Specified by:
        +
        getPartNumber in interface B2PartStorer
        +
        Returns:
        +
        The part number this object will store.
        +
        +
      • +
      + + + +
        +
      • +

        storePart

        +
        public B2Part storePart​(B2LargeFileStorer largeFileStorer,
        +                        B2UploadListener uploadListener,
        +                        B2CancellationToken cancellationToken)
        +
        Description copied from interface: B2PartStorer
        +
        Store the part this B2PartStorer is responsible for.
        +
        +
        Specified by:
        +
        storePart in interface B2PartStorer
        +
        Parameters:
        +
        largeFileStorer - The object managing the storage of the whole large file.
        +
        uploadListener - The listener that tracks upload progress events.
        +
        cancellationToken - token to check whether the action has been cancelled
        +
        Returns:
        +
        The part that is stored, if successful.
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2CancellableContentSource.html b/com/backblaze/b2/client/B2CancellableContentSource.html new file mode 100644 index 000000000..4aee5b317 --- /dev/null +++ b/com/backblaze/b2/client/B2CancellableContentSource.html @@ -0,0 +1,424 @@ + + + + + +B2CancellableContentSource (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CancellableContentSource

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2ContentSource
    +
    +
    +
    public class B2CancellableContentSource
    +extends java.lang.Object
    +implements B2ContentSource
    +
    A ContentSource wrapper that returns an InputStream that will check whether + the cancellation token says to stop.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getContentLength

        +
        public long getContentLength()
        +                      throws java.io.IOException
        +
        +
        Specified by:
        +
        getContentLength in interface B2ContentSource
        +
        Returns:
        +
        the number of bytes in the content. the length must be non-negative.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        +
      • +
      + + + +
        +
      • +

        getSha1OrNull

        +
        public java.lang.String getSha1OrNull()
        +                               throws java.io.IOException
        +
        Description copied from interface: B2ContentSource
        +
        You are encouraged to implement this. If it returns non-null, + the B2Client can provide the sha1 before performing the upload. + + Definitely implement this if you've stored the sha1 separately + from the file. That way you can ensure that B2 doesn't take the + file if there's trouble reading it from your source. If you + return null, B2StorageClient will compute the SHA1 from the bytes in the + stream. + + Note that large files do not have SHA-1s for the entire file. + If you provide a SHA-1 for a large file upload, the SDK follows + the recommendation of putting your value into the 'large_file_sha1' + fileInfo. See "SHA1 Checksums" in https://www.backblaze.com/b2/docs/large_files.html
        +
        +
        Specified by:
        +
        getSha1OrNull in interface B2ContentSource
        +
        Returns:
        +
        the hex-encoded sha1 for the content or null if it's not known yet.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        +
      • +
      + + + +
        +
      • +

        getSrcLastModifiedMillisOrNull

        +
        public java.lang.Long getSrcLastModifiedMillisOrNull()
        +                                              throws java.io.IOException
        +
        +
        Specified by:
        +
        getSrcLastModifiedMillisOrNull in interface B2ContentSource
        +
        Returns:
        +
        the time the source was last modified (in milliseconds since the epoch) + or null if there isn't a reasonable value for that.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        +
      • +
      + + + +
        +
      • +

        createInputStream

        +
        public java.io.InputStream createInputStream()
        +                                      throws java.io.IOException,
        +                                             B2Exception
        +
        Description copied from interface: B2ContentSource
        +
        NOTE: this may be called multiple times as uploads + are retried, etc. The content is expected to be identical + each time this is called.
        +
        +
        Specified by:
        +
        createInputStream in interface B2ContentSource
        +
        Returns:
        +
        a new inputStream containing the contents.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        B2Exception - if there's trouble
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2CancellationToken.html b/com/backblaze/b2/client/B2CancellationToken.html new file mode 100644 index 000000000..deb44e822 --- /dev/null +++ b/com/backblaze/b2/client/B2CancellationToken.html @@ -0,0 +1,268 @@ + + + + + +B2CancellationToken (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CancellationToken

+
+
+ +
+
    +
  • +
    +
    public class B2CancellationToken
    +extends java.lang.Object
    +
    Token to pass around whether the caller has cancelled an operation so that + sub tasks can stop their processing.
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2CancellationToken

        +
        public B2CancellationToken()
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2ClientConfig.Builder.html b/com/backblaze/b2/client/B2ClientConfig.Builder.html new file mode 100644 index 000000000..eef24d8cd --- /dev/null +++ b/com/backblaze/b2/client/B2ClientConfig.Builder.html @@ -0,0 +1,353 @@ + + + + + +B2ClientConfig.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ClientConfig.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2ClientConfig
    +
    +
    +
    public static class B2ClientConfig.Builder
    +extends java.lang.Object
    +
    The Builder for building a B2ClientConfig.
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2ClientConfig.html b/com/backblaze/b2/client/B2ClientConfig.html new file mode 100644 index 000000000..6590788bd --- /dev/null +++ b/com/backblaze/b2/client/B2ClientConfig.html @@ -0,0 +1,417 @@ + + + + + +B2ClientConfig (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ClientConfig

+
+
+ +
+
    +
  • +
    +
    public class B2ClientConfig
    +extends java.lang.Object
    +
    B2ClientConfig describes the various settings the B2 clients need. + * @param executor the executor to use for doing things in parallel (such as uploading large file parts)
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getUserAgent

        +
        public java.lang.String getUserAgent()
        +
      • +
      + + + +
        +
      • +

        getMasterUrl

        +
        public java.lang.String getMasterUrl()
        +
      • +
      + + + +
        +
      • +

        getTestModeOrNull

        +
        public B2TestMode getTestModeOrNull()
        +
      • +
      + + + +
        +
      • +

        isPartNumberGapsAllowed

        +
        public boolean isPartNumberGapsAllowed()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + + + + +
        +
      • +

        builder

        +
        public static B2ClientConfig.Builder builder​(java.lang.String applicationKeyId,
        +                                             java.lang.String applicationKey,
        +                                             java.lang.String userAgent)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2CopyingPartStorer.html b/com/backblaze/b2/client/B2CopyingPartStorer.html new file mode 100644 index 000000000..cc65660dc --- /dev/null +++ b/com/backblaze/b2/client/B2CopyingPartStorer.html @@ -0,0 +1,431 @@ + + + + + +B2CopyingPartStorer (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CopyingPartStorer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2PartStorer
    +
    +
    +
    public class B2CopyingPartStorer
    +extends java.lang.Object
    +implements B2PartStorer
    +
    This implementation stores a part of a large file by copying + from a file that is already stored in B2.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2CopyingPartStorer

        +
        public B2CopyingPartStorer​(int partNumber,
        +                           java.lang.String sourceFileId)
        +
      • +
      + + + +
        +
      • +

        B2CopyingPartStorer

        +
        public B2CopyingPartStorer​(int partNumber,
        +                           java.lang.String sourceFileId,
        +                           B2ByteRange byteRangeOrNull)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPartNumber

        +
        public int getPartNumber()
        +
        +
        Specified by:
        +
        getPartNumber in interface B2PartStorer
        +
        Returns:
        +
        The part number this object will store.
        +
        +
      • +
      + + + + + + + +
        +
      • +

        storePart

        +
        public B2Part storePart​(B2LargeFileStorer largeFileStorer,
        +                        B2UploadListener uploadListener,
        +                        B2CancellationToken cancellationToken)
        +                 throws B2Exception
        +
        Description copied from interface: B2PartStorer
        +
        Store the part this B2PartStorer is responsible for.
        +
        +
        Specified by:
        +
        storePart in interface B2PartStorer
        +
        Parameters:
        +
        largeFileStorer - The object managing the storage of the whole large file.
        +
        uploadListener - The listener that tracks upload progress events.
        +
        cancellationToken - token to check whether the action has been cancelled
        +
        Returns:
        +
        The part that is stored, if successful.
        +
        Throws:
        +
        B2Exception - if there's trouble.
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2DefaultRetryPolicy.html b/com/backblaze/b2/client/B2DefaultRetryPolicy.html new file mode 100644 index 000000000..595d61b08 --- /dev/null +++ b/com/backblaze/b2/client/B2DefaultRetryPolicy.html @@ -0,0 +1,407 @@ + + + + + +B2DefaultRetryPolicy (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2DefaultRetryPolicy

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2RetryPolicy
    +
    +
    +
    public class B2DefaultRetryPolicy
    +extends java.lang.Object
    +implements B2RetryPolicy
    +
    B2DefaultRetryPolicy implements the retry policy described in the B2 + documentation. It should be reasonable and sufficient for almost every + use of B2. + + Each attempted operation should have a unique instance of this class + because it stores state about retries between calls. Use an instance + of Supplier<B2RetryPolicy> which provides a new instance on each call.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2DefaultRetryPolicy

        +
        public B2DefaultRetryPolicy()
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        supplier

        +
        public static java.util.function.Supplier<B2RetryPolicy> supplier()
        +
        +
        Returns:
        +
        a supplier to create new instances of this class.
        +
        +
      • +
      + + + +
        +
      • +

        gotRetryableAfterDelay

        +
        public java.lang.Integer gotRetryableAfterDelay​(java.lang.String operation,
        +                                                int attemptsSoFar,
        +                                                long tookMillis,
        +                                                B2Exception e)
        +
        Description copied from interface: B2RetryPolicy
        +
        Callable.call() threw a retryable B2Exception but we have to wait a + while before retrying. If the guide decides we've tried enough times, + it should return null. Otherwise, it should return the number of + seconds to sleep before trying again. +

        + if e.getRetryAfterSecondsOrNull() is not null, it's the number of seconds + the server suggests that you wait before trying again. +

        + WARNING: if we only hit retryable errors and this never returns null, + we will keep retrying indefinitely. You have been warned.

        +
        +
        Specified by:
        +
        gotRetryableAfterDelay in interface B2RetryPolicy
        +
        Parameters:
        +
        operation - the name of what is being retried. *usually* the name of a b2 operation.
        +
        attemptsSoFar - how many times have we called callable.call() so far?
        +
        tookMillis - how long did this attempt take?
        +
        e - the retryable exception.
        +
        Returns:
        +
        null to stop trying OR the number of seconds to sleep before trying again.
        +
        +
      • +
      + + + +
        +
      • +

        gotRetryableImmediately

        +
        public boolean gotRetryableImmediately​(java.lang.String operation,
        +                                       int attemptsSoFar,
        +                                       long tookMillis,
        +                                       B2Exception e)
        +
        Description copied from interface: B2RetryPolicy
        +
        Callable.call() threw a retryable B2Exception. We will retry immediately.
        +
        +
        Specified by:
        +
        gotRetryableImmediately in interface B2RetryPolicy
        +
        Parameters:
        +
        operation - the name of what is being retried. *usually* the name of a b2 operation.
        +
        attemptsSoFar - how many times have we called callable.call() so far?
        +
        tookMillis - how long did this attempt take?
        +
        e - the retryable exception.
        +
        Returns:
        +
        true iff we should try again.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2FilePolicy.html b/com/backblaze/b2/client/B2FilePolicy.html new file mode 100644 index 000000000..87f6e7094 --- /dev/null +++ b/com/backblaze/b2/client/B2FilePolicy.html @@ -0,0 +1,315 @@ + + + + + +B2FilePolicy (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2FilePolicy

+
+
+
+
    +
  • +
    +
    public interface B2FilePolicy
    +
    B2FilePolicy answers questions about whether to upload a file as a 'small' + file or as a 'large' file. + + Uploading a file as a large file *may* increase your upload-speed because + parts of a large file may be uploaded in parallel. + + Uploading as large file involves more state and you will need to + resume or cancel interrupted uploads, so it complicates your client. + If you never have to upload a file that's more than 5 GB, you can keep + your client simpler by always uploading 'small' files. + + Files that are too large, must be uploaded as large files, so you + can't avoid using them if you have files larger than 5 GB. + + If you have to upload arbitrarily-sized files, you have to implement the + cleanup and you can use shouldBeLargeFile to determine which type of upload + to use for each file.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        shouldBeLargeFile

        +
        boolean shouldBeLargeFile​(long contentSize)
        +
        +
        Parameters:
        +
        contentSize - the size of the file you want to upload.
        +
        Returns:
        +
        true iff there would be a reasonable number of reasonably-sized + parts for the given file size.
        +
        +
      • +
      + + + +
        +
      • +

        mustBeLargeFile

        +
        boolean mustBeLargeFile​(long contentSize)
        +
        +
        Parameters:
        +
        contentSize - the size of the file you want to upload.
        +
        Returns:
        +
        true iff contentSize is too big to fit in a normal (non-large) file.
        +
        +
      • +
      + + + +
        +
      • +

        couldBeLargeFile

        +
        boolean couldBeLargeFile​(long contentSize)
        +
        +
        Parameters:
        +
        contentSize - the size of the file you want to upload.
        +
        Returns:
        +
        true iff contentSize is big enough to be a large file. + this is based on the absoluteMinimumPartSize and say + yes to silly things like a file just barely large enough + to have one minimum-sized part and one one-byte part.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2LargeFileStorer.html b/com/backblaze/b2/client/B2LargeFileStorer.html new file mode 100644 index 000000000..793bd69cf --- /dev/null +++ b/com/backblaze/b2/client/B2LargeFileStorer.html @@ -0,0 +1,385 @@ + + + + + +B2LargeFileStorer (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2LargeFileStorer

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2ListFileNamesIterable.html b/com/backblaze/b2/client/B2ListFileNamesIterable.html new file mode 100644 index 000000000..04f86515b --- /dev/null +++ b/com/backblaze/b2/client/B2ListFileNamesIterable.html @@ -0,0 +1,308 @@ + + + + + +B2ListFileNamesIterable (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListFileNamesIterable

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2ListFileVersionsIterable.html b/com/backblaze/b2/client/B2ListFileVersionsIterable.html new file mode 100644 index 000000000..345c3dadd --- /dev/null +++ b/com/backblaze/b2/client/B2ListFileVersionsIterable.html @@ -0,0 +1,308 @@ + + + + + +B2ListFileVersionsIterable (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListFileVersionsIterable

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2ListFilesIterable.html b/com/backblaze/b2/client/B2ListFilesIterable.html new file mode 100644 index 000000000..d4830aebe --- /dev/null +++ b/com/backblaze/b2/client/B2ListFilesIterable.html @@ -0,0 +1,223 @@ + + + + + +B2ListFilesIterable (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2ListFilesIterable

+
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, iterator, spliterator
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2ListFilesIterableBase.IterBase.html b/com/backblaze/b2/client/B2ListFilesIterableBase.IterBase.html new file mode 100644 index 000000000..1df1aae3e --- /dev/null +++ b/com/backblaze/b2/client/B2ListFilesIterableBase.IterBase.html @@ -0,0 +1,335 @@ + + + + + +B2ListFilesIterableBase.IterBase (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListFilesIterableBase.IterBase

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Iterator<B2FileVersion>
    +
    +
    +
    Enclosing class:
    +
    B2ListFilesIterableBase
    +
    +
    +
    protected abstract class B2ListFilesIterableBase.IterBase
    +extends java.lang.Object
    +implements java.util.Iterator<B2FileVersion>
    +
  • +
+
+
+ +
+
+
    +
  • + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2ListFilesIterableBase.html b/com/backblaze/b2/client/B2ListFilesIterableBase.html new file mode 100644 index 000000000..9179db8bc --- /dev/null +++ b/com/backblaze/b2/client/B2ListFilesIterableBase.html @@ -0,0 +1,321 @@ + + + + + +B2ListFilesIterableBase (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListFilesIterableBase

+
+
+ +
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      protected B2StorageClientImplgetClient() 
      java.util.Iterator<B2FileVersion>iterator() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
      • +
      +
    • +
    +
    +
  • +
+
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2ListKeysIterable.html b/com/backblaze/b2/client/B2ListKeysIterable.html new file mode 100644 index 000000000..15053e73a --- /dev/null +++ b/com/backblaze/b2/client/B2ListKeysIterable.html @@ -0,0 +1,325 @@ + + + + + +B2ListKeysIterable (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListKeysIterable

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<B2ApplicationKey>
    +
    +
    +
    public class B2ListKeysIterable
    +extends java.lang.Object
    +implements java.lang.Iterable<B2ApplicationKey>
    +
    This interface collects the APIs we provide on our B2ApplicationKey iterables. + For now, it's just the Iterable-ness. Someday, I expect it, or some interfaces + to provide some kind of "get resume point" functionality.
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2ListKeysIterator.html b/com/backblaze/b2/client/B2ListKeysIterator.html new file mode 100644 index 000000000..b356fcda1 --- /dev/null +++ b/com/backblaze/b2/client/B2ListKeysIterator.html @@ -0,0 +1,298 @@ + + + + + +B2ListKeysIterator (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListKeysIterator

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Iterator<B2ApplicationKey>
    +
    +
    +
    public class B2ListKeysIterator
    +extends java.lang.Object
    +implements java.util.Iterator<B2ApplicationKey>
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanhasNext() 
      B2ApplicationKeynext() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Iterator

        +forEachRemaining, remove
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2ListPartsIterable.html b/com/backblaze/b2/client/B2ListPartsIterable.html new file mode 100644 index 000000000..5c3e638c5 --- /dev/null +++ b/com/backblaze/b2/client/B2ListPartsIterable.html @@ -0,0 +1,223 @@ + + + + + +B2ListPartsIterable (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2ListPartsIterable

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.Iterable<B2Part>
    +
    +
    +
    All Known Implementing Classes:
    +
    B2ListPartsIterableBase, B2ListPartsIterableImpl
    +
    +
    +
    public interface B2ListPartsIterable
    +extends java.lang.Iterable<B2Part>
    +
    This interface collects the APIs we provide on our B2Part iterables. + For now, it's just the Iterable-ness. Someday, I expect it, or some interfaces + to provide some kind of "get resume point" functionality.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, iterator, spliterator
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2ListPartsIterableBase.IterBase.html b/com/backblaze/b2/client/B2ListPartsIterableBase.IterBase.html new file mode 100644 index 000000000..b46b4e211 --- /dev/null +++ b/com/backblaze/b2/client/B2ListPartsIterableBase.IterBase.html @@ -0,0 +1,335 @@ + + + + + +B2ListPartsIterableBase.IterBase (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListPartsIterableBase.IterBase

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Iterator<B2Part>
    +
    +
    +
    Enclosing class:
    +
    B2ListPartsIterableBase
    +
    +
    +
    protected abstract class B2ListPartsIterableBase.IterBase
    +extends java.lang.Object
    +implements java.util.Iterator<B2Part>
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
        +
        +
        Specified by:
        +
        hasNext in interface java.util.Iterator<B2Part>
        +
        +
      • +
      + + + +
        +
      • +

        next

        +
        public B2Part next()
        +
        +
        Specified by:
        +
        next in interface java.util.Iterator<B2Part>
        +
        +
      • +
      + + + +
        +
      • +

        getCurrentResponseOrNull

        +
        protected abstract B2ListPartsResponse getCurrentResponseOrNull()
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2ListPartsIterableBase.html b/com/backblaze/b2/client/B2ListPartsIterableBase.html new file mode 100644 index 000000000..deeda2c25 --- /dev/null +++ b/com/backblaze/b2/client/B2ListPartsIterableBase.html @@ -0,0 +1,321 @@ + + + + + +B2ListPartsIterableBase (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListPartsIterableBase

+
+
+ +
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      protected B2StorageClientImplgetClient() 
      java.util.Iterator<B2Part>iterator() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<B2Part> iterator()
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<B2Part>
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2ListPartsIterableImpl.html b/com/backblaze/b2/client/B2ListPartsIterableImpl.html new file mode 100644 index 000000000..7cef0bc06 --- /dev/null +++ b/com/backblaze/b2/client/B2ListPartsIterableImpl.html @@ -0,0 +1,308 @@ + + + + + +B2ListPartsIterableImpl (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListPartsIterableImpl

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2ListUnfinishedLargeFilesIterable.html b/com/backblaze/b2/client/B2ListUnfinishedLargeFilesIterable.html new file mode 100644 index 000000000..ed86563be --- /dev/null +++ b/com/backblaze/b2/client/B2ListUnfinishedLargeFilesIterable.html @@ -0,0 +1,308 @@ + + + + + +B2ListUnfinishedLargeFilesIterable (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListUnfinishedLargeFilesIterable

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2PartSpec.html b/com/backblaze/b2/client/B2PartSpec.html new file mode 100644 index 000000000..3574cbefe --- /dev/null +++ b/com/backblaze/b2/client/B2PartSpec.html @@ -0,0 +1,371 @@ + + + + + +B2PartSpec (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2PartSpec

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Comparable<B2PartSpec>
    +
    +
    +
    public class B2PartSpec
    +extends java.lang.Object
    +implements java.lang.Comparable<B2PartSpec>
    +
    A B2PartSpec represents part of a large file. + It has the partNumber and the offset & length of the part in the file.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPartNumber

        +
        public int getPartNumber()
        +
      • +
      + + + +
        +
      • +

        getStart

        +
        public long getStart()
        +
      • +
      + + + +
        +
      • +

        getLength

        +
        public long getLength()
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        compareTo

        +
        public int compareTo​(B2PartSpec o)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<B2PartSpec>
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2PartStorer.html b/com/backblaze/b2/client/B2PartStorer.html new file mode 100644 index 000000000..866f4e726 --- /dev/null +++ b/com/backblaze/b2/client/B2PartStorer.html @@ -0,0 +1,314 @@ + + + + + +B2PartStorer (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2PartStorer

+
+
+
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPartNumber

        +
        int getPartNumber()
        +
        +
        Returns:
        +
        The part number this object will store.
        +
        +
      • +
      + + + + + + + +
        +
      • +

        storePart

        +
        B2Part storePart​(B2LargeFileStorer largeFileStorer,
        +                 B2UploadListener uploadListener,
        +                 B2CancellationToken cancellationToken)
        +          throws java.io.IOException,
        +                 B2Exception
        +
        Store the part this B2PartStorer is responsible for.
        +
        +
        Parameters:
        +
        largeFileStorer - The object managing the storage of the whole large file.
        +
        uploadListener - The listener that tracks upload progress events.
        +
        cancellationToken - token to check whether the action has been cancelled
        +
        Returns:
        +
        The part that is stored, if successful.
        +
        Throws:
        +
        B2Exception - if there's trouble.
        +
        java.io.IOException
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2RetryPolicy.html b/com/backblaze/b2/client/B2RetryPolicy.html new file mode 100644 index 000000000..d42e13abc --- /dev/null +++ b/com/backblaze/b2/client/B2RetryPolicy.html @@ -0,0 +1,409 @@ + + + + + +B2RetryPolicy (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2RetryPolicy

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    B2DefaultRetryPolicy
    +
    +
    +
    public interface B2RetryPolicy
    +
    The B2RetryPolicy is called once after each attempt. It is always passed + the number of attempts that have been made so far (attemptsSoFar) and + the number of milliseconds the call took (tookMs). For unsuccessful + attempts, it is also passed the exception which caused the failure. + + For each of the getRetryable*() methods, the policy is consulted to decide + whether (and when) to retry. + + By the way, attemptsSoFar starts at 1.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and TypeMethodDescription
      java.lang.IntegergotRetryableAfterDelay​(java.lang.String operation, + int attemptsSoFar, + long tookMillis, + B2Exception e) +
      Callable.call() threw a retryable B2Exception but we have to wait a + while before retrying.
      +
      booleangotRetryableImmediately​(java.lang.String operation, + int attemptsSoFar, + long tookMillis, + B2Exception e) +
      Callable.call() threw a retryable B2Exception.
      +
      default voidgotUnexpectedUnretryable​(java.lang.String operation, + int attemptsSoFar, + long tookMillis, + java.lang.Exception e) +
      Callable.call() threw an Exception that wasn't a B2Exception.
      +
      default voidgotUnretryable​(java.lang.String operation, + int attemptsSoFar, + long tookMillis, + B2Exception e) +
      Callable.call() threw an unretryable B2Exception.
      +
      default voidsucceeded​(java.lang.String operation, + int attemptsSoFar, + long tookMillis) +
      Called when callable.call() returns without an exception.
      +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        succeeded

        +
        default void succeeded​(java.lang.String operation,
        +                       int attemptsSoFar,
        +                       long tookMillis)
        +
        Called when callable.call() returns without an exception.
        +
        +
        Parameters:
        +
        operation - the name of what is being retried. *usually* the name of a b2 operation.
        +
        attemptsSoFar - how many times have we called callable.call() so far?
        +
        tookMillis - how long did this attempt take?
        +
        +
      • +
      + + + +
        +
      • +

        gotRetryableAfterDelay

        +
        java.lang.Integer gotRetryableAfterDelay​(java.lang.String operation,
        +                                         int attemptsSoFar,
        +                                         long tookMillis,
        +                                         B2Exception e)
        +
        Callable.call() threw a retryable B2Exception but we have to wait a + while before retrying. If the guide decides we've tried enough times, + it should return null. Otherwise, it should return the number of + seconds to sleep before trying again. +

        + if e.getRetryAfterSecondsOrNull() is not null, it's the number of seconds + the server suggests that you wait before trying again. +

        + WARNING: if we only hit retryable errors and this never returns null, + we will keep retrying indefinitely. You have been warned.

        +
        +
        Parameters:
        +
        operation - the name of what is being retried. *usually* the name of a b2 operation.
        +
        attemptsSoFar - how many times have we called callable.call() so far?
        +
        tookMillis - how long did this attempt take?
        +
        e - the retryable exception.
        +
        Returns:
        +
        null to stop trying OR the number of seconds to sleep before trying again.
        +
        +
      • +
      + + + +
        +
      • +

        gotRetryableImmediately

        +
        boolean gotRetryableImmediately​(java.lang.String operation,
        +                                int attemptsSoFar,
        +                                long tookMillis,
        +                                B2Exception e)
        +
        Callable.call() threw a retryable B2Exception. We will retry immediately.
        +
        +
        Parameters:
        +
        operation - the name of what is being retried. *usually* the name of a b2 operation.
        +
        attemptsSoFar - how many times have we called callable.call() so far?
        +
        tookMillis - how long did this attempt take?
        +
        e - the retryable exception.
        +
        Returns:
        +
        true iff we should try again.
        +
        +
      • +
      + + + +
        +
      • +

        gotUnretryable

        +
        default void gotUnretryable​(java.lang.String operation,
        +                            int attemptsSoFar,
        +                            long tookMillis,
        +                            B2Exception e)
        +
        Callable.call() threw an unretryable B2Exception. No more attempts will be made.
        +
        +
        Parameters:
        +
        operation - the name of what is being retried. *usually* the name of a b2 operation.
        +
        attemptsSoFar - how many times have we called callable.call() so far?
        +
        tookMillis - how long did this attempt take?
        +
        e - the unretryable exception.
        +
        +
      • +
      + + + +
        +
      • +

        gotUnexpectedUnretryable

        +
        default void gotUnexpectedUnretryable​(java.lang.String operation,
        +                                      int attemptsSoFar,
        +                                      long tookMillis,
        +                                      java.lang.Exception e)
        +
        Callable.call() threw an Exception that wasn't a B2Exception. No more + attempts will be made.
        +
        +
        Parameters:
        +
        operation - the name of what is being retried. *usually* the name of a b2 operation.
        +
        attemptsSoFar - how many times have we called callable.call() so far?
        +
        tookMillis - how long did this attempt take?
        +
        e - the unexpected, unretryable exception.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2Sdk.html b/com/backblaze/b2/client/B2Sdk.html new file mode 100644 index 000000000..323e84076 --- /dev/null +++ b/com/backblaze/b2/client/B2Sdk.html @@ -0,0 +1,328 @@ + + + + + +B2Sdk (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2Sdk

+
+
+ +
+
    +
  • +
    +
    public class B2Sdk
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2Sdk() 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static java.lang.StringgetName() 
      static java.lang.StringgetVersion() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2Sdk

        +
        public B2Sdk()
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        public static java.lang.String getName()
        +
        +
        Returns:
        +
        the name of this sdk. + it's a string that matches [a-zA-Z][-_.a-zA-Z0-9]*
        +
        +
      • +
      + + + +
        +
      • +

        getVersion

        +
        public static java.lang.String getVersion()
        +
        +
        Returns:
        +
        the version of this SDK. + it's a string that matches [0-9][0-9.]*
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2StorageClient.html b/com/backblaze/b2/client/B2StorageClient.html new file mode 100644 index 000000000..f2f2e63b5 --- /dev/null +++ b/com/backblaze/b2/client/B2StorageClient.html @@ -0,0 +1,2479 @@ + + + + + +B2StorageClient (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2StorageClient

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.AutoCloseable, java.io.Closeable
    +
    +
    +
    All Known Implementing Classes:
    +
    B2StorageClientImpl
    +
    +
    +
    public interface B2StorageClient
    +extends java.io.Closeable
    +
    B2StorageClient is the interface for performing B2 operations. + Be sure to close() any instance you create when you are done with it. + Try-with-resources can be very useful for that. + + Here are some design principles: + + Be type-safe. + Use different types for requests & responses. + Keep things final. + Use builder classes to instantiate objects + so it's easier to add new attributes. + In addition, we provide convenience methods so the user + doesn't have to use the builder, when the object only + has one or two simple, obvious arguments. + + Throw B2Exception, a checked exception, for most problems. + + THREAD-SAFETY: You may call any methods from any thread at any time. + Calls may be blocked waiting for resources, but calling from multiple + threads is safe. (This assumes the Webifier is thread-safe, and the + default implementation is.) + + XXX: how much checking of requests should we do? for the moment, i'm + inclined to let the server do the bulk of the checking so + (1) i don't have to repeat it here and + (2) i don't have to rev. the client to let people take advantage of + a wider range of inputs, such as more fileInfos.) + we may very well revisit this.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAccountId

        +
        java.lang.String getAccountId()
        +                       throws B2Exception
        +
        +
        Returns:
        +
        the accountId for this client.
        +
        Throws:
        +
        B2Exception
        +
        +
      • +
      + + + +
        +
      • +

        getFilePolicy

        +
        B2FilePolicy getFilePolicy()
        +                    throws B2Exception
        +
        +
        Returns:
        +
        an object for answering policy questions, such as + whether to upload a file as a small or large file.
        +
        Throws:
        +
        B2Exception
        +
        +
      • +
      + + + +
        +
      • +

        createBucket

        +
        B2Bucket createBucket​(B2CreateBucketRequest request)
        +               throws B2Exception
        +
        Creates a new bucket with the given request.
        +
        +
        Parameters:
        +
        request - the request to create the bucket.
        +
        Returns:
        +
        the newly created bucket.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        createBucket

        +
        default B2Bucket createBucket​(java.lang.String bucketName,
        +                              java.lang.String bucketType)
        +                       throws B2Exception
        +
        Creates a new bucket with the specified bucketName and bucketType + and default settings for all of the other bucket attributes.
        +
        +
        Parameters:
        +
        bucketName - the requested name for the bucket
        +
        bucketType - the requested type of the bucket
        +
        Returns:
        +
        the newly created bucket
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + + + + + +
        +
      • +

        applicationKeys

        +
        B2ListKeysIterable applicationKeys​(B2ListKeysRequest request)
        +                            throws B2Exception
        +
        Returns an iterable whose iterator yields the application keys that + match the given request. + + It will automatically call B2 to get batches of answers as needed. If there's + any trouble during hasNext() or next(), it will throw a B2RuntimeException + since Iterable<> doesn't allow checked exceptions to be thrown.
        +
        +
        Parameters:
        +
        request - specifies which application keys to list.
        +
        Returns:
        +
        a new iterable to iterate over fileVersions that match the given request.
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + + + + + +
        +
      • +

        applicationKeys

        +
        default B2ListKeysIterable applicationKeys()
        +                                    throws B2Exception
        +
        Just like applicationKeys(request), except that it makes a request for all + application keys for the account.
        +
        +
        Returns:
        +
        a new iterable to iterate over all of the keys in the specified account
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        buckets

        +
        default java.util.List<B2Bucket> buckets()
        +                                  throws B2Exception
        +
        +
        Returns:
        +
        a new list with all of the account's buckets for the b2 default buckets.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        getBucketOrNullByName

        +
        default B2Bucket getBucketOrNullByName​(java.lang.String name)
        +                                throws B2Exception
        +
        +
        Returns:
        +
        this account's bucket with the given name, + or null if this account doesn't have a bucket with the given name.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        uploadSmallFile

        +
        B2FileVersion uploadSmallFile​(B2UploadFileRequest request)
        +                       throws B2Exception
        +
        Uploads the specified content as a normal B2 file. + The file must be smaller than the maximum file size (5 GB).
        +
        +
        Parameters:
        +
        request - describes the content to upload and extra metadata about it.
        +
        Returns:
        +
        the B2FileVersion that represents it.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        copySmallFile

        +
        B2FileVersion copySmallFile​(B2CopyFileRequest request)
        +                     throws B2Exception
        +
        Makes a copy of a file in the same bucket. + The new file must be smaller than the maximum file size (5 GB).
        +
        +
        Parameters:
        +
        request - describes what file to copy, the range of bytes to copy, and how to handle file metadata.
        +
        Returns:
        +
        The B2FileVersion of the new file.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        uploadLargeFile

        +
        B2FileVersion uploadLargeFile​(B2UploadFileRequest request,
        +                              java.util.concurrent.ExecutorService executor)
        +                       throws B2Exception
        +
        Uploads the specified content as separate parts to form a B2 large file.
        +
        +
        Parameters:
        +
        request - describes the content to upload and extra metadata about it.
        +
        executor - the executor to use for uploading parts in parallel. + the caller retains ownership of the executor and is + responsible for shutting it down.
        +
        Returns:
        +
        the B2FileVersion that represents it.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        storeLargeFileFromLocalContent

        +
        B2FileVersion storeLargeFileFromLocalContent​(B2FileVersion fileVersion,
        +                                             B2ContentSource contentSource,
        +                                             B2UploadListener uploadListenerOrNull,
        +                                             java.util.concurrent.ExecutorService executor)
        +                                      throws B2Exception
        +
        Uploads the specified content source as separate parts to form a B2 large file. + + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method. However, this method will + call finish file. + + XXX: add storePartsForLargeFileFromLocalContent that stores parts but doesn't finish the file.
        +
        +
        Parameters:
        +
        fileVersion - The B2FileVersion for the large file getting stored. + This is the return value of startLargeFile().
        +
        contentSource - The contentSource to upload.
        +
        uploadListenerOrNull - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        The fileVersion of the large file after it has been finished.
        +
        Throws:
        +
        B2Exception - If there's trouble.
        +
        +
      • +
      + + + +
        +
      • +

        storeLargeFileFromLocalContent

        +
        B2FileVersion storeLargeFileFromLocalContent​(B2StoreLargeFileRequest storeLargeFileRequest,
        +                                             B2ContentSource contentSource,
        +                                             B2UploadListener uploadListenerOrNull,
        +                                             java.util.concurrent.ExecutorService executor)
        +                                      throws B2Exception
        +
        Uploads the specified content source as separate parts to form a B2 large file, + optionally allowing caller to pass SSE-C parameters to match those given to + startLargeFile(). + + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method as part of a + B2StoreLargeFileRequest. However, this method will call finish file. + + XXX: add storePartsForLargeFileFromLocalContent that stores parts but doesn't finish the file.
        +
        +
        Parameters:
        +
        storeLargeFileRequest - The B2StoreLargeFileRequest for the large file + getting stored. This is built from the return + value of startLargeFile() and any other relevant + parameters.
        +
        contentSource - The contentSource to upload.
        +
        uploadListenerOrNull - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        The fileVersion of the large file after it has been finished.
        +
        Throws:
        +
        B2Exception - If there's trouble.
        +
        +
      • +
      + + + +
        +
      • +

        storeLargeFileFromLocalContentAsync

        +
        java.util.concurrent.CompletableFuture<B2FileVersion> storeLargeFileFromLocalContentAsync​(B2FileVersion fileVersion,
        +                                                                                          B2ContentSource contentSource,
        +                                                                                          B2UploadListener uploadListenerOrNull,
        +                                                                                          java.util.concurrent.ExecutorService executor)
        +                                                                                   throws B2Exception
        +
        Initiates uploading the specified content source as separate parts to form a + B2 large file. This allows the upload to be cancelled partway through. + + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method. + + The returned future can be cancelled and this will also attempt to stop any part + uploads in progress. + + Cancelling after the b2_finish_large_file API call has been started will result in the + future being cancelled, but the API call can still succeed. There is no way to tell from + the future whether this is the case. The caller is responsible for checking and calling + B2StorageClient.cancelLargeFile.
        +
        +
        Parameters:
        +
        fileVersion - The B2FileVersion for the large file getting stored. + This is the return value of startLargeFile().
        +
        contentSource - The contentSource to upload.
        +
        uploadListenerOrNull - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        CompletableFuture with the resulting B2FileVersion of the completed file
        +
        Throws:
        +
        B2Exception - on error
        +
        +
      • +
      + + + +
        +
      • +

        storeLargeFileFromLocalContentAsync

        +
        java.util.concurrent.CompletableFuture<B2FileVersion> storeLargeFileFromLocalContentAsync​(B2StoreLargeFileRequest storeLargeFileRequest,
        +                                                                                          B2ContentSource contentSource,
        +                                                                                          B2UploadListener uploadListenerOrNull,
        +                                                                                          java.util.concurrent.ExecutorService executor)
        +                                                                                   throws B2Exception
        +
        Initiates uploading the specified content source as separate parts to form a + B2 large file. This allows the upload to be cancelled partway through. + + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method. + + The returned future can be cancelled and this will also attempt to stop any part + uploads in progress. + + Cancelling after the b2_finish_large_file API call has been started will result in the + future being cancelled, but the API call can still succeed. There is no way to tell from + the future whether this is the case. The caller is responsible for checking and calling + B2StorageClient.cancelLargeFile.
        +
        +
        Parameters:
        +
        storeLargeFileRequest - The B2StoreLargeFileRequest for the large file + getting stored. This is built from the return + value of startLargeFile() and any other relevant + parameters.
        +
        contentSource - The contentSource to upload.
        +
        uploadListenerOrNull - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        CompletableFuture with the resulting B2FileVersion of the completed file
        +
        Throws:
        +
        B2Exception - on error
        +
        +
      • +
      + + + +
        +
      • +

        storeLargeFile

        +
        B2FileVersion storeLargeFile​(B2FileVersion fileVersion,
        +                             java.util.List<B2PartStorer> partStorers,
        +                             B2UploadListener uploadListenerOrNull,
        +                             java.util.concurrent.ExecutorService executor)
        +                      throws B2Exception
        +
        Stores a large file, where storing each part may involve different behavior + or byte sources. +

        + For example, this method supports the use case of making a copy of a file + that mostly has not changed, and the user only wishes to upload the parts + that have changed. In this case partStorers would be a mix of + B2CopyingPartStorers and one or more B2UploadingPartStorers. +

        + Another use case would be reattempting an upload of a large file where some + parts have completed, and some haven't. In this case, partStorers would + be a mix of B2AlreadyStoredPartStorer and B2UploadingPartStorers. +

        + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method. However, this method will + call finish file. Note that each part, whether copied or uploaded, is still + subject to the minimum part size.

        +
        +
        Parameters:
        +
        fileVersion - The B2FileVersion for the large file getting stored. + This is the return value of startLargeFile().
        +
        partStorers - The list of objects that know how to store the part + they are responsible for.
        +
        uploadListenerOrNull - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        The fileVersion of the large file after it has been finished.
        +
        Throws:
        +
        B2Exception - If there's trouble.
        +
        +
      • +
      + + + +
        +
      • +

        storeLargeFile

        +
        B2FileVersion storeLargeFile​(B2StoreLargeFileRequest storeLargeFileRequest,
        +                             java.util.List<B2PartStorer> partStorers,
        +                             B2UploadListener uploadListenerOrNull,
        +                             java.util.concurrent.ExecutorService executor)
        +                      throws B2Exception
        +
        Stores a large file, where storing each part may involve different behavior + or byte sources, optionally allowing caller to pass SSE-C parameters to match + those given to startLargeFile(). +

        + For example, this method supports the use case of making a copy of a file + that mostly has not changed, and the user only wishes to upload the parts + that have changed. In this case partStorers would be a mix of + B2CopyingPartStorers and one or more B2UploadingPartStorers. +

        + Another use case would be reattempting an upload of a large file where some + parts have completed, and some haven't. In this case, partStorers would + be a mix of B2AlreadyStoredPartStorer and B2UploadingPartStorers. +

        + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method as part of a + B2StoreLargeFileRequest. However, this method will call finish file. + Note that each part, whether copied or uploaded, + is still subject to the minimum part size.

        +
        +
        Parameters:
        +
        storeLargeFileRequest - The B2StoreLargeFileRequest for the large file + getting stored. This is built from the return + value of startLargeFile() and any other relevant + parameters.
        +
        partStorers - The list of objects that know how to store the part + they are responsible for.
        +
        uploadListenerOrNull - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        The fileVersion of the large file after it has been finished.
        +
        Throws:
        +
        B2Exception - If there's trouble.
        +
        +
      • +
      + + + +
        +
      • +

        storePartsForLargeFile

        +
        java.util.List<B2Part> storePartsForLargeFile​(B2FileVersion fileVersion,
        +                                              java.util.List<B2PartStorer> partStorers,
        +                                              B2UploadListener uploadListenerOrNull,
        +                                              java.util.concurrent.ExecutorService executor)
        +                                       throws B2Exception
        +
        Stores large file parts, where storing each part may involve different behavior + or byte sources. +

        + For example, this method supports the use case of preparing to make a copy + of a file that mostly has not changed, and the user only wishes to upload + the parts that have changed. In this case partStorers would be a mix of + B2CopyingPartStorers and one or more B2UploadingPartStorers. +

        + Another use case would be reattempting some part uploads for an unfinished + large file for which some parts have completed, and some haven't. In this case, + partStorers would be a mix of B2AlreadyStoredPartStorer and B2UploadingPartStorers. +

        + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method. Note that each part, whether + copied or uploaded, is still subject to the minimum part size. Note also that + this method does not finish the large file.

        +
        +
        Parameters:
        +
        fileVersion - The B2FileVersion for the large file for which these parts + are being uploaded. This is the return value of startLargeFile().
        +
        partStorers - The list of objects that know how to store the part + they are responsible for.
        +
        uploadListenerOrNull - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        The list of parts after all have been stored.
        +
        Throws:
        +
        B2Exception - If there's trouble.
        +
        +
      • +
      + + + +
        +
      • +

        storePartsForLargeFile

        +
        java.util.List<B2Part> storePartsForLargeFile​(B2StoreLargeFileRequest storeLargeFileRequest,
        +                                              java.util.List<B2PartStorer> partStorers,
        +                                              B2UploadListener uploadListenerOrNull,
        +                                              java.util.concurrent.ExecutorService executor)
        +                                       throws B2Exception
        +
        Stores large file parts, where storing each part may involve different behavior + or byte sources, optionally allowing caller to pass SSE-C parameters to match + those given to startLargeFile(). +

        + For example, this method supports the use case of making a copy of a file + that mostly has not changed, and the user only wishes to upload the parts + that have changed. In this case partStorers would be a mix of + B2CopyingPartStorers and one or more B2UploadingPartStorers. +

        + Another use case would be reattempting some part uploads for an unfinished + large file for which some parts have completed, and some haven't. In this case, + partStorers would be a mix of B2AlreadyStoredPartStorer and B2UploadingPartStorers. +

        + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method as part of a + B2StoreLargeFileRequest. Note that each part, whether copied or uploaded, + is still subject to the minimum part size. Note also that this method does + not finish the large file.

        +
        +
        Parameters:
        +
        storeLargeFileRequest - The B2StoreLargeFileRequest for the large file + for which these parts are being stored. This is + built from the return value of startLargeFile() and + any other relevant parameters.
        +
        partStorers - The list of objects that know how to store the part + they are responsible for.
        +
        uploadListenerOrNull - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        The list of parts after all have been stored.
        +
        Throws:
        +
        B2Exception - If there's trouble.
        +
        +
      • +
      + + + +
        +
      • +

        finishUploadingLargeFile

        +
        B2FileVersion finishUploadingLargeFile​(B2FileVersion fileVersion,
        +                                       B2UploadFileRequest request,
        +                                       java.util.concurrent.ExecutorService executor)
        +                                throws B2Exception
        +
        Verifies that the given fileVersion represents an unfinished large file + and that the specified content is compatible-enough with the information + in that B2FileVersion. If it is, this will find the parts that haven't yet been + uploaded and upload them to finish the large file. + + XXX: describe "compatible-enough". basically it's some sanity checks + such as the size of the content and the large-file-sha1 if it's available. + just enough to believe the request probably does go with the presented + fileVersion. (Note that if you make up a bogus fileVersion, you're on + your own!)
        +
        +
        Parameters:
        +
        fileVersion - describes the unfinished large file we want to finish.
        +
        request - describes the content we want to use to finish the large file
        +
        executor - the executor to use for uploading parts in parallel. + the caller retains ownership of the executor and is + responsible for shutting it down.
        +
        Returns:
        +
        the B2FileVersion that represents the finished large file.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        fileVersions

        +
        B2ListFilesIterable fileVersions​(B2ListFileVersionsRequest request)
        +                          throws B2Exception
        +
        Returns an iterable whose iterator yields the fileVersions that match the given request. + + It will automatically call B2 to get batches of answers as needed. If there's + any trouble during hasNext() or next(), it will throw a B2RuntimeException + since Iterable<> doesn't allow checked exceptions to be thrown.
        +
        +
        Parameters:
        +
        request - specifies which fileVersions to list.
        +
        Returns:
        +
        a new iterable to iterate over fileVersions that match the given request.
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        fileVersions

        +
        default B2ListFilesIterable fileVersions​(java.lang.String bucketId)
        +                                  throws B2Exception
        +
        Just like fileVersions(request), except that it makes a request for all + fileVersions in the specified bucket.
        +
        +
        Parameters:
        +
        bucketId - the bucket whose fileVersions you want an Iterable for.
        +
        Returns:
        +
        a new iterable to iterate over all of the fileVersions in the specified bucket.
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        fileNames

        +
        B2ListFilesIterable fileNames​(B2ListFileNamesRequest request)
        +                       throws B2Exception
        +
        Returns an iterable whose iterator yields the fileNames that match the given request. + + It will automatically call B2 to get batches of answers as needed. If there's + any trouble during hasNext() or next(), it will throw a B2RuntimeException + since Iterable<> doesn't allow checked exceptions to be thrown.
        +
        +
        Parameters:
        +
        request - specifies which fileVersions to list.
        +
        Returns:
        +
        a new iterable to iterate over fileVersions that match the given request.
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        fileNames

        +
        default B2ListFilesIterable fileNames​(java.lang.String bucketId)
        +                               throws B2Exception
        +
        Just like fileNames(request), except that it makes a request for all + fileNames in the specified bucket.
        +
        +
        Parameters:
        +
        bucketId - the bucket whose fileNames you want an Iterable for.
        +
        Returns:
        +
        a new iterable to iterate over all of the fileNames in the specified bucket.
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        unfinishedLargeFiles

        +
        B2ListFilesIterable unfinishedLargeFiles​(B2ListUnfinishedLargeFilesRequest request)
        +                                  throws B2Exception
        +
        Returns an iterable whose iterator yields the fileVersions of large, + unfinished files that match the given request. + + It will automatically call B2 to get batches of answers as needed. If there's + any trouble during hasNext() or next(), it will throw a B2RuntimeException + since Iterable<> doesn't allow checked exceptions to be thrown.
        +
        +
        Parameters:
        +
        request - specifies which unfinished large files to list
        +
        Returns:
        +
        a new iterable to iterate over fileVersions that match the given request.
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        unfinishedLargeFiles

        +
        default B2ListFilesIterable unfinishedLargeFiles​(java.lang.String bucketId)
        +                                          throws B2Exception
        +
        Just like unfinishedLargeFiles(request), except that it makes a request for all + unfinished large files in the specified bucket.
        +
        +
        Parameters:
        +
        bucketId - the bucket whose fileNames you want an Iterable for.
        +
        Returns:
        +
        a new iterable to iterate over all of the unfinished large files in the specified bucket.
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        parts

        +
        B2ListPartsIterable parts​(B2ListPartsRequest request)
        +                   throws B2Exception
        +
        Returns an iterable whose iterator yields the parts of large, + unfinished files that match the given request. + + It will automatically call B2 to get batches of answers as needed. If there's + any trouble during hasNext() or next(), it will throw a B2RuntimeException + since Iterable<> doesn't allow checked exceptions to be thrown.
        +
        +
        Parameters:
        +
        request - specifies which parts to list
        +
        Returns:
        +
        a new iterable to iterate over parts that match the given request.
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        parts

        +
        default B2ListPartsIterable parts​(java.lang.String largeFileId)
        +                           throws B2Exception
        +
        Just like parts(request), except that it makes a request for the parts + of the specified largeFileId.
        +
        +
        Parameters:
        +
        largeFileId - the large file whose parts you want an Iterable for.
        +
        Returns:
        +
        a new iterable to iterate over all of the parts of the specified file.
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        cancelLargeFile

        +
        void cancelLargeFile​(B2CancelLargeFileRequest cancelRequest)
        +              throws B2Exception
        +
        Cancels an unfinished large file.
        +
        +
        Parameters:
        +
        cancelRequest - specifies which unfinsihed large file to cancel.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        cancelLargeFile

        +
        default void cancelLargeFile​(java.lang.String largeFileId)
        +                      throws B2Exception
        +
        Just like cancelLargeFile(request), except that you only need to specify + the largeFileId for the unfinished large file you're trying to cancel.
        +
        +
        Parameters:
        +
        largeFileId - specifies the unfinished, large file to cancel.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        downloadById

        +
        void downloadById​(B2DownloadByIdRequest request,
        +                  B2ContentSink handler)
        +           throws B2Exception
        +
        Asks to download the specified file by id.
        +
        +
        Parameters:
        +
        request - specifies the file and which part of the file to request.
        +
        handler - if the server starts sending us the file, the headers and input + stream are passed to the handler. NOTE: if you get an exception + while processing the stream, be sure to clean up anything you've + created. the handler may or may not be called again based on the + exception.
        +
        Throws:
        +
        B2Exception - if there's trouble with the request or if the handler throws + an exception.
        +
        +
      • +
      + + + +
        +
      • +

        downloadById

        +
        default void downloadById​(java.lang.String fileId,
        +                          B2ContentSink handler)
        +                   throws B2Exception
        +
        Just like downloadById(request), but you only have to specify the fileId + instead of a request object.
        +
        +
        Parameters:
        +
        fileId - the id of the file you want to download.
        +
        handler - the handler to process the data as its downloaded.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        downloadByName

        +
        void downloadByName​(B2DownloadByNameRequest request,
        +                    B2ContentSink handler)
        +             throws B2Exception
        +
        Asks to download the specified file by bucket name and file name.
        +
        +
        Parameters:
        +
        request - specifies the file and which part of the file to request.
        +
        handler - if the server starts sending us the file, the headers and input + stream are passed to the handler. NOTE: if you get an exception + while processing the stream, be sure to clean up anything you've + created. the handler may or may not be called again based on the + exception.
        +
        Throws:
        +
        B2Exception - if there's trouble with the request or if the handler throws + an exception.
        +
        +
      • +
      + + + +
        +
      • +

        downloadByName

        +
        default void downloadByName​(java.lang.String bucketName,
        +                            java.lang.String fileName,
        +                            B2ContentSink handler)
        +                     throws B2Exception
        +
        Just like downloadByName(request), but you only have to specify the + bucketName and the fileName instead of a request object.
        +
        +
        Parameters:
        +
        bucketName - the name of the bucket you want to download from.
        +
        fileName - the name of the file you want to download.
        +
        handler - the handler to process the data as its downloaded.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        deleteFileVersion

        +
        void deleteFileVersion​(B2DeleteFileVersionRequest request)
        +                throws B2Exception
        +
        Deletes the specified file version.
        +
        +
        Parameters:
        +
        request - specifies which fileVersion to delete.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        deleteFileVersion

        +
        default void deleteFileVersion​(B2FileVersion version)
        +                        throws B2Exception
        +
        Just like deleteFileVersion(request), except that the request is created from + the specified fileVersion.
        +
        +
        Parameters:
        +
        version - specifies the fileVersion to delete.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        deleteFileVersion

        +
        default void deleteFileVersion​(java.lang.String fileName,
        +                               java.lang.String fileId)
        +                        throws B2Exception
        +
        Just like deleteFileVersion(request), except that the request is created from + the specified fileName and fileId.
        +
        +
        Parameters:
        +
        fileName - the name of the file to delete.
        +
        fileId - the id of the file to delete.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        deleteAllFilesInBucket

        +
        default void deleteAllFilesInBucket​(java.lang.String bucketId)
        +                             throws B2Exception
        +
        Delete all files in bucket.
        +
        +
        Parameters:
        +
        bucketId - the bucket whose file versions should be deleted
        +
        Throws:
        +
        B2Exception - if there's any trouble. if there's trouble, it's undefined which + file versions have been deleted (if any) and which haven't (if any).
        +
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        getFileInfo

        +
        default B2FileVersion getFileInfo​(java.lang.String fileId)
        +                           throws B2Exception
        +
        Just like getFileInfo(request) except that the request is created + from the given fileId.
        +
        +
        Parameters:
        +
        fileId - specifies the file whose info to fetch.
        +
        Returns:
        +
        a B2FileVersion object
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getFileInfoByName

        +
        default B2FileVersion getFileInfoByName​(java.lang.String bucketName,
        +                                        java.lang.String fileName)
        +                                 throws B2Exception
        +
        Just like getFileInfoByName(request), but for the most recent version of file + with the specified fileName in the specified bucket.
        +
        +
        Parameters:
        +
        bucketName - bucketName the name of the bucket containing the file you want info about.
        +
        fileName - fileName the name of the file whose info you're interested in.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        hideFile

        +
        B2FileVersion hideFile​(B2HideFileRequest request)
        +                throws B2Exception
        +
        Hides the specified file.
        +
        +
        Parameters:
        +
        request - specifies the file to hide
        +
        Returns:
        +
        the fileVersion that's hiding the specified path
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        hideFile

        +
        default B2FileVersion hideFile​(java.lang.String bucketId,
        +                               java.lang.String fileName)
        +                        throws B2Exception
        +
        Just like hideFile(request) except the request is created from the + given bucketId and fileName.
        +
        +
        Parameters:
        +
        bucketId - the id of the bucket containing the file we want to hide
        +
        fileName - the name of the file we want to hide
        +
        Returns:
        +
        the fileVersion that's hiding the specified path
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        updateBucket

        +
        B2Bucket updateBucket​(B2UpdateBucketRequest request)
        +               throws B2Exception
        +
        Updates the specified bucket as described by the request.
        +
        +
        Parameters:
        +
        request - specifies which bucket to update and how to update it.
        +
        Returns:
        +
        the new state of the bucket
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        See Also:
        +
        b2_update_bucket
        +
        +
      • +
      + + + +
        +
      • +

        deleteBucket

        +
        B2Bucket deleteBucket​(B2DeleteBucketRequest request)
        +               throws B2Exception
        +
        Deletes the specified bucket. + Note that it must be empty.
        +
        +
        Parameters:
        +
        request - specifies the bucket to delete.
        +
        Returns:
        +
        the deleted bucket
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        deleteBucket

        +
        default B2Bucket deleteBucket​(java.lang.String bucketId)
        +                       throws B2Exception
        +
        Just like deleteBucket(request) except that the request is created + from the specified bucketId.
        +
        +
        Parameters:
        +
        bucketId - the bucket to delete.
        +
        Returns:
        +
        the deleted bucket
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        getDownloadByIdUrl

        +
        java.lang.String getDownloadByIdUrl​(B2DownloadByIdRequest request)
        +                             throws B2Exception
        +
        Returns the URL for downloading the file specified by the request. + Note that note all of the request will be represented in the URL. + For instance, the url will not contain authorization or range information + since we normally send those in the request headers. +

        + This is useful for generating public URLs and as part of generating + signed download URLs.

        +
        +
        Parameters:
        +
        request - specifies what to download.
        +
        Returns:
        +
        a URL for fetching the file.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        getDownloadByIdUrl

        +
        default java.lang.String getDownloadByIdUrl​(java.lang.String fileId)
        +                                     throws B2Exception
        +
        Just like getDownloadByIdUrl(request) except that the request is created + from the given fileId.
        +
        +
        Parameters:
        +
        fileId - the file whose download url we're interested in.
        +
        Returns:
        +
        the URL
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        getDownloadByNameUrl

        +
        java.lang.String getDownloadByNameUrl​(B2DownloadByNameRequest request)
        +                               throws B2Exception
        +
        Returns the URL for downloading the file specified by the request. + Note that note all of the request will be represented in the URL. + For instance, the url will not contain authorization or range information + since we normally send those in the request headers. +

        + This is useful for generating public URLs and as part of generating + signed download URLs.

        +
        +
        Parameters:
        +
        request - specifies what to download.
        +
        Returns:
        +
        a URL for fetching the file.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        getDownloadByNameUrl

        +
        default java.lang.String getDownloadByNameUrl​(java.lang.String bucketName,
        +                                              java.lang.String fileName)
        +                                       throws B2Exception
        +
        Just like getDownloadByIdUrl(request) except that the request is created + from the given bucketName and fileName.
        +
        +
        Parameters:
        +
        bucketName - the name of the bucket that contains the desired file.
        +
        fileName - the name of the file whose download URL we want.
        +
        Returns:
        +
        the URL
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        getAccountAuthorization

        +
        B2AccountAuthorization getAccountAuthorization()
        +                                        throws B2Exception
        +
        This method provides access to an account authorization structure. + The returned structure may have been cached. + + When possible, you should use other objects and helpers instead of + using the account authorization directly, so that the B2StorageClient + can properly invalidate the cached authorization, if any, in response + to interactions with the server. + + For instance, for downloading: + + * to download files, use downloadByName() or downloadById(). + + * if you don't want to download directly, but need to give a download + url to some other code, use getDownloadByIdUrl() or getDownloadByNameUrl(). + + * if neither of those will work for you because you need some other + code to be able to form the download urls itself, you may need to + getAccountAuthorization() and get the downloadUrl from it. + + For instance, when deciding whether to use uploadSmallFile() or uploadLargeFile(), + call getFilePolicy() and use the helper methods on the result.
        +
        +
        Returns:
        +
        the account authorization, possibly from a cache.
        +
        Throws:
        +
        B2Exception - if there's trouble getting the authorization.
        +
        +
      • +
      + + + +
        +
      • +

        invalidateAccountAuthorization

        +
        void invalidateAccountAuthorization()
        +
        If there's a cached account authorization, this will flush the cache + so that the authorization will need to be reacquired the next time + it is needed. (Keep in mind that another thread may need it and + reacquire it before this method even returns.) + + You should never need to call this unless you have called getAccountAuthorization() + and have gotten some kind of authorization exception when using the contents of + that authorization. It's really a lot simpler for you if you never do that + and instead always do your work through B2StorageClient's APIs!
        +
      • +
      + + + +
        +
      • +

        getUploadUrl

        +
        B2UploadUrlResponse getUploadUrl​(B2GetUploadUrlRequest request)
        +                          throws B2Exception
        +
        This method allows the caller to get an upload url and authorization + token directly. + + Note that the SDK has lots of logic to upload files and getting upload URLs + and using them outside the SDK means that you need to handle lots of details + of uploading by yourself including: + * retrying based on the types of errors you get, with proper backoff. + * refreshing your account authorization when it expires. + * reusing upload urls when possible + * etc. + + When possible you should seriously consider using uploadSmallFile() and + uploadLargeFile() instead of reimplementing that logic. If there's a + reason you can't use those methods, let us know. Perhaps we can improve + things together to meet your needs.
        +
        +
        Parameters:
        +
        request - specifies details about the desired upload url and credentials.
        +
        Returns:
        +
        the response from the server.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        getUploadPartUrl

        +
        B2UploadPartUrlResponse getUploadPartUrl​(B2GetUploadPartUrlRequest request)
        +                                  throws B2Exception
        +
        This method allows the caller to get an upload url and authorization + token directly for uploading a large file part. + + Note that the SDK has lots of logic to upload files and getting upload URLs + and using them outside the SDK means that you need to handle lots of details + of uploading by yourself including: + * retrying based on the types of errors you get, with proper backoff. + * refreshing your account authorization when it expires. + * reusing upload urls when possible + * etc. + + When possible you should seriously consider using uploadSmallFile() and + uploadLargeFile() instead of reimplementing that logic. If there's a + reason you can't use those methods, let us know. Perhaps we can improve + things together to meet your needs.
        +
        +
        Parameters:
        +
        request - specifies details about the desired upload url and credentials.
        +
        Returns:
        +
        the response from the server.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        startLargeFile

        +
        B2FileVersion startLargeFile​(B2StartLargeFileRequest request)
        +                      throws B2Exception
        +
        This method allows the caller to start a large file. + + Note that the SDK has lots of logic to upload large files and doing your + own uploading outside the SDK means that you need to handle lots of details + of uploading by yourself including: + * retrying based on the types of errors you get, with proper backoff. + * refreshing your account authorization when it expires. + * reusing upload urls when possible + * etc. + + When possible you should seriously consider using uploadLargeFile() + instead of reimplementing that logic. If there's a reason you can't use + those methods, let us know. Perhaps we can improve things together to + meet your needs.
        +
        +
        Parameters:
        +
        request - specifies details about the file to start.
        +
        Returns:
        +
        the response from the server.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        finishLargeFile

        +
        B2FileVersion finishLargeFile​(B2FinishLargeFileRequest request)
        +                       throws B2Exception
        +
        This method allows the caller to finish a large file. + + Note that the SDK has lots of logic to upload large files and doing your + own uploading outside the SDK means that you need to handle lots of details + of uploading by yourself including: + * retrying based on the types of errors you get, with proper backoff. + * refreshing your account authorization when it expires. + * reusing upload urls when possible + * etc. + + When possible you should seriously consider using uploadLargeFile() + or finishUploadingLargeFile() instead of reimplementing that logic. + If there's a reason you can't use those methods, let us know. Perhaps + we can improve things together to meet your needs.
        +
        +
        Parameters:
        +
        request - specifies details about the file to finish.
        +
        Returns:
        +
        the response from the server.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + + + + + + + + + + + + + + + + + +
        +
      • +

        setBucketNotificationRules

        +
        default B2SetBucketNotificationRulesResponse setBucketNotificationRules​(java.lang.String bucketId,
        +                                                                        java.util.List<B2EventNotificationRule> eventNotificationRules)
        +                                                                 throws B2Exception
        +
        Just like setBucketNotificationRules(request), except that the request is created from + the specified bucketId and eventNotificationRules.
        +
        +
        Parameters:
        +
        bucketId - the bucket whose eventNotificationRules you want to set.
        +
        eventNotificationRules - the eventNotificationRules to set on the bucket.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        getBucketNotificationRules

        +
        default B2GetBucketNotificationRulesResponse getBucketNotificationRules​(java.lang.String bucketId)
        +                                                                 throws B2Exception
        +
        Just like getBucketNotificationRules(request), except that the request is created from + the specified bucketId.
        +
        +
        Parameters:
        +
        bucketId - the bucket whose eventNotificationRules you want to get.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        close

        +
        void close()
        +
        Closes this instance, releasing resources.
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2StorageClientFactory.html b/com/backblaze/b2/client/B2StorageClientFactory.html new file mode 100644 index 000000000..2161a02d5 --- /dev/null +++ b/com/backblaze/b2/client/B2StorageClientFactory.html @@ -0,0 +1,333 @@ + + + + + +B2StorageClientFactory (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2StorageClientFactory

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    B2StorageClientFactoryPathBasedImpl
    +
    +
    +
    public interface B2StorageClientFactory
    +
    Implementations of B2StorageClientFactory can create a B2StorageClient from a B2ClientConfig. + There are a couple of convenience methods for constructing B2ClientConfigs. + + THREAD-SAFE.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createDefaultFactory

        +
        static B2StorageClientFactory createDefaultFactory()
        +
        +
        Returns:
        +
        a new B2StorageClientFactory that picks whichever of the built-in B2StorageClientFactorys is + on the java class path.
        +
        +
      • +
      + + + +
        +
      • +

        create

        +
        B2StorageClient create​(B2ClientConfig config)
        +
        +
        Parameters:
        +
        config - the configuration to use.
        +
        Returns:
        +
        a new B2StorageClient or throws a RuntimeException if it can't make one.
        +
        +
      • +
      + + + +
        +
      • +

        create

        +
        default B2StorageClient create​(java.lang.String applicationKeyId,
        +                               java.lang.String applicationKey,
        +                               java.lang.String userAgent)
        +
        +
        Parameters:
        +
        applicationKeyId - the id of the secret to use to authenticate with the b2 servers
        +
        applicationKey - the secret used to authenticate with the b2 servers.
        +
        userAgent - the user agent to use when performing http requests.
        +
        Returns:
        +
        a new B2StorageClient or throws a RuntimeException if it can't make one.
        +
        +
      • +
      + + + +
        +
      • +

        create

        +
        default B2StorageClient create​(java.lang.String userAgent)
        +
        Gets the applicationKeyId and applicationKey from the environment and then
        +
        +
        Parameters:
        +
        userAgent - the user agent to use when performing http requests.
        +
        Returns:
        +
        a new B2StorageClient or throws a RuntimeException if it can't make one.
        +
        Throws:
        +
        java.lang.RuntimeException - if there's a problem getting the credentials from the environment or any other + problem creating the client.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2StorageClientFactoryPathBasedImpl.html b/com/backblaze/b2/client/B2StorageClientFactoryPathBasedImpl.html new file mode 100644 index 000000000..8ae4a4c6a --- /dev/null +++ b/com/backblaze/b2/client/B2StorageClientFactoryPathBasedImpl.html @@ -0,0 +1,294 @@ + + + + + +B2StorageClientFactoryPathBasedImpl (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2StorageClientFactoryPathBasedImpl

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2StorageClientFactory
    +
    +
    +
    public class B2StorageClientFactoryPathBasedImpl
    +extends java.lang.Object
    +implements B2StorageClientFactory
    +
    This implementation of B2StorageClientFactory has a list of registered class names + and instantiates the first one of those classes which can be loaded. + + Instances of this class start out knowing about the class names for all of the + official implementations. If it makes sense to let code that uses the library + register implementations, we can make registerClass() public, but it's possible + that it'll be easier for them to just make their own factory entirely. + + + THREAD-SAFE.
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2StorageClientImpl.html b/com/backblaze/b2/client/B2StorageClientImpl.html new file mode 100644 index 000000000..b2840c45e --- /dev/null +++ b/com/backblaze/b2/client/B2StorageClientImpl.html @@ -0,0 +1,2035 @@ + + + + + +B2StorageClientImpl (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2StorageClientImpl

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2StorageClient, java.io.Closeable, java.lang.AutoCloseable
    +
    +
    +
    public class B2StorageClientImpl
    +extends java.lang.Object
    +implements B2StorageClient
    +
    B2StorageClientImpl implements B2StorageClient and it acquires credentials as needed + and implements our retry policies. It's also smart about using other + threads to help with the uploads. + + THREAD-SAFETY: As long at the subobjects it's given are thread-safe, + this object may be used from multiple threads simultaneously.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2StorageClientImpl

        +
        public B2StorageClientImpl​(B2StorageClientWebifier webifier,
        +                           B2ClientConfig config,
        +                           java.util.function.Supplier<B2RetryPolicy> retryPolicySupplier)
        +
        Creates a client with the given webifier and config and a default B2Sleeper. + This is the normal constructor.
        +
        +
        Parameters:
        +
        webifier - the object to convert API calls into web calls.
        +
        config - the object used to configure this.
        +
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Closes resources used by this client. + It's safe to call when it's already been called. + It won't return until we've tried to close the resources.
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Specified by:
        +
        close in interface B2StorageClient
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        +
      • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        applicationKeys

        +
        public B2ListKeysIterable applicationKeys​(B2ListKeysRequest request)
        +                                   throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Returns an iterable whose iterator yields the application keys that + match the given request. + + It will automatically call B2 to get batches of answers as needed. If there's + any trouble during hasNext() or next(), it will throw a B2RuntimeException + since Iterable<> doesn't allow checked exceptions to be thrown.
        +
        +
        Specified by:
        +
        applicationKeys in interface B2StorageClient
        +
        Parameters:
        +
        request - specifies which application keys to list.
        +
        Returns:
        +
        a new iterable to iterate over fileVersions that match the given request.
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        finishUploadingLargeFile

        +
        public B2FileVersion finishUploadingLargeFile​(B2FileVersion fileVersion,
        +                                              B2UploadFileRequest request,
        +                                              java.util.concurrent.ExecutorService executor)
        +                                       throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Verifies that the given fileVersion represents an unfinished large file + and that the specified content is compatible-enough with the information + in that B2FileVersion. If it is, this will find the parts that haven't yet been + uploaded and upload them to finish the large file. + + XXX: describe "compatible-enough". basically it's some sanity checks + such as the size of the content and the large-file-sha1 if it's available. + just enough to believe the request probably does go with the presented + fileVersion. (Note that if you make up a bogus fileVersion, you're on + your own!)
        +
        +
        Specified by:
        +
        finishUploadingLargeFile in interface B2StorageClient
        +
        Parameters:
        +
        fileVersion - describes the unfinished large file we want to finish.
        +
        request - describes the content we want to use to finish the large file
        +
        executor - the executor to use for uploading parts in parallel. + the caller retains ownership of the executor and is + responsible for shutting it down.
        +
        Returns:
        +
        the B2FileVersion that represents the finished large file.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        uploadSmallFile

        +
        public B2FileVersion uploadSmallFile​(B2UploadFileRequest request)
        +                              throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Uploads the specified content as a normal B2 file. + The file must be smaller than the maximum file size (5 GB).
        +
        +
        Specified by:
        +
        uploadSmallFile in interface B2StorageClient
        +
        Parameters:
        +
        request - describes the content to upload and extra metadata about it.
        +
        Returns:
        +
        the B2FileVersion that represents it.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        copySmallFile

        +
        public B2FileVersion copySmallFile​(B2CopyFileRequest request)
        +                            throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Makes a copy of a file in the same bucket. + The new file must be smaller than the maximum file size (5 GB).
        +
        +
        Specified by:
        +
        copySmallFile in interface B2StorageClient
        +
        Parameters:
        +
        request - describes what file to copy, the range of bytes to copy, and how to handle file metadata.
        +
        Returns:
        +
        The B2FileVersion of the new file.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        uploadLargeFile

        +
        public B2FileVersion uploadLargeFile​(B2UploadFileRequest request,
        +                                     java.util.concurrent.ExecutorService executor)
        +                              throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Uploads the specified content as separate parts to form a B2 large file.
        +
        +
        Specified by:
        +
        uploadLargeFile in interface B2StorageClient
        +
        Parameters:
        +
        request - describes the content to upload and extra metadata about it.
        +
        executor - the executor to use for uploading parts in parallel. + the caller retains ownership of the executor and is + responsible for shutting it down.
        +
        Returns:
        +
        the B2FileVersion that represents it.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        storeLargeFileFromLocalContent

        +
        public B2FileVersion storeLargeFileFromLocalContent​(B2FileVersion fileVersion,
        +                                                    B2ContentSource contentSource,
        +                                                    B2UploadListener uploadListener,
        +                                                    java.util.concurrent.ExecutorService executor)
        +                                             throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Uploads the specified content source as separate parts to form a B2 large file. + + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method. However, this method will + call finish file. + + XXX: add storePartsForLargeFileFromLocalContent that stores parts but doesn't finish the file.
        +
        +
        Specified by:
        +
        storeLargeFileFromLocalContent in interface B2StorageClient
        +
        Parameters:
        +
        fileVersion - The B2FileVersion for the large file getting stored. + This is the return value of startLargeFile().
        +
        contentSource - The contentSource to upload.
        +
        uploadListener - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        The fileVersion of the large file after it has been finished.
        +
        Throws:
        +
        B2Exception - If there's trouble.
        +
        +
      • +
      + + + +
        +
      • +

        storeLargeFileFromLocalContent

        +
        public B2FileVersion storeLargeFileFromLocalContent​(B2StoreLargeFileRequest storeLargeFileRequest,
        +                                                    B2ContentSource contentSource,
        +                                                    B2UploadListener uploadListener,
        +                                                    java.util.concurrent.ExecutorService executor)
        +                                             throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Uploads the specified content source as separate parts to form a B2 large file, + optionally allowing caller to pass SSE-C parameters to match those given to + startLargeFile(). + + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method as part of a + B2StoreLargeFileRequest. However, this method will call finish file. + + XXX: add storePartsForLargeFileFromLocalContent that stores parts but doesn't finish the file.
        +
        +
        Specified by:
        +
        storeLargeFileFromLocalContent in interface B2StorageClient
        +
        Parameters:
        +
        storeLargeFileRequest - The B2StoreLargeFileRequest for the large file + getting stored. This is built from the return + value of startLargeFile() and any other relevant + parameters.
        +
        contentSource - The contentSource to upload.
        +
        uploadListener - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        The fileVersion of the large file after it has been finished.
        +
        Throws:
        +
        B2Exception - If there's trouble.
        +
        +
      • +
      + + + +
        +
      • +

        storeLargeFileFromLocalContentAsync

        +
        public java.util.concurrent.CompletableFuture<B2FileVersion> storeLargeFileFromLocalContentAsync​(B2FileVersion fileVersion,
        +                                                                                                 B2ContentSource contentSource,
        +                                                                                                 B2UploadListener uploadListenerOrNull,
        +                                                                                                 java.util.concurrent.ExecutorService executor)
        +                                                                                          throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Initiates uploading the specified content source as separate parts to form a + B2 large file. This allows the upload to be cancelled partway through. + + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method. + + The returned future can be cancelled and this will also attempt to stop any part + uploads in progress. + + Cancelling after the b2_finish_large_file API call has been started will result in the + future being cancelled, but the API call can still succeed. There is no way to tell from + the future whether this is the case. The caller is responsible for checking and calling + B2StorageClient.cancelLargeFile.
        +
        +
        Specified by:
        +
        storeLargeFileFromLocalContentAsync in interface B2StorageClient
        +
        Parameters:
        +
        fileVersion - The B2FileVersion for the large file getting stored. + This is the return value of startLargeFile().
        +
        contentSource - The contentSource to upload.
        +
        uploadListenerOrNull - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        CompletableFuture with the resulting B2FileVersion of the completed file
        +
        Throws:
        +
        B2Exception - on error
        +
        +
      • +
      + + + +
        +
      • +

        storeLargeFileFromLocalContentAsync

        +
        public java.util.concurrent.CompletableFuture<B2FileVersion> storeLargeFileFromLocalContentAsync​(B2StoreLargeFileRequest storeLargeFileRequest,
        +                                                                                                 B2ContentSource contentSource,
        +                                                                                                 B2UploadListener uploadListenerOrNull,
        +                                                                                                 java.util.concurrent.ExecutorService executor)
        +                                                                                          throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Initiates uploading the specified content source as separate parts to form a + B2 large file. This allows the upload to be cancelled partway through. + + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method. + + The returned future can be cancelled and this will also attempt to stop any part + uploads in progress. + + Cancelling after the b2_finish_large_file API call has been started will result in the + future being cancelled, but the API call can still succeed. There is no way to tell from + the future whether this is the case. The caller is responsible for checking and calling + B2StorageClient.cancelLargeFile.
        +
        +
        Specified by:
        +
        storeLargeFileFromLocalContentAsync in interface B2StorageClient
        +
        Parameters:
        +
        storeLargeFileRequest - The B2StoreLargeFileRequest for the large file + getting stored. This is built from the return + value of startLargeFile() and any other relevant + parameters.
        +
        contentSource - The contentSource to upload.
        +
        uploadListenerOrNull - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        CompletableFuture with the resulting B2FileVersion of the completed file
        +
        Throws:
        +
        B2Exception - on error
        +
        +
      • +
      + + + +
        +
      • +

        storeLargeFile

        +
        public B2FileVersion storeLargeFile​(B2FileVersion fileVersion,
        +                                    java.util.List<B2PartStorer> partStorers,
        +                                    B2UploadListener uploadListenerOrNull,
        +                                    java.util.concurrent.ExecutorService executor)
        +                             throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Stores a large file, where storing each part may involve different behavior + or byte sources. +

        + For example, this method supports the use case of making a copy of a file + that mostly has not changed, and the user only wishes to upload the parts + that have changed. In this case partStorers would be a mix of + B2CopyingPartStorers and one or more B2UploadingPartStorers. +

        + Another use case would be reattempting an upload of a large file where some + parts have completed, and some haven't. In this case, partStorers would + be a mix of B2AlreadyStoredPartStorer and B2UploadingPartStorers. +

        + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method. However, this method will + call finish file. Note that each part, whether copied or uploaded, is still + subject to the minimum part size.

        +
        +
        Specified by:
        +
        storeLargeFile in interface B2StorageClient
        +
        Parameters:
        +
        fileVersion - The B2FileVersion for the large file getting stored. + This is the return value of startLargeFile().
        +
        partStorers - The list of objects that know how to store the part + they are responsible for.
        +
        uploadListenerOrNull - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        The fileVersion of the large file after it has been finished.
        +
        Throws:
        +
        B2Exception - If there's trouble.
        +
        +
      • +
      + + + +
        +
      • +

        storeLargeFile

        +
        public B2FileVersion storeLargeFile​(B2StoreLargeFileRequest storeLargeFileRequest,
        +                                    java.util.List<B2PartStorer> partStorers,
        +                                    B2UploadListener uploadListenerOrNull,
        +                                    java.util.concurrent.ExecutorService executor)
        +                             throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Stores a large file, where storing each part may involve different behavior + or byte sources, optionally allowing caller to pass SSE-C parameters to match + those given to startLargeFile(). +

        + For example, this method supports the use case of making a copy of a file + that mostly has not changed, and the user only wishes to upload the parts + that have changed. In this case partStorers would be a mix of + B2CopyingPartStorers and one or more B2UploadingPartStorers. +

        + Another use case would be reattempting an upload of a large file where some + parts have completed, and some haven't. In this case, partStorers would + be a mix of B2AlreadyStoredPartStorer and B2UploadingPartStorers. +

        + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method as part of a + B2StoreLargeFileRequest. However, this method will call finish file. + Note that each part, whether copied or uploaded, + is still subject to the minimum part size.

        +
        +
        Specified by:
        +
        storeLargeFile in interface B2StorageClient
        +
        Parameters:
        +
        storeLargeFileRequest - The B2StoreLargeFileRequest for the large file + getting stored. This is built from the return + value of startLargeFile() and any other relevant + parameters.
        +
        partStorers - The list of objects that know how to store the part + they are responsible for.
        +
        uploadListenerOrNull - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        The fileVersion of the large file after it has been finished.
        +
        Throws:
        +
        B2Exception - If there's trouble.
        +
        +
      • +
      + + + +
        +
      • +

        storePartsForLargeFile

        +
        public java.util.List<B2Part> storePartsForLargeFile​(B2FileVersion fileVersion,
        +                                                     java.util.List<B2PartStorer> partStorers,
        +                                                     B2UploadListener uploadListenerOrNull,
        +                                                     java.util.concurrent.ExecutorService executor)
        +                                              throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Stores large file parts, where storing each part may involve different behavior + or byte sources. +

        + For example, this method supports the use case of preparing to make a copy + of a file that mostly has not changed, and the user only wishes to upload + the parts that have changed. In this case partStorers would be a mix of + B2CopyingPartStorers and one or more B2UploadingPartStorers. +

        + Another use case would be reattempting some part uploads for an unfinished + large file for which some parts have completed, and some haven't. In this case, + partStorers would be a mix of B2AlreadyStoredPartStorer and B2UploadingPartStorers. +

        + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method. Note that each part, whether + copied or uploaded, is still subject to the minimum part size. Note also that + this method does not finish the large file.

        +
        +
        Specified by:
        +
        storePartsForLargeFile in interface B2StorageClient
        +
        Parameters:
        +
        fileVersion - The B2FileVersion for the large file for which these parts + are being uploaded. This is the return value of startLargeFile().
        +
        partStorers - The list of objects that know how to store the part + they are responsible for.
        +
        uploadListenerOrNull - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        The list of parts after all have been stored.
        +
        Throws:
        +
        B2Exception - If there's trouble.
        +
        +
      • +
      + + + +
        +
      • +

        storePartsForLargeFile

        +
        public java.util.List<B2Part> storePartsForLargeFile​(B2StoreLargeFileRequest storeLargeFileRequest,
        +                                                     java.util.List<B2PartStorer> partStorers,
        +                                                     B2UploadListener uploadListenerOrNull,
        +                                                     java.util.concurrent.ExecutorService executor)
        +                                              throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Stores large file parts, where storing each part may involve different behavior + or byte sources, optionally allowing caller to pass SSE-C parameters to match + those given to startLargeFile(). +

        + For example, this method supports the use case of making a copy of a file + that mostly has not changed, and the user only wishes to upload the parts + that have changed. In this case partStorers would be a mix of + B2CopyingPartStorers and one or more B2UploadingPartStorers. +

        + Another use case would be reattempting some part uploads for an unfinished + large file for which some parts have completed, and some haven't. In this case, + partStorers would be a mix of B2AlreadyStoredPartStorer and B2UploadingPartStorers. +

        + This method assumes you have already called startLargeFile(). The return value + of that call needs to be passed into this method as part of a + B2StoreLargeFileRequest. Note that each part, whether copied or uploaded, + is still subject to the minimum part size. Note also that this method does + not finish the large file.

        +
        +
        Specified by:
        +
        storePartsForLargeFile in interface B2StorageClient
        +
        Parameters:
        +
        storeLargeFileRequest - The B2StoreLargeFileRequest for the large file + for which these parts are being stored. This is + built from the return value of startLargeFile() and + any other relevant parameters.
        +
        partStorers - The list of objects that know how to store the part + they are responsible for.
        +
        uploadListenerOrNull - The object that handles upload progress events. + This may be null if you do not need to be notified + of progress events.
        +
        executor - The executor for uploading parts in parallel. The caller + retains ownership of the executor and is responsible for + shutting it down.
        +
        Returns:
        +
        The list of parts after all have been stored.
        +
        Throws:
        +
        B2Exception - If there's trouble.
        +
        +
      • +
      + + + +
        +
      • +

        fileVersions

        +
        public B2ListFilesIterable fileVersions​(B2ListFileVersionsRequest request)
        +                                 throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Returns an iterable whose iterator yields the fileVersions that match the given request. + + It will automatically call B2 to get batches of answers as needed. If there's + any trouble during hasNext() or next(), it will throw a B2RuntimeException + since Iterable<> doesn't allow checked exceptions to be thrown.
        +
        +
        Specified by:
        +
        fileVersions in interface B2StorageClient
        +
        Parameters:
        +
        request - specifies which fileVersions to list.
        +
        Returns:
        +
        a new iterable to iterate over fileVersions that match the given request.
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        fileNames

        +
        public B2ListFilesIterable fileNames​(B2ListFileNamesRequest request)
        +                              throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Returns an iterable whose iterator yields the fileNames that match the given request. + + It will automatically call B2 to get batches of answers as needed. If there's + any trouble during hasNext() or next(), it will throw a B2RuntimeException + since Iterable<> doesn't allow checked exceptions to be thrown.
        +
        +
        Specified by:
        +
        fileNames in interface B2StorageClient
        +
        Parameters:
        +
        request - specifies which fileVersions to list.
        +
        Returns:
        +
        a new iterable to iterate over fileVersions that match the given request.
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        unfinishedLargeFiles

        +
        public B2ListFilesIterable unfinishedLargeFiles​(B2ListUnfinishedLargeFilesRequest request)
        +
        Description copied from interface: B2StorageClient
        +
        Returns an iterable whose iterator yields the fileVersions of large, + unfinished files that match the given request. + + It will automatically call B2 to get batches of answers as needed. If there's + any trouble during hasNext() or next(), it will throw a B2RuntimeException + since Iterable<> doesn't allow checked exceptions to be thrown.
        +
        +
        Specified by:
        +
        unfinishedLargeFiles in interface B2StorageClient
        +
        Parameters:
        +
        request - specifies which unfinished large files to list
        +
        Returns:
        +
        a new iterable to iterate over fileVersions that match the given request.
        +
        +
      • +
      + + + +
        +
      • +

        parts

        +
        public B2ListPartsIterable parts​(B2ListPartsRequest request)
        +                          throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Returns an iterable whose iterator yields the parts of large, + unfinished files that match the given request. + + It will automatically call B2 to get batches of answers as needed. If there's + any trouble during hasNext() or next(), it will throw a B2RuntimeException + since Iterable<> doesn't allow checked exceptions to be thrown.
        +
        +
        Specified by:
        +
        parts in interface B2StorageClient
        +
        Parameters:
        +
        request - specifies which parts to list
        +
        Returns:
        +
        a new iterable to iterate over parts that match the given request.
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + + + + + +
        +
      • +

        downloadById

        +
        public void downloadById​(B2DownloadByIdRequest request,
        +                         B2ContentSink handler)
        +                  throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Asks to download the specified file by id.
        +
        +
        Specified by:
        +
        downloadById in interface B2StorageClient
        +
        Parameters:
        +
        request - specifies the file and which part of the file to request.
        +
        handler - if the server starts sending us the file, the headers and input + stream are passed to the handler. NOTE: if you get an exception + while processing the stream, be sure to clean up anything you've + created. the handler may or may not be called again based on the + exception.
        +
        Throws:
        +
        B2Exception - if there's trouble with the request or if the handler throws + an exception.
        +
        +
      • +
      + + + +
        +
      • +

        getDownloadByIdUrl

        +
        public java.lang.String getDownloadByIdUrl​(B2DownloadByIdRequest request)
        +                                    throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Returns the URL for downloading the file specified by the request. + Note that note all of the request will be represented in the URL. + For instance, the url will not contain authorization or range information + since we normally send those in the request headers. +

        + This is useful for generating public URLs and as part of generating + signed download URLs.

        +
        +
        Specified by:
        +
        getDownloadByIdUrl in interface B2StorageClient
        +
        Parameters:
        +
        request - specifies what to download.
        +
        Returns:
        +
        a URL for fetching the file.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        getDownloadByNameUrl

        +
        public java.lang.String getDownloadByNameUrl​(B2DownloadByNameRequest request)
        +                                      throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Returns the URL for downloading the file specified by the request. + Note that note all of the request will be represented in the URL. + For instance, the url will not contain authorization or range information + since we normally send those in the request headers. +

        + This is useful for generating public URLs and as part of generating + signed download URLs.

        +
        +
        Specified by:
        +
        getDownloadByNameUrl in interface B2StorageClient
        +
        Parameters:
        +
        request - specifies what to download.
        +
        Returns:
        +
        a URL for fetching the file.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        downloadByName

        +
        public void downloadByName​(B2DownloadByNameRequest request,
        +                           B2ContentSink handler)
        +                    throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        Asks to download the specified file by bucket name and file name.
        +
        +
        Specified by:
        +
        downloadByName in interface B2StorageClient
        +
        Parameters:
        +
        request - specifies the file and which part of the file to request.
        +
        handler - if the server starts sending us the file, the headers and input + stream are passed to the handler. NOTE: if you get an exception + while processing the stream, be sure to clean up anything you've + created. the handler may or may not be called again based on the + exception.
        +
        Throws:
        +
        B2Exception - if there's trouble with the request or if the handler throws + an exception.
        +
        +
      • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        getAccountAuthorization

        +
        public B2AccountAuthorization getAccountAuthorization()
        +                                               throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        This method provides access to an account authorization structure. + The returned structure may have been cached. + + When possible, you should use other objects and helpers instead of + using the account authorization directly, so that the B2StorageClient + can properly invalidate the cached authorization, if any, in response + to interactions with the server. + + For instance, for downloading: + + * to download files, use downloadByName() or downloadById(). + + * if you don't want to download directly, but need to give a download + url to some other code, use getDownloadByIdUrl() or getDownloadByNameUrl(). + + * if neither of those will work for you because you need some other + code to be able to form the download urls itself, you may need to + getAccountAuthorization() and get the downloadUrl from it. + + For instance, when deciding whether to use uploadSmallFile() or uploadLargeFile(), + call getFilePolicy() and use the helper methods on the result.
        +
        +
        Specified by:
        +
        getAccountAuthorization in interface B2StorageClient
        +
        Returns:
        +
        the account authorization, possibly from a cache.
        +
        Throws:
        +
        B2Exception - if there's trouble getting the authorization.
        +
        +
      • +
      + + + +
        +
      • +

        invalidateAccountAuthorization

        +
        public void invalidateAccountAuthorization()
        +
        Description copied from interface: B2StorageClient
        +
        If there's a cached account authorization, this will flush the cache + so that the authorization will need to be reacquired the next time + it is needed. (Keep in mind that another thread may need it and + reacquire it before this method even returns.) + + You should never need to call this unless you have called getAccountAuthorization() + and have gotten some kind of authorization exception when using the contents of + that authorization. It's really a lot simpler for you if you never do that + and instead always do your work through B2StorageClient's APIs!
        +
        +
        Specified by:
        +
        invalidateAccountAuthorization in interface B2StorageClient
        +
        +
      • +
      + + + +
        +
      • +

        getUploadUrl

        +
        public B2UploadUrlResponse getUploadUrl​(B2GetUploadUrlRequest request)
        +                                 throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        This method allows the caller to get an upload url and authorization + token directly. + + Note that the SDK has lots of logic to upload files and getting upload URLs + and using them outside the SDK means that you need to handle lots of details + of uploading by yourself including: + * retrying based on the types of errors you get, with proper backoff. + * refreshing your account authorization when it expires. + * reusing upload urls when possible + * etc. + + When possible you should seriously consider using uploadSmallFile() and + uploadLargeFile() instead of reimplementing that logic. If there's a + reason you can't use those methods, let us know. Perhaps we can improve + things together to meet your needs.
        +
        +
        Specified by:
        +
        getUploadUrl in interface B2StorageClient
        +
        Parameters:
        +
        request - specifies details about the desired upload url and credentials.
        +
        Returns:
        +
        the response from the server.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        getUploadPartUrl

        +
        public B2UploadPartUrlResponse getUploadPartUrl​(B2GetUploadPartUrlRequest request)
        +                                         throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        This method allows the caller to get an upload url and authorization + token directly for uploading a large file part. + + Note that the SDK has lots of logic to upload files and getting upload URLs + and using them outside the SDK means that you need to handle lots of details + of uploading by yourself including: + * retrying based on the types of errors you get, with proper backoff. + * refreshing your account authorization when it expires. + * reusing upload urls when possible + * etc. + + When possible you should seriously consider using uploadSmallFile() and + uploadLargeFile() instead of reimplementing that logic. If there's a + reason you can't use those methods, let us know. Perhaps we can improve + things together to meet your needs.
        +
        +
        Specified by:
        +
        getUploadPartUrl in interface B2StorageClient
        +
        Parameters:
        +
        request - specifies details about the desired upload url and credentials.
        +
        Returns:
        +
        the response from the server.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        startLargeFile

        +
        public B2FileVersion startLargeFile​(B2StartLargeFileRequest request)
        +                             throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        This method allows the caller to start a large file. + + Note that the SDK has lots of logic to upload large files and doing your + own uploading outside the SDK means that you need to handle lots of details + of uploading by yourself including: + * retrying based on the types of errors you get, with proper backoff. + * refreshing your account authorization when it expires. + * reusing upload urls when possible + * etc. + + When possible you should seriously consider using uploadLargeFile() + instead of reimplementing that logic. If there's a reason you can't use + those methods, let us know. Perhaps we can improve things together to + meet your needs.
        +
        +
        Specified by:
        +
        startLargeFile in interface B2StorageClient
        +
        Parameters:
        +
        request - specifies details about the file to start.
        +
        Returns:
        +
        the response from the server.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + +
        +
      • +

        finishLargeFile

        +
        public B2FileVersion finishLargeFile​(B2FinishLargeFileRequest request)
        +                              throws B2Exception
        +
        Description copied from interface: B2StorageClient
        +
        This method allows the caller to finish a large file. + + Note that the SDK has lots of logic to upload large files and doing your + own uploading outside the SDK means that you need to handle lots of details + of uploading by yourself including: + * retrying based on the types of errors you get, with proper backoff. + * refreshing your account authorization when it expires. + * reusing upload urls when possible + * etc. + + When possible you should seriously consider using uploadLargeFile() + or finishUploadingLargeFile() instead of reimplementing that logic. + If there's a reason you can't use those methods, let us know. Perhaps + we can improve things together to meet your needs.
        +
        +
        Specified by:
        +
        finishLargeFile in interface B2StorageClient
        +
        Parameters:
        +
        request - specifies details about the file to finish.
        +
        Returns:
        +
        the response from the server.
        +
        Throws:
        +
        B2Exception - if there's any trouble.
        +
        +
      • +
      + + + + + + + + + + + + + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2StorageClientWebifier.html b/com/backblaze/b2/client/B2StorageClientWebifier.html new file mode 100644 index 000000000..b5ae16cf0 --- /dev/null +++ b/com/backblaze/b2/client/B2StorageClientWebifier.html @@ -0,0 +1,999 @@ + + + + + +B2StorageClientWebifier (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2StorageClientWebifier

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    All Known Implementing Classes:
    +
    B2StorageClientWebifierImpl
    +
    +
    +
    public interface B2StorageClientWebifier
    +extends java.lang.AutoCloseable
    +
    A B2StorageClientWebifier is responsible for converting from request objects + to web calls and back again. + * A webifier's main job is to hide the web-ness from the + higher-level logic. + * A webifier does NOT retry calls. + * A webifier is stateless and does not cache anything. + * Users can provide their own B2WebApiClient implementation + to build on their favorite web framework or to help + with unit testing. + + THREAD-SAFETY: Instances must be as thread-safe as the B2WebApiClient it's given. + if the B2WebApiClient is thread-safe, so is the webifier. If not, the webifier + isn't.
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2StorageClientWebifierImpl.html b/com/backblaze/b2/client/B2StorageClientWebifierImpl.html new file mode 100644 index 000000000..ab940b17c --- /dev/null +++ b/com/backblaze/b2/client/B2StorageClientWebifierImpl.html @@ -0,0 +1,1109 @@ + + + + + +B2StorageClientWebifierImpl (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2StorageClientWebifierImpl

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/B2UploadingPartStorer.html b/com/backblaze/b2/client/B2UploadingPartStorer.html new file mode 100644 index 000000000..6556dec1a --- /dev/null +++ b/com/backblaze/b2/client/B2UploadingPartStorer.html @@ -0,0 +1,416 @@ + + + + + +B2UploadingPartStorer (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UploadingPartStorer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2PartStorer
    +
    +
    +
    public class B2UploadingPartStorer
    +extends java.lang.Object
    +implements B2PartStorer
    +
    This implementation stores a part of a large file by uploading + the bytes from a B2ContentSource.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2UploadingPartStorer

        +
        public B2UploadingPartStorer​(int partNumber,
        +                             B2ContentSource contentSource)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPartNumber

        +
        public int getPartNumber()
        +
        +
        Specified by:
        +
        getPartNumber in interface B2PartStorer
        +
        Returns:
        +
        The part number this object will store.
        +
        +
      • +
      + + + + + + + +
        +
      • +

        storePart

        +
        public B2Part storePart​(B2LargeFileStorer largeFileStorer,
        +                        B2UploadListener uploadListener,
        +                        B2CancellationToken cancellationToken)
        +                 throws java.io.IOException,
        +                        B2Exception
        +
        Description copied from interface: B2PartStorer
        +
        Store the part this B2PartStorer is responsible for.
        +
        +
        Specified by:
        +
        storePart in interface B2PartStorer
        +
        Parameters:
        +
        largeFileStorer - The object managing the storage of the whole large file.
        +
        uploadListener - The listener that tracks upload progress events.
        +
        cancellationToken - token to check whether the action has been cancelled
        +
        Returns:
        +
        The part that is stored, if successful.
        +
        Throws:
        +
        B2Exception - if there's trouble.
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentHandlers/B2ContentFileWriter.Builder.html b/com/backblaze/b2/client/contentHandlers/B2ContentFileWriter.Builder.html new file mode 100644 index 000000000..a0186f342 --- /dev/null +++ b/com/backblaze/b2/client/contentHandlers/B2ContentFileWriter.Builder.html @@ -0,0 +1,282 @@ + + + + + +B2ContentFileWriter.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ContentFileWriter.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2ContentFileWriter
    +
    +
    +
    public static class B2ContentFileWriter.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentHandlers/B2ContentFileWriter.html b/com/backblaze/b2/client/contentHandlers/B2ContentFileWriter.html new file mode 100644 index 000000000..842ef870a --- /dev/null +++ b/com/backblaze/b2/client/contentHandlers/B2ContentFileWriter.html @@ -0,0 +1,357 @@ + + + + + +B2ContentFileWriter (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ContentFileWriter

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2ContentSink
    +
    +
    +
    public class B2ContentFileWriter
    +extends B2ContentWriter
    +
    This is a B2ContentWriter which records the incoming data into a file on disk. + + It is careful to flush & sync the file when closing it.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        createDestinationOutputStream

        +
        protected java.io.OutputStream createDestinationOutputStream()
        +                                                      throws java.io.IOException
        +
        +
        Specified by:
        +
        createDestinationOutputStream in class B2ContentWriter
        +
        Returns:
        +
        an outputStream to write to the destination. calling this is allowed to + destroy the existing output (if any) and make it impossible for + a stream created by createDestinationInputStream() to be able to + read the data, if any.
        +
        Throws:
        +
        java.io.IOException - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        createDestinationInputStream

        +
        protected java.io.InputStream createDestinationInputStream()
        +                                                    throws java.io.IOException
        +
        +
        Specified by:
        +
        createDestinationInputStream in class B2ContentWriter
        +
        Returns:
        +
        a new inputStream to read from the destination. + this might not contain what you think it should if readContents + hasn't completed successfully.
        +
        Throws:
        +
        java.io.IOException - if there's any trouble
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentHandlers/B2ContentMemoryWriter.Builder.html b/com/backblaze/b2/client/contentHandlers/B2ContentMemoryWriter.Builder.html new file mode 100644 index 000000000..6d6fb055a --- /dev/null +++ b/com/backblaze/b2/client/contentHandlers/B2ContentMemoryWriter.Builder.html @@ -0,0 +1,322 @@ + + + + + +B2ContentMemoryWriter.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ContentMemoryWriter.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2ContentMemoryWriter
    +
    +
    +
    public static class B2ContentMemoryWriter.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder()
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentHandlers/B2ContentMemoryWriter.html b/com/backblaze/b2/client/contentHandlers/B2ContentMemoryWriter.html new file mode 100644 index 000000000..6aab309d0 --- /dev/null +++ b/com/backblaze/b2/client/contentHandlers/B2ContentMemoryWriter.html @@ -0,0 +1,434 @@ + + + + + +B2ContentMemoryWriter (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ContentMemoryWriter

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2ContentSink
    +
    +
    +
    public class B2ContentMemoryWriter
    +extends B2ContentWriter
    +
    This is a B2ContentWriter which records the incoming data into an + in-memory byte array. + + This will completely fail if the contentLen is more than Integer.MAX_VALUE bytes. + It may cause other memory-related issues before that.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        readContent

        +
        public void readContent​(B2Headers responseHeaders,
        +                        java.io.InputStream rawIn)
        +                 throws B2Exception
        +
        Description copied from interface: B2ContentSink
        +
        Reads the data from the input stream. + + Does NOT need to close the stream. The caller of readContent() + will take care of that. + + If you don't read to the end of the inputStream, the connection + probably won't be re-usable, so read to the end unless you have + a good reason not to.
        +
        +
        Specified by:
        +
        readContent in interface B2ContentSink
        +
        Overrides:
        +
        readContent in class B2ContentWriter
        +
        Parameters:
        +
        responseHeaders - the headers from the response
        +
        rawIn - an input stream to read the content of the response
        +
        Throws:
        +
        B2Exception - if there's trouble
        +
        +
      • +
      + + + +
        +
      • +

        createDestinationOutputStream

        +
        protected java.io.OutputStream createDestinationOutputStream()
        +                                                      throws java.io.IOException
        +
        +
        Specified by:
        +
        createDestinationOutputStream in class B2ContentWriter
        +
        Returns:
        +
        an outputStream to write to the destination. calling this is allowed to + destroy the existing output (if any) and make it impossible for + a stream created by createDestinationInputStream() to be able to + read the data, if any.
        +
        Throws:
        +
        java.io.IOException - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        createDestinationInputStream

        +
        protected java.io.InputStream createDestinationInputStream()
        +                                                    throws java.io.IOException
        +
        +
        Specified by:
        +
        createDestinationInputStream in class B2ContentWriter
        +
        Returns:
        +
        a new inputStream to read from the destination. + this might not contain what you think it should if readContents + hasn't completed successfully.
        +
        Throws:
        +
        java.io.IOException - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        getBytes

        +
        public byte[] getBytes()
        +
        +
        Returns:
        +
        null if readContent hasn't made it far enough + or a new byteArray with the contents that were read.
        +
        NOTE
        +
        this might be empty or not quite what you expect if readContents() + hasn't completed successfully.
        +
        +
      • +
      + + + + + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentHandlers/B2ContentOutputStreamWriter.Builder.html b/com/backblaze/b2/client/contentHandlers/B2ContentOutputStreamWriter.Builder.html new file mode 100644 index 000000000..20e82a540 --- /dev/null +++ b/com/backblaze/b2/client/contentHandlers/B2ContentOutputStreamWriter.Builder.html @@ -0,0 +1,268 @@ + + + + + +B2ContentOutputStreamWriter.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ContentOutputStreamWriter.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2ContentOutputStreamWriter
    +
    +
    +
    public static class B2ContentOutputStreamWriter.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentHandlers/B2ContentOutputStreamWriter.Helper.html b/com/backblaze/b2/client/contentHandlers/B2ContentOutputStreamWriter.Helper.html new file mode 100644 index 000000000..0c6ed934c --- /dev/null +++ b/com/backblaze/b2/client/contentHandlers/B2ContentOutputStreamWriter.Helper.html @@ -0,0 +1,365 @@ + + + + + +B2ContentOutputStreamWriter.Helper (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2ContentOutputStreamWriter.Helper

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    B2ContentOutputStreamWriter
    +
    +
    +
    public static interface B2ContentOutputStreamWriter.Helper
    +
    A Helper provides the OutputStream(s) to write to and the InputStream(s) + to use to re-read the content after writing it. + + If you want to have the SHA1 verified by re-reading the written content, + override shouldVerifySha1ByRereadingFromDestination() to return true + and createInputStreamOrNull() to return a new InputStream on the written + content each time it is called.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createOutputStream

        +
        java.io.OutputStream createOutputStream()
        +                                 throws java.io.IOException
        +
        This might be called multiple times. Be sure to return a NEW OutputStream each time. + The Writer will write the entire contents of downloaded stream to the returned + OutputStream or fail while trying and possibly ask for another output stream.
        +
        +
        Returns:
        +
        a new OutputStream to write the content to.
        +
        Throws:
        +
        java.io.IOException - if there's trouble making the OutputStream.
        +
        +
      • +
      + + + +
        +
      • +

        shouldVerifySha1ByRereadingFromDestination

        +
        default boolean shouldVerifySha1ByRereadingFromDestination()
        +
        This might be called multiple times. Be sure to return the same result every time.
        +
        +
        Returns:
        +
        whether or not we should try to verify the SHA1 be re-reading + the content from the destination. The Helper must return the + same answer for its entire lifetime.
        +
        +
      • +
      + + + +
        +
      • +

        createInputStream

        +
        default java.io.InputStream createInputStream()
        +                                       throws java.io.IOException
        +
        This might be called multiple times. Be sure to return a NEW InputStream each time. + The returned InputStream must start reading at the beginning of the data written + by the writer. + + This will only be called if shouldVerifySha1ByRereadingFromDestination() returns true.
        +
        +
        Returns:
        +
        an InputStream to use to read the written content from its destination.
        +
        Throws:
        +
        java.io.IOException - if there's trouble creating the InputStream.
        +
        +
      • +
      + + + +
        +
      • +

        succeeded

        +
        default void succeeded()
        +
        Called after the download succeeds. This can be used to commit to the results of the download. + For instance, it could be a good time to move from a temp file name to a final filename. + + If you hit a serious problem, you will need to throw a RuntimeException to get the exception + all the way back to whomever called the download.
        +
      • +
      + + + +
        +
      • +

        failed

        +
        default void failed()
        +
        Called after the download fails (if it got as far as calling createOutputStream()). + This can be used to cleanup anything that was downloaded. For instance, it could be a good time + to delete a temporary file that was used for the download. + + If you hit a serious problem, you will need to throw a RuntimeException to get the exception + all the way back to whomever called the download.
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentHandlers/B2ContentOutputStreamWriter.html b/com/backblaze/b2/client/contentHandlers/B2ContentOutputStreamWriter.html new file mode 100644 index 000000000..2728e7db5 --- /dev/null +++ b/com/backblaze/b2/client/contentHandlers/B2ContentOutputStreamWriter.html @@ -0,0 +1,427 @@ + + + + + +B2ContentOutputStreamWriter (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ContentOutputStreamWriter

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2ContentSink
    +
    +
    +
    public class B2ContentOutputStreamWriter
    +extends B2ContentWriter
    +
    B2ContentOutputStreamWriter is a subclass of B2ContentWriter which uses a Helper to + create the OutputStream to write to, and optionally, the InputStream to use to + reread and verify the SHA1. + + This is a B2ContentWriter which writes the incoming data into an output stream created + by the provided outputStreamCreator. When it is constructed, it is give one or two Suppliers. + The outputStreamCreator must return a NEW OutputStream for writing to each time it is called. + The inputStreamCreator is optional. If it is provided, it must return a NEW InputStream each + time it is called; that InputStream will be used to read back the written contents to verify + the SHA1 of the written content (if the SHA1 is available). + + Note that the arguments are Suppliers, not just stream objects because B2ContentWriters + need to be able to handle the SDK performing retries. As mentioned above, be sure to + return a new Stream object each time your creators are called.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        createDestinationOutputStream

        +
        protected java.io.OutputStream createDestinationOutputStream()
        +                                                      throws java.io.IOException
        +
        +
        Specified by:
        +
        createDestinationOutputStream in class B2ContentWriter
        +
        Returns:
        +
        an outputStream to write to the destination. calling this is allowed to + destroy the existing output (if any) and make it impossible for + a stream created by createDestinationInputStream() to be able to + read the data, if any.
        +
        Throws:
        +
        java.io.IOException - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        createDestinationInputStream

        +
        protected java.io.InputStream createDestinationInputStream()
        +                                                    throws java.io.IOException
        +
        +
        Specified by:
        +
        createDestinationInputStream in class B2ContentWriter
        +
        Returns:
        +
        a new inputStream to read from the destination. + this might not contain what you think it should if readContents + hasn't completed successfully.
        +
        Throws:
        +
        java.io.IOException - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        succeeded

        +
        protected void succeeded()
        +
        Description copied from class: B2ContentWriter
        +
        Called when the download succeeded and, to the extent we're able to verify it, the SHA1 matched. + + Called at most once for each time that createDestinationOutputStream() is called.
        +
        +
        Overrides:
        +
        succeeded in class B2ContentWriter
        +
        +
      • +
      + + + +
        +
      • +

        failed

        +
        protected void failed()
        +
        Description copied from class: B2ContentWriter
        +
        Called after we've created an output stream, but then the download failed for some reason. + That reason may include errors with the download, or, to the extent we can verify it, an + error with the SHA1 of the written content. + + Called at most once for each time that createDestinationOutputStream() is called. Called before + an attempt to retry the download (if any).
        +
        +
        Overrides:
        +
        failed in class B2ContentWriter
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentHandlers/B2ContentSink.html b/com/backblaze/b2/client/contentHandlers/B2ContentSink.html new file mode 100644 index 000000000..d5a665a70 --- /dev/null +++ b/com/backblaze/b2/client/contentHandlers/B2ContentSink.html @@ -0,0 +1,278 @@ + + + + + +B2ContentSink (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2ContentSink

+
+
+
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        readContent

        +
        void readContent​(B2Headers responseHeaders,
        +                 java.io.InputStream in)
        +          throws B2Exception,
        +                 java.io.IOException
        +
        Reads the data from the input stream. + + Does NOT need to close the stream. The caller of readContent() + will take care of that. + + If you don't read to the end of the inputStream, the connection + probably won't be re-usable, so read to the end unless you have + a good reason not to.
        +
        +
        Parameters:
        +
        responseHeaders - the headers from the response
        +
        in - an input stream to read the content of the response
        +
        Throws:
        +
        B2Exception - if there's trouble
        +
        java.io.IOException - if there's an IOException
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentHandlers/B2ContentWriter.html b/com/backblaze/b2/client/contentHandlers/B2ContentWriter.html new file mode 100644 index 000000000..0dfce7333 --- /dev/null +++ b/com/backblaze/b2/client/contentHandlers/B2ContentWriter.html @@ -0,0 +1,431 @@ + + + + + +B2ContentWriter (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ContentWriter

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2ContentSink
    +
    +
    +
    Direct Known Subclasses:
    +
    B2ContentFileWriter, B2ContentMemoryWriter, B2ContentOutputStreamWriter
    +
    +
    +
    public abstract class B2ContentWriter
    +extends java.lang.Object
    +implements B2ContentSink
    +
    B2ContentWriter is a base class for ContentHandlers which writes the content + to a stream. Different subclasses support different types of output + streams. + + If possible, this class will verify the SHA1 of the downloaded content. + It is possible when: + * the content is NOT a partial (ie "range") request. + * the response include either a "X-Bz-Content-Sha1" or + "X-Bz-Info-large_file_sha1" header. (Note that if the + sha1 header's value starts with "unverified:", the remainder + of the value will be used.) + + If possible (see above), this class will always verify the SHA1 of the + content as it's downloaded. + + If possible (see above) and requested, this class will also re-read the + content from its destination to verify that it has been stored to the destination + with no errors. + + THREAD-SAFETY: this object is NOT thread-safe on its own. users should + only use it from one thread at a time and do proper locking + to ensure changes are visible to other threads as needed.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethodDescription
      protected abstract java.io.InputStreamcreateDestinationInputStream() 
      protected abstract java.io.OutputStreamcreateDestinationOutputStream() 
      protected voidfailed() +
      Called after we've created an output stream, but then the download failed for some reason.
      +
      B2HeadersgetHeadersOrNull() 
      voidreadContent​(B2Headers responseHeaders, + java.io.InputStream rawIn) +
      Reads the data from the input stream.
      +
      protected voidsucceeded() +
      Called when the download succeeded and, to the extent we're able to verify it, the SHA1 matched.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        readContent

        +
        public void readContent​(B2Headers responseHeaders,
        +                        java.io.InputStream rawIn)
        +                 throws B2Exception
        +
        Description copied from interface: B2ContentSink
        +
        Reads the data from the input stream. + + Does NOT need to close the stream. The caller of readContent() + will take care of that. + + If you don't read to the end of the inputStream, the connection + probably won't be re-usable, so read to the end unless you have + a good reason not to.
        +
        +
        Specified by:
        +
        readContent in interface B2ContentSink
        +
        Parameters:
        +
        responseHeaders - the headers from the response
        +
        rawIn - an input stream to read the content of the response
        +
        Throws:
        +
        B2Exception - if there's trouble
        +
        +
      • +
      + + + +
        +
      • +

        createDestinationOutputStream

        +
        protected abstract java.io.OutputStream createDestinationOutputStream()
        +                                                               throws java.io.IOException
        +
        +
        Returns:
        +
        an outputStream to write to the destination. calling this is allowed to + destroy the existing output (if any) and make it impossible for + a stream created by createDestinationInputStream() to be able to + read the data, if any.
        +
        Throws:
        +
        java.io.IOException - if there's any trouble
        +
        NOTE
        +
        this may be called multiple times.
        +
        +
      • +
      + + + +
        +
      • +

        createDestinationInputStream

        +
        protected abstract java.io.InputStream createDestinationInputStream()
        +                                                             throws java.io.IOException
        +
        +
        Returns:
        +
        a new inputStream to read from the destination. + this might not contain what you think it should if readContents + hasn't completed successfully.
        +
        Throws:
        +
        java.io.IOException - if there's any trouble
        +
        NOTE
        +
        this may be called multiple times.
        +
        +
      • +
      + + + +
        +
      • +

        succeeded

        +
        protected void succeeded()
        +
        Called when the download succeeded and, to the extent we're able to verify it, the SHA1 matched. + + Called at most once for each time that createDestinationOutputStream() is called.
        +
      • +
      + + + +
        +
      • +

        failed

        +
        protected void failed()
        +
        Called after we've created an output stream, but then the download failed for some reason. + That reason may include errors with the download, or, to the extent we can verify it, an + error with the SHA1 of the written content. + + Called at most once for each time that createDestinationOutputStream() is called. Called before + an attempt to retry the download (if any).
        +
      • +
      + + + +
        +
      • +

        getHeadersOrNull

        +
        public B2Headers getHeadersOrNull()
        +
        +
        Returns:
        +
        the headers from the server, if any. + returns null until readContent is called. + may return non-null even if there's an exception + during readContent().
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentHandlers/package-summary.html b/com/backblaze/b2/client/contentHandlers/package-summary.html new file mode 100644 index 000000000..5ec17b876 --- /dev/null +++ b/com/backblaze/b2/client/contentHandlers/package-summary.html @@ -0,0 +1,224 @@ + + + + + +com.backblaze.b2.client.contentHandlers (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.backblaze.b2.client.contentHandlers

+
+
+ +
+
+ + + diff --git a/com/backblaze/b2/client/contentHandlers/package-tree.html b/com/backblaze/b2/client/contentHandlers/package-tree.html new file mode 100644 index 000000000..e06f63a54 --- /dev/null +++ b/com/backblaze/b2/client/contentHandlers/package-tree.html @@ -0,0 +1,177 @@ + + + + + +com.backblaze.b2.client.contentHandlers Class Hierarchy (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.backblaze.b2.client.contentHandlers

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+ + + diff --git a/com/backblaze/b2/client/contentSources/B2ByteArrayContentSource.Builder.html b/com/backblaze/b2/client/contentSources/B2ByteArrayContentSource.Builder.html new file mode 100644 index 000000000..7f26fc21e --- /dev/null +++ b/com/backblaze/b2/client/contentSources/B2ByteArrayContentSource.Builder.html @@ -0,0 +1,342 @@ + + + + + +B2ByteArrayContentSource.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ByteArrayContentSource.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2ByteArrayContentSource
    +
    +
    +
    public static class B2ByteArrayContentSource.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentSources/B2ByteArrayContentSource.html b/com/backblaze/b2/client/contentSources/B2ByteArrayContentSource.html new file mode 100644 index 000000000..c8c6762fb --- /dev/null +++ b/com/backblaze/b2/client/contentSources/B2ByteArrayContentSource.html @@ -0,0 +1,433 @@ + + + + + +B2ByteArrayContentSource (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ByteArrayContentSource

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2ContentSource
    +
    +
    +
    public class B2ByteArrayContentSource
    +extends java.lang.Object
    +implements B2ContentSource
    +
    Use B2ByteArrayContentSource to wrap data in memory for uploading to B2. + Don't change the data while it's being uploaded. + + If you know the sha1, you're encouraged to provide it. See B2ContentSource.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        getSha1OrNull

        +
        public java.lang.String getSha1OrNull()
        +                               throws java.io.IOException
        +
        Description copied from interface: B2ContentSource
        +
        You are encouraged to implement this. If it returns non-null, + the B2Client can provide the sha1 before performing the upload. + + Definitely implement this if you've stored the sha1 separately + from the file. That way you can ensure that B2 doesn't take the + file if there's trouble reading it from your source. If you + return null, B2StorageClient will compute the SHA1 from the bytes in the + stream. + + Note that large files do not have SHA-1s for the entire file. + If you provide a SHA-1 for a large file upload, the SDK follows + the recommendation of putting your value into the 'large_file_sha1' + fileInfo. See "SHA1 Checksums" in https://www.backblaze.com/b2/docs/large_files.html
        +
        +
        Specified by:
        +
        getSha1OrNull in interface B2ContentSource
        +
        Returns:
        +
        the hex-encoded sha1 for the content or null if it's not known yet.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        +
      • +
      + + + +
        +
      • +

        getSrcLastModifiedMillisOrNull

        +
        public java.lang.Long getSrcLastModifiedMillisOrNull()
        +                                              throws java.io.IOException
        +
        +
        Specified by:
        +
        getSrcLastModifiedMillisOrNull in interface B2ContentSource
        +
        Returns:
        +
        the time the source was last modified (in milliseconds since the epoch) + or null if there isn't a reasonable value for that.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        +
      • +
      + + + +
        +
      • +

        getContentLength

        +
        public long getContentLength()
        +                      throws java.io.IOException
        +
        +
        Specified by:
        +
        getContentLength in interface B2ContentSource
        +
        Returns:
        +
        the number of bytes in the content. the length must be non-negative.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        +
      • +
      + + + +
        +
      • +

        createInputStream

        +
        public java.io.InputStream createInputStream()
        +                                      throws java.io.IOException
        +
        Description copied from interface: B2ContentSource
        +
        NOTE: this may be called multiple times as uploads + are retried, etc. The content is expected to be identical + each time this is called.
        +
        +
        Specified by:
        +
        createInputStream in interface B2ContentSource
        +
        Returns:
        +
        a new inputStream containing the contents.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentSources/B2ContentSource.html b/com/backblaze/b2/client/contentSources/B2ContentSource.html new file mode 100644 index 000000000..446262408 --- /dev/null +++ b/com/backblaze/b2/client/contentSources/B2ContentSource.html @@ -0,0 +1,391 @@ + + + + + +B2ContentSource (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2ContentSource

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    B2ByteArrayContentSource, B2CancellableContentSource, B2FileContentSource
    +
    +
    +
    public interface B2ContentSource
    +
    Implementations of B2ContentSource provide the length, SHA1, and the + bytes that the B2Client should upload. + + There are common implementations of this class, such as B2FileContentSource + and MemoryContentSource.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getContentLength

        +
        long getContentLength()
        +               throws java.io.IOException
        +
        +
        Returns:
        +
        the number of bytes in the content. the length must be non-negative.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        +
      • +
      + + + +
        +
      • +

        getSha1OrNull

        +
        java.lang.String getSha1OrNull()
        +                        throws java.io.IOException
        +
        You are encouraged to implement this. If it returns non-null, + the B2Client can provide the sha1 before performing the upload. + + Definitely implement this if you've stored the sha1 separately + from the file. That way you can ensure that B2 doesn't take the + file if there's trouble reading it from your source. If you + return null, B2StorageClient will compute the SHA1 from the bytes in the + stream. + + Note that large files do not have SHA-1s for the entire file. + If you provide a SHA-1 for a large file upload, the SDK follows + the recommendation of putting your value into the 'large_file_sha1' + fileInfo. See "SHA1 Checksums" in https://www.backblaze.com/b2/docs/large_files.html
        +
        +
        Returns:
        +
        the hex-encoded sha1 for the content or null if it's not known yet.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        +
      • +
      + + + +
        +
      • +

        getSrcLastModifiedMillisOrNull

        +
        java.lang.Long getSrcLastModifiedMillisOrNull()
        +                                       throws java.io.IOException
        +
        +
        Returns:
        +
        the time the source was last modified (in milliseconds since the epoch) + or null if there isn't a reasonable value for that.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        +
      • +
      + + + +
        +
      • +

        createInputStream

        +
        java.io.InputStream createInputStream()
        +                               throws java.io.IOException,
        +                                      B2Exception
        +
        NOTE: this may be called multiple times as uploads + are retried, etc. The content is expected to be identical + each time this is called.
        +
        +
        Returns:
        +
        a new inputStream containing the contents.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        B2Exception - if there's trouble
        +
        +
      • +
      + + + +
        +
      • +

        createContentSourceWithRangeOrNull

        +
        default B2ContentSource createContentSourceWithRangeOrNull​(long start,
        +                                                           long length)
        +                                                    throws java.io.IOException
        +
        If possible, this returns a NEW input stream for just the specified range of the + content. If it's not possible (or just not implemented), this returns null. + + The large file uploading mechanism uses this call to get a stream for each + part that will be uploaded separately. If this returns null, the large file + uploader will use createInputStream() and read and discard the initial + part of the stream to get to the part it needs. + + This method is optional. However, if your content source will be used + for large file uploads, please implement it to make your uploads more + efficient. + + NOTE: this may be called multiple times as uploads are retried, etc. + The overall content is expected to be identical each time this is called.
        +
        +
        Returns:
        +
        a new inputStream containing the specified range of the overall contents.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentSources/B2ContentTypes.html b/com/backblaze/b2/client/contentSources/B2ContentTypes.html new file mode 100644 index 000000000..8b577e166 --- /dev/null +++ b/com/backblaze/b2/client/contentSources/B2ContentTypes.html @@ -0,0 +1,284 @@ + + + + + +B2ContentTypes (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2ContentTypes

+
+
+
+
    +
  • +
    +
    public interface B2ContentTypes
    +
    B2ContentTypes provides constants for well-known mime types, especially + ones that have meaning to B2.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringAPPLICATION_OCTET 
      static java.lang.StringB2_AUTO 
      static java.lang.StringTEXT_PLAIN 
      +
    • +
    +
    +
  • +
+
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentSources/B2FileContentSource.Builder.html b/com/backblaze/b2/client/contentSources/B2FileContentSource.Builder.html new file mode 100644 index 000000000..9c22c1036 --- /dev/null +++ b/com/backblaze/b2/client/contentSources/B2FileContentSource.Builder.html @@ -0,0 +1,288 @@ + + + + + +B2FileContentSource.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2FileContentSource.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2FileContentSource
    +
    +
    +
    public static class B2FileContentSource.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentSources/B2FileContentSource.html b/com/backblaze/b2/client/contentSources/B2FileContentSource.html new file mode 100644 index 000000000..a1d959276 --- /dev/null +++ b/com/backblaze/b2/client/contentSources/B2FileContentSource.html @@ -0,0 +1,429 @@ + + + + + +B2FileContentSource (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2FileContentSource

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        getSha1OrNull

        +
        public java.lang.String getSha1OrNull()
        +                               throws java.io.IOException
        +
        Description copied from interface: B2ContentSource
        +
        You are encouraged to implement this. If it returns non-null, + the B2Client can provide the sha1 before performing the upload. + + Definitely implement this if you've stored the sha1 separately + from the file. That way you can ensure that B2 doesn't take the + file if there's trouble reading it from your source. If you + return null, B2StorageClient will compute the SHA1 from the bytes in the + stream. + + Note that large files do not have SHA-1s for the entire file. + If you provide a SHA-1 for a large file upload, the SDK follows + the recommendation of putting your value into the 'large_file_sha1' + fileInfo. See "SHA1 Checksums" in https://www.backblaze.com/b2/docs/large_files.html
        +
        +
        Specified by:
        +
        getSha1OrNull in interface B2ContentSource
        +
        Returns:
        +
        the hex-encoded sha1 for the content or null if it's not known yet.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        +
      • +
      + + + +
        +
      • +

        getSrcLastModifiedMillisOrNull

        +
        public java.lang.Long getSrcLastModifiedMillisOrNull()
        +                                              throws java.io.IOException
        +
        +
        Specified by:
        +
        getSrcLastModifiedMillisOrNull in interface B2ContentSource
        +
        Returns:
        +
        the time the source was last modified (in milliseconds since the epoch) + or null if there isn't a reasonable value for that.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        +
      • +
      + + + +
        +
      • +

        getContentLength

        +
        public long getContentLength()
        +                      throws java.io.IOException
        +
        +
        Specified by:
        +
        getContentLength in interface B2ContentSource
        +
        Returns:
        +
        the number of bytes in the content. the length must be non-negative.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        +
      • +
      + + + +
        +
      • +

        createInputStream

        +
        public java.io.InputStream createInputStream()
        +                                      throws java.io.IOException
        +
        Description copied from interface: B2ContentSource
        +
        NOTE: this may be called multiple times as uploads + are retried, etc. The content is expected to be identical + each time this is called.
        +
        +
        Specified by:
        +
        createInputStream in interface B2ContentSource
        +
        Returns:
        +
        a new inputStream containing the contents.
        +
        Throws:
        +
        java.io.IOException - if there's trouble
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentSources/B2Headers.html b/com/backblaze/b2/client/contentSources/B2Headers.html new file mode 100644 index 000000000..6bbe9af91 --- /dev/null +++ b/com/backblaze/b2/client/contentSources/B2Headers.html @@ -0,0 +1,1308 @@ + + + + + +B2Headers (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2Headers

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    B2HeadersImpl
    +
    +
    +
    public interface B2Headers
    +
    B2Headers represents the HTTP headers that come with a response from the server. + + It stores the values as they are *set* on it, without modifying or encoding them. + Callers are expected to store values as they should be encoded in HTTP requests. + + Note that getValueOrNull() returns the stored value without percentDecoding. + Note that some convenience methods do percentDecode the value. See the per-method + documentation.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getNames

        +
        java.util.Collection<java.lang.String> getNames()
        +
        +
        Returns:
        +
        a collection with the names of all the headers in this object. never null.
        +
        +
      • +
      + + + +
        +
      • +

        getValueOrNull

        +
        java.lang.String getValueOrNull​(java.lang.String name)
        +
        +
        Returns:
        +
        the value for the given header name, or null if none.
        +
        +
      • +
      + + + +
        +
      • +

        getContentType

        +
        default java.lang.String getContentType()
        +
        +
        Returns:
        +
        the value of the Content-Type header or B2ContentTypes.APPLICATION_OCTET if there isn't one.
        +
        NOTE
        +
        this returns APPLICATION_OCTET because that's how you should treat content with an undeclared type + (unless you're willing to look at other headers or the URI, etc. if you're willing to do that + you can use getValueOrNull() instead of this convenience method.)
        +
        +
      • +
      + + + +
        +
      • +

        getContentLength

        +
        default long getContentLength()
        +
        +
        Returns:
        +
        the value of the Content-Length header as a long.
        +
        Throws:
        +
        java.lang.IllegalStateException - if there isn't a Content-Length header or it can't be parsed as a long.
        +
        NOTE
        +
        We throw for unparseable values because this is a standard HTTP header and really, really should be valid.
        +
        +
      • +
      + + + +
        +
      • +

        getFileNameOrNull

        +
        default java.lang.String getFileNameOrNull()
        +
        +
        Returns:
        +
        the value of the X-Bz-File-Name header (percentDecoded) + or null if that header isn't present or can't be percentDecoded.
        +
        NOTE
        +
        We return null here because this is a completely optional, non-standard header + and anyone could put any type of value in it at any time.
        +
        +
      • +
      + + + +
        +
      • +

        getUploadTimestampOrNull

        +
        default java.lang.Long getUploadTimestampOrNull()
        +
        +
        Returns:
        +
        the value of the X-Bz-Upload-Timestamp header (parsed as a long) + or null if that header isn't present or can't be parsed.
        +
        NOTE
        +
        We return null here because this is a completely optional, non-standard header + and anyone could put any type of value in it at any time.
        +
        +
      • +
      + + + +
        +
      • +

        hasContentRange

        +
        default boolean hasContentRange()
        +
        +
        Returns:
        +
        true iff there's a value for the Content-Range header
        +
        +
      • +
      + + + +
        +
      • +

        getContentSha1OrNull

        +
        default java.lang.String getContentSha1OrNull()
        +
        +
        Returns:
        +
        the value of the X-Bz-Content-Sha1 header, or null if none.
        +
        NOTE
        +
        We return null here instead of throwing an exception since this is a + completely optional, non-standard header.
        +
        +
      • +
      + + + +
        +
      • +

        getContentMd5OrNull

        +
        default java.lang.String getContentMd5OrNull()
        +
        +
        Returns:
        +
        the value of the Content-MD5 header, or null if none.
        +
        NOTE
        +
        We return null here instead of throwing an exception since this is a + an optional header in B2. Older files will not have it.
        +
        +
      • +
      + + + +
        +
      • +

        getContentSha1EvenIfUnverifiedOrNull

        +
        default java.lang.String getContentSha1EvenIfUnverifiedOrNull()
        +
        +
        Returns:
        +
        the value of the X-Bz-Content-Sha1 header with 'unverified:' removed from + the front, if any, or null if there's no X-Bz-Content-Sha1 header.
        +
        NOTE
        +
        We return null here instead of throwing an exception since this is a + completely optional, non-standard header.
        +
        +
      • +
      + + + +
        +
      • +

        getLargeFileSha1OrNull

        +
        default java.lang.String getLargeFileSha1OrNull()
        +
        +
        Returns:
        +
        the value of the X-Bz-Content-Sha1 header, or null if none.
        +
        NOTE
        +
        We return null here instead of throwing an exception since this is a + completely optional, non-standard header.
        +
        +
      • +
      + + + +
        +
      • +

        getB2FileInfo

        +
        default java.util.Map<java.lang.String,​java.lang.String> getB2FileInfo()
        +
        +
        Returns:
        +
        a new map with the names and values provided as fileInfo when the file was uploaded.
        +
        NOTE
        +
        the map may be empty, but it will never be null.
        +
        +
      • +
      + + + +
        +
      • +

        getSrcLastModifiedMillis

        +
        default java.lang.Long getSrcLastModifiedMillis()
        +
        +
        Returns:
        +
        the value of the 'src_last_modified_millis' fileInfo or null if none + or if it can't be parsed as a long.
        +
        NOTE
        +
        We return null here because this is a completely optional, non-standard header + and anyone could put any type of value in it at any time.
        +
        +
      • +
      + + + +
        +
      • +

        getClientUnauthorizedToReadHeaderList

        +
        default java.util.List<java.lang.String> getClientUnauthorizedToReadHeaderList()
        +
        +
        Returns:
        +
        the list of headers, if any, included in the `X-Bz-Client-Unauthorized-To-Read` header. + If no such header is present, then returns null.
        +
        NOTE
        +
        We return null here instead of throwing an exception since this is a + completely optional, non-standard header.
        +
        +
      • +
      + + + +
        +
      • +

        isClientUnauthorizedToReadFileRetention

        +
        default boolean isClientUnauthorizedToReadFileRetention()
        +
        +
        Returns:
        +
        true if the client does not have app key capabilities to read file retention, + according to the 'X-Bz-Client-Unauthorized-To-Read' header
        +
        +
      • +
      + + + +
        +
      • +

        getFileRetentionModeOrNull

        +
        default java.lang.String getFileRetentionModeOrNull()
        +
        +
        Returns:
        +
        the value of the `X-Bz-File-Retention-Mode` header, or null if none.
        +
        NOTE
        +
        We return null here instead of throwing an exception since this is a + completely optional, non-standard header.
        +
        +
      • +
      + + + +
        +
      • +

        getFileRetentionRetainUntilTimestampOrNull

        +
        default java.lang.Long getFileRetentionRetainUntilTimestampOrNull()
        +
        +
        Returns:
        +
        the value of the `X-Bz-File-Retain-Until-Timestamp` header, or null if none.
        +
        NOTE
        +
        We return null here because this is a completely optional, non-standard header + and anyone could put any type of value in it at any time.
        +
        +
      • +
      + + + +
        +
      • +

        isClientUnauthorizedToReadLegalHold

        +
        default boolean isClientUnauthorizedToReadLegalHold()
        +
        +
        Returns:
        +
        true if the client does not have app key capabilities to read legal hold, + according to the 'X-Bz-Client-Unauthorized-To-Read' header
        +
        +
      • +
      + + + +
        +
      • +

        getFileLegalHoldOrNull

        +
        default java.lang.String getFileLegalHoldOrNull()
        +
        +
        Returns:
        +
        the value of the `X-Bz-File-Legal-Hold` header, or null if none.
        +
        NOTE
        +
        We return null here instead of throwing an exception since this is a + completely optional, non-standard header.
        +
        +
      • +
      + + + +
        +
      • +

        getServerSideEncryptionOrNull

        +
        default java.lang.String getServerSideEncryptionOrNull()
        +
        +
        Returns:
        +
        the value of the `X-Bz-Server-Side-Encryption` header, or null if none.
        +
        NOTE
        +
        We return null here instead of throwing an exception since this is a + completely optional, non-standard header.
        +
        +
      • +
      + + + +
        +
      • +

        getSseCustomerAlgorithmOrNull

        +
        default java.lang.String getSseCustomerAlgorithmOrNull()
        +
        +
        Returns:
        +
        the value of the `X-Bz-Server-Side-Encryption-Customer-Algorithm` header, or null if none.
        +
        NOTE
        +
        We return null here instead of throwing an exception since this is a + completely optional, non-standard header.
        +
        +
      • +
      + + + +
        +
      • +

        getSseCustomerKeyMd5OrNull

        +
        default java.lang.String getSseCustomerKeyMd5OrNull()
        +
        +
        Returns:
        +
        the value of the `X-Bz-Server-Side-Encryption-Customer-Key-Md5` header, or null if none.
        +
        NOTE
        +
        We return null here instead of throwing an exception since this is a + completely optional, non-standard header.
        +
        +
      • +
      + + + +
        +
      • +

        getReplicationStatusOrNull

        +
        default java.lang.String getReplicationStatusOrNull()
        +
        +
        Returns:
        +
        the value of the 'X-Bz-Replication-Status' header, or null if none.
        +
        NOTE
        +
        We return null here instead of throwing an exception since this is a + completely optional, non-standard header.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentSources/B2HeadersImpl.Builder.html b/com/backblaze/b2/client/contentSources/B2HeadersImpl.Builder.html new file mode 100644 index 000000000..f05ba3b8b --- /dev/null +++ b/com/backblaze/b2/client/contentSources/B2HeadersImpl.Builder.html @@ -0,0 +1,324 @@ + + + + + +B2HeadersImpl.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2HeadersImpl.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2HeadersImpl
    +
    +
    +
    public static class B2HeadersImpl.Builder
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      Builder() 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder()
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentSources/B2HeadersImpl.html b/com/backblaze/b2/client/contentSources/B2HeadersImpl.html new file mode 100644 index 000000000..5a976a8b7 --- /dev/null +++ b/com/backblaze/b2/client/contentSources/B2HeadersImpl.html @@ -0,0 +1,400 @@ + + + + + +B2HeadersImpl (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2HeadersImpl

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2Headers
    +
    +
    +
    public class B2HeadersImpl
    +extends java.lang.Object
    +implements B2Headers
    +
    B2HeadersImpl implements the B2Headers interface.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getNames

        +
        public java.util.Collection<java.lang.String> getNames()
        +
        +
        Specified by:
        +
        getNames in interface B2Headers
        +
        Returns:
        +
        a collection with the names of all the headers in this object. never null.
        +
        +
      • +
      + + + +
        +
      • +

        getValueOrNull

        +
        public java.lang.String getValueOrNull​(java.lang.String name)
        +
        +
        Specified by:
        +
        getValueOrNull in interface B2Headers
        +
        Returns:
        +
        the value for the given header name, or null if none.
        +
        +
      • +
      + + + +
        +
      • +

        builder

        +
        public static B2HeadersImpl.Builder builder()
        +
        +
        Returns:
        +
        a new builder with no headers set yet.
        +
        +
      • +
      + + + +
        +
      • +

        builder

        +
        public static B2HeadersImpl.Builder builder​(B2Headers headersOrNull)
        +
        +
        Parameters:
        +
        headersOrNull - if non-null, the headers to prepopulate in the builder.
        +
        Returns:
        +
        a new builder. if headersOrNull != null, the values from those + headers will have already been set on the returned builder.
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/contentSources/package-summary.html b/com/backblaze/b2/client/contentSources/package-summary.html new file mode 100644 index 000000000..9b3d511a9 --- /dev/null +++ b/com/backblaze/b2/client/contentSources/package-summary.html @@ -0,0 +1,219 @@ + + + + + +com.backblaze.b2.client.contentSources (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.backblaze.b2.client.contentSources

+
+
+ +
+
+ + + diff --git a/com/backblaze/b2/client/contentSources/package-tree.html b/com/backblaze/b2/client/contentSources/package-tree.html new file mode 100644 index 000000000..ba6fa0c29 --- /dev/null +++ b/com/backblaze/b2/client/contentSources/package-tree.html @@ -0,0 +1,174 @@ + + + + + +com.backblaze.b2.client.contentSources Class Hierarchy (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.backblaze.b2.client.contentSources

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+ + + diff --git a/com/backblaze/b2/client/credentialsSources/B2Credentials.html b/com/backblaze/b2/client/credentialsSources/B2Credentials.html new file mode 100644 index 000000000..d3224d56a --- /dev/null +++ b/com/backblaze/b2/client/credentialsSources/B2Credentials.html @@ -0,0 +1,278 @@ + + + + + +B2Credentials (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2Credentials

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    B2CredentialsImpl
    +
    +
    +
    public interface B2Credentials
    +
    Credentials for accessing B2's APIs. + + If you used getAccountId() in a previous version of the SDK, please + use B2StorageClient.getAccountId() in this version.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getApplicationKeyId

        +
        java.lang.String getApplicationKeyId()
        +
        +
        Returns:
        +
        the applicationKeyId to use for b2_authorize_account.
        +
        +
      • +
      + + + +
        +
      • +

        getApplicationKey

        +
        java.lang.String getApplicationKey()
        +
        +
        Returns:
        +
        the applicationKey to use for b2_authorize_account.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/credentialsSources/B2CredentialsFromEnvironmentSource.html b/com/backblaze/b2/client/credentialsSources/B2CredentialsFromEnvironmentSource.html new file mode 100644 index 000000000..5da20ccb3 --- /dev/null +++ b/com/backblaze/b2/client/credentialsSources/B2CredentialsFromEnvironmentSource.html @@ -0,0 +1,314 @@ + + + + + +B2CredentialsFromEnvironmentSource (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CredentialsFromEnvironmentSource

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2CredentialsSource
    +
    +
    +
    public class B2CredentialsFromEnvironmentSource
    +extends java.lang.Object
    +implements B2CredentialsSource
    +
    This B2CredentialsSource reads the credentials from two environment variables: + B2_APPLICATION_KEY_ID + B2_APPLICATION_KEY + + If either is missing or empty, getCredentials() will throw.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCredentials

        +
        public B2Credentials getCredentials()
        +
        +
        Specified by:
        +
        getCredentials in interface B2CredentialsSource
        +
        Returns:
        +
        the credentials specified in the environment.
        +
        Throws:
        +
        java.lang.IllegalStateException - if any of the required environment variables are missing.
        +
        +
      • +
      + + + + + + + +
        +
      • +

        canGetCredentials

        +
        public boolean canGetCredentials()
        +
        +
        Returns:
        +
        true iff we can create credentials from the environment.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/credentialsSources/B2CredentialsImpl.html b/com/backblaze/b2/client/credentialsSources/B2CredentialsImpl.html new file mode 100644 index 000000000..a5a6eede7 --- /dev/null +++ b/com/backblaze/b2/client/credentialsSources/B2CredentialsImpl.html @@ -0,0 +1,296 @@ + + + + + +B2CredentialsImpl (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CredentialsImpl

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2Credentials
    +
    +
    +
    public class B2CredentialsImpl
    +extends java.lang.Object
    +implements B2Credentials
    +
    Simple implementation of B2Credentials.
    +
  • +
+
+
+
    +
  • + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getApplicationKeyId

        +
        public java.lang.String getApplicationKeyId()
        +
        +
        Specified by:
        +
        getApplicationKeyId in interface B2Credentials
        +
        Returns:
        +
        the applicationKeyId to use for b2_authorize_account.
        +
        +
      • +
      + + + +
        +
      • +

        getApplicationKey

        +
        public java.lang.String getApplicationKey()
        +
        +
        Specified by:
        +
        getApplicationKey in interface B2Credentials
        +
        Returns:
        +
        the applicationKey to use for b2_authorize_account.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/credentialsSources/B2CredentialsSource.html b/com/backblaze/b2/client/credentialsSources/B2CredentialsSource.html new file mode 100644 index 000000000..2fd11826c --- /dev/null +++ b/com/backblaze/b2/client/credentialsSources/B2CredentialsSource.html @@ -0,0 +1,259 @@ + + + + + +B2CredentialsSource (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2CredentialsSource

+
+
+
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCredentials

        +
        B2Credentials getCredentials()
        +
        +
        Returns:
        +
        credentials to use for the api.
        +
        Throws:
        +
        java.lang.RuntimeException - if there's any trouble finding the credentials.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/credentialsSources/package-summary.html b/com/backblaze/b2/client/credentialsSources/package-summary.html new file mode 100644 index 000000000..83e44b1ab --- /dev/null +++ b/com/backblaze/b2/client/credentialsSources/package-summary.html @@ -0,0 +1,199 @@ + + + + + +com.backblaze.b2.client.credentialsSources (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.backblaze.b2.client.credentialsSources

+
+
+ +
+
+ + + diff --git a/com/backblaze/b2/client/credentialsSources/package-tree.html b/com/backblaze/b2/client/credentialsSources/package-tree.html new file mode 100644 index 000000000..3f4e7d17e --- /dev/null +++ b/com/backblaze/b2/client/credentialsSources/package-tree.html @@ -0,0 +1,169 @@ + + + + + +com.backblaze.b2.client.credentialsSources Class Hierarchy (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.backblaze.b2.client.credentialsSources

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+ + + diff --git a/com/backblaze/b2/client/exceptions/B2BadRequestException.html b/com/backblaze/b2/client/exceptions/B2BadRequestException.html new file mode 100644 index 000000000..e872f8cf7 --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2BadRequestException.html @@ -0,0 +1,390 @@ + + + + + +B2BadRequestException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2BadRequestException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2BadRequestException
    +extends B2Exception
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringDEFAULT_CODE 
      static intSTATUS 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2BadRequestException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message) 
      B2BadRequestException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message, + java.lang.Throwable cause) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2BadRequestException

        +
        public B2BadRequestException​(java.lang.String code,
        +                             java.lang.Integer retryAfterSecondsOrNull,
        +                             java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2BadRequestException

        +
        public B2BadRequestException​(java.lang.String code,
        +                             java.lang.Integer retryAfterSecondsOrNull,
        +                             java.lang.String message,
        +                             java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2CannotComputeException.html b/com/backblaze/b2/client/exceptions/B2CannotComputeException.html new file mode 100644 index 000000000..7cdc0911e --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2CannotComputeException.html @@ -0,0 +1,332 @@ + + + + + +B2CannotComputeException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CannotComputeException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2CannotComputeException
    +extends B2LocalException
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2CannotComputeException​(java.lang.String message) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2CannotComputeException

        +
        public B2CannotComputeException​(java.lang.String message)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2ConnectFailedException.html b/com/backblaze/b2/client/exceptions/B2ConnectFailedException.html new file mode 100644 index 000000000..7e4adf19b --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2ConnectFailedException.html @@ -0,0 +1,354 @@ + + + + + +B2ConnectFailedException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ConnectFailedException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2ConnectFailedException
    +extends B2NetworkBaseException
    +
    B2ConnectFailedException represents a failure to connect to the + B2 servers. If this persists, there's probably an issue with + your network. + + Note that this exception is generated locally by the SDK and + has a non-standard STATUS code.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2ConnectFailedException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message) 
      B2ConnectFailedException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message, + java.lang.Throwable cause) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ConnectFailedException

        +
        public B2ConnectFailedException​(java.lang.String code,
        +                                java.lang.Integer retryAfterSecondsOrNull,
        +                                java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2ConnectFailedException

        +
        public B2ConnectFailedException​(java.lang.String code,
        +                                java.lang.Integer retryAfterSecondsOrNull,
        +                                java.lang.String message,
        +                                java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2ConnectionBrokenException.html b/com/backblaze/b2/client/exceptions/B2ConnectionBrokenException.html new file mode 100644 index 000000000..062c3667e --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2ConnectionBrokenException.html @@ -0,0 +1,353 @@ + + + + + +B2ConnectionBrokenException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ConnectionBrokenException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2ConnectionBrokenException
    +extends B2NetworkBaseException
    +
    B2ConnectionBrokenException represents the network connection to + the B2 servers having been closed unexpectedly. + + Note that this exception is generated locally by the SDK and + has a non-standard STATUS code.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2ConnectionBrokenException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message) 
      B2ConnectionBrokenException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message, + java.lang.Throwable cause) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ConnectionBrokenException

        +
        public B2ConnectionBrokenException​(java.lang.String code,
        +                                   java.lang.Integer retryAfterSecondsOrNull,
        +                                   java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2ConnectionBrokenException

        +
        public B2ConnectionBrokenException​(java.lang.String code,
        +                                   java.lang.Integer retryAfterSecondsOrNull,
        +                                   java.lang.String message,
        +                                   java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2Exception.html b/com/backblaze/b2/client/exceptions/B2Exception.html new file mode 100644 index 000000000..1f270526b --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2Exception.html @@ -0,0 +1,488 @@ + + + + + +B2Exception (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2Exception

+
+
+ +
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringDEFAULT_CODE 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2Exception​(java.lang.String code, + int status, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message) 
      B2Exception​(java.lang.String code, + int status, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message, + java.lang.Throwable cause) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static B2Exceptioncreate​(java.lang.String code, + int status, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message) +
      Returns a new B2Exception, trying to provide the appropriate subclass to + characterize the it.
      +
      java.lang.StringgetCode() 
      java.lang.IntegergetRetryAfterSecondsOrNull() 
      intgetStatus() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2Exception

        +
        public B2Exception​(java.lang.String code,
        +                   int status,
        +                   java.lang.Integer retryAfterSecondsOrNull,
        +                   java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2Exception

        +
        public B2Exception​(java.lang.String code,
        +                   int status,
        +                   java.lang.Integer retryAfterSecondsOrNull,
        +                   java.lang.String message,
        +                   java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Throwable
        +
        +
      • +
      + + + +
        +
      • +

        getCode

        +
        public java.lang.String getCode()
        +
      • +
      + + + +
        +
      • +

        getStatus

        +
        public int getStatus()
        +
      • +
      + + + +
        +
      • +

        getRetryAfterSecondsOrNull

        +
        public java.lang.Integer getRetryAfterSecondsOrNull()
        +
      • +
      + + + +
        +
      • +

        create

        +
        public static B2Exception create​(java.lang.String code,
        +                                 int status,
        +                                 java.lang.Integer retryAfterSecondsOrNull,
        +                                 java.lang.String message)
        +
        Returns a new B2Exception, trying to provide the appropriate subclass to + characterize the it.
        +
        +
        Parameters:
        +
        code - the code from the error response
        +
        status - the http status from the response.
        +
        retryAfterSecondsOrNull - the value of 'Retry-After' header if it's an integer number of seconds.
        +
        message - the message in the error response.
        +
        Returns:
        +
        a new B2Exception (maybe an instance of one of its subclasses)
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2ForbiddenException.html b/com/backblaze/b2/client/exceptions/B2ForbiddenException.html new file mode 100644 index 000000000..c7b076ad4 --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2ForbiddenException.html @@ -0,0 +1,392 @@ + + + + + +B2ForbiddenException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ForbiddenException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2ForbiddenException
    +extends B2Exception
    +
    B2ForbiddenException is thrown when an HTTP response has a 403 status code or when a field for which client + does not have necessary read authorization is accessed (e.g., defaultServerSideEncryption in B2Bucket).
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringDEFAULT_CODE 
      static intSTATUS 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2ForbiddenException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message) 
      B2ForbiddenException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message, + java.lang.Throwable cause) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ForbiddenException

        +
        public B2ForbiddenException​(java.lang.String code,
        +                            java.lang.Integer retryAfterSecondsOrNull,
        +                            java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2ForbiddenException

        +
        public B2ForbiddenException​(java.lang.String code,
        +                            java.lang.Integer retryAfterSecondsOrNull,
        +                            java.lang.String message,
        +                            java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2InternalErrorException.html b/com/backblaze/b2/client/exceptions/B2InternalErrorException.html new file mode 100644 index 000000000..3ff4c7b1d --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2InternalErrorException.html @@ -0,0 +1,418 @@ + + + + + +B2InternalErrorException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2InternalErrorException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2InternalErrorException
    +extends B2Exception
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringDEFAULT_CODE 
      static intSTATUS 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2InternalErrorException​(java.lang.String message) 
      B2InternalErrorException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message) 
      B2InternalErrorException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message, + java.lang.Throwable cause) 
      B2InternalErrorException​(java.lang.String code, + java.lang.String message) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2InternalErrorException

        +
        public B2InternalErrorException​(java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2InternalErrorException

        +
        public B2InternalErrorException​(java.lang.String code,
        +                                java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2InternalErrorException

        +
        public B2InternalErrorException​(java.lang.String code,
        +                                java.lang.Integer retryAfterSecondsOrNull,
        +                                java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2InternalErrorException

        +
        public B2InternalErrorException​(java.lang.String code,
        +                                java.lang.Integer retryAfterSecondsOrNull,
        +                                java.lang.String message,
        +                                java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2LocalException.html b/com/backblaze/b2/client/exceptions/B2LocalException.html new file mode 100644 index 000000000..1f9d0b979 --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2LocalException.html @@ -0,0 +1,383 @@ + + + + + +B2LocalException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2LocalException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    B2CannotComputeException
    +
    +
    +
    public class B2LocalException
    +extends B2Exception
    +
    Instances of B2LocalException represent issues that are detected by the SDK. + + Note that these exceptions are generated locally by the SDK and + have non-standard STATUS code.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static intSTATUS 
      + +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2LocalException​(java.lang.String code, + java.lang.String message) 
      B2LocalException​(java.lang.String code, + java.lang.String message, + java.lang.Throwable cause) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2LocalException

        +
        public B2LocalException​(java.lang.String code,
        +                        java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2LocalException

        +
        public B2LocalException​(java.lang.String code,
        +                        java.lang.String message,
        +                        java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2NetworkBaseException.html b/com/backblaze/b2/client/exceptions/B2NetworkBaseException.html new file mode 100644 index 000000000..d8932bb5e --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2NetworkBaseException.html @@ -0,0 +1,283 @@ + + + + + +B2NetworkBaseException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2NetworkBaseException

+
+
+ +
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2NetworkException.html b/com/backblaze/b2/client/exceptions/B2NetworkException.html new file mode 100644 index 000000000..f756984df --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2NetworkException.html @@ -0,0 +1,354 @@ + + + + + +B2NetworkException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2NetworkException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2NetworkException
    +extends B2NetworkBaseException
    +
    B2NetworkTimeoutException represents the network connection to + a B2 server being closed locally because the server + isn't answering in a timely fashion. + + Note that this exception is generated locally by the SDK and + has a non-standard STATUS code.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2NetworkException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message) 
      B2NetworkException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message, + java.lang.Throwable cause) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2NetworkException

        +
        public B2NetworkException​(java.lang.String code,
        +                          java.lang.Integer retryAfterSecondsOrNull,
        +                          java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2NetworkException

        +
        public B2NetworkException​(java.lang.String code,
        +                          java.lang.Integer retryAfterSecondsOrNull,
        +                          java.lang.String message,
        +                          java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2NetworkTimeoutException.html b/com/backblaze/b2/client/exceptions/B2NetworkTimeoutException.html new file mode 100644 index 000000000..209d433f1 --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2NetworkTimeoutException.html @@ -0,0 +1,354 @@ + + + + + +B2NetworkTimeoutException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2NetworkTimeoutException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2NetworkTimeoutException
    +extends B2NetworkBaseException
    +
    B2NetworkTimeoutException represents the network connection to + a B2 server being closed locally because the server + isn't answering in a timely fashion. + + Note that this exception is generated locally by the SDK and + has a non-standard STATUS code.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2NetworkTimeoutException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message) 
      B2NetworkTimeoutException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message, + java.lang.Throwable cause) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2NetworkTimeoutException

        +
        public B2NetworkTimeoutException​(java.lang.String code,
        +                                 java.lang.Integer retryAfterSecondsOrNull,
        +                                 java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2NetworkTimeoutException

        +
        public B2NetworkTimeoutException​(java.lang.String code,
        +                                 java.lang.Integer retryAfterSecondsOrNull,
        +                                 java.lang.String message,
        +                                 java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2NotFoundException.html b/com/backblaze/b2/client/exceptions/B2NotFoundException.html new file mode 100644 index 000000000..f2c2c965c --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2NotFoundException.html @@ -0,0 +1,405 @@ + + + + + +B2NotFoundException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2NotFoundException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2NotFoundException
    +extends B2Exception
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringDEFAULT_CODE 
      static intSTATUS 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2NotFoundException​(java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message) 
      B2NotFoundException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message) 
      B2NotFoundException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message, + java.lang.Throwable cause) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2NotFoundException

        +
        public B2NotFoundException​(java.lang.Integer retryAfterSecondsOrNull,
        +                           java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2NotFoundException

        +
        public B2NotFoundException​(java.lang.String code,
        +                           java.lang.Integer retryAfterSecondsOrNull,
        +                           java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2NotFoundException

        +
        public B2NotFoundException​(java.lang.String code,
        +                           java.lang.Integer retryAfterSecondsOrNull,
        +                           java.lang.String message,
        +                           java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2RequestTimeoutException.html b/com/backblaze/b2/client/exceptions/B2RequestTimeoutException.html new file mode 100644 index 000000000..544f6a0a5 --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2RequestTimeoutException.html @@ -0,0 +1,390 @@ + + + + + +B2RequestTimeoutException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2RequestTimeoutException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2RequestTimeoutException
    +extends B2Exception
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringDEFAULT_CODE 
      static intSTATUS 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2RequestTimeoutException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message) 
      B2RequestTimeoutException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message, + java.lang.Throwable cause) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2RequestTimeoutException

        +
        public B2RequestTimeoutException​(java.lang.String code,
        +                                 java.lang.Integer retryAfterSecondsOrNull,
        +                                 java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2RequestTimeoutException

        +
        public B2RequestTimeoutException​(java.lang.String code,
        +                                 java.lang.Integer retryAfterSecondsOrNull,
        +                                 java.lang.String message,
        +                                 java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2RuntimeException.html b/com/backblaze/b2/client/exceptions/B2RuntimeException.html new file mode 100644 index 000000000..de90bc839 --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2RuntimeException.html @@ -0,0 +1,315 @@ + + + + + +B2RuntimeException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2RuntimeException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2RuntimeException
    +extends java.lang.RuntimeException
    +
    B2RuntimeExceptions are thrown instead of B2Exceptions in the places + where an interface prevents the SDK from throwing a B2Exception. + The most notable examples of this are in the creation, hasNext(), and + next() methods of iterators provided by the SDK.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2RuntimeException​(java.lang.String message) 
      B2RuntimeException​(java.lang.String message, + java.lang.Throwable cause) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2RuntimeException

        +
        public B2RuntimeException​(java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2RuntimeException

        +
        public B2RuntimeException​(java.lang.String message,
        +                          java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2ServiceUnavailableException.html b/com/backblaze/b2/client/exceptions/B2ServiceUnavailableException.html new file mode 100644 index 000000000..5ecdb78d9 --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2ServiceUnavailableException.html @@ -0,0 +1,390 @@ + + + + + +B2ServiceUnavailableException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ServiceUnavailableException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2ServiceUnavailableException
    +extends B2Exception
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringDEFAULT_CODE 
      static intSTATUS 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2ServiceUnavailableException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message) 
      B2ServiceUnavailableException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message, + java.lang.Throwable cause) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ServiceUnavailableException

        +
        public B2ServiceUnavailableException​(java.lang.String code,
        +                                     java.lang.Integer retryAfterSecondsOrNull,
        +                                     java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2ServiceUnavailableException

        +
        public B2ServiceUnavailableException​(java.lang.String code,
        +                                     java.lang.Integer retryAfterSecondsOrNull,
        +                                     java.lang.String message,
        +                                     java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2SignatureVerificationException.html b/com/backblaze/b2/client/exceptions/B2SignatureVerificationException.html new file mode 100644 index 000000000..2afecbfa0 --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2SignatureVerificationException.html @@ -0,0 +1,370 @@ + + + + + +B2SignatureVerificationException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2SignatureVerificationException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2SignatureVerificationException
    +extends B2Exception
    +
    Instances of this class represents failure to verify content given a signature and secret.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringDEFAULT_CODE 
      static intSTATUS 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2SignatureVerificationException​(java.lang.String message, + java.lang.Throwable cause) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2SignatureVerificationException

        +
        public B2SignatureVerificationException​(java.lang.String message,
        +                                        java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2TooManyRequestsException.html b/com/backblaze/b2/client/exceptions/B2TooManyRequestsException.html new file mode 100644 index 000000000..54dacc63d --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2TooManyRequestsException.html @@ -0,0 +1,390 @@ + + + + + +B2TooManyRequestsException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2TooManyRequestsException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2TooManyRequestsException
    +extends B2Exception
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringDEFAULT_CODE 
      static intSTATUS 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2TooManyRequestsException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message) 
      B2TooManyRequestsException​(java.lang.String code, + java.lang.Integer retryAfterSecondsOrNull, + java.lang.String message, + java.lang.Throwable cause) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2TooManyRequestsException

        +
        public B2TooManyRequestsException​(java.lang.String code,
        +                                  java.lang.Integer retryAfterSecondsOrNull,
        +                                  java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2TooManyRequestsException

        +
        public B2TooManyRequestsException​(java.lang.String code,
        +                                  java.lang.Integer retryAfterSecondsOrNull,
        +                                  java.lang.String message,
        +                                  java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2UnauthorizedException.RequestCategory.html b/com/backblaze/b2/client/exceptions/B2UnauthorizedException.RequestCategory.html new file mode 100644 index 000000000..8621e0c29 --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2UnauthorizedException.RequestCategory.html @@ -0,0 +1,393 @@ + + + + + +B2UnauthorizedException.RequestCategory (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Enum B2UnauthorizedException.RequestCategory

+
+
+ +
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static B2UnauthorizedException.RequestCategoryvalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static B2UnauthorizedException.RequestCategory[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static B2UnauthorizedException.RequestCategory[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (B2UnauthorizedException.RequestCategory c : B2UnauthorizedException.RequestCategory.values())
        +    System.out.println(c);
        +
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
      • +
      + + + +
        +
      • +

        valueOf

        +
        public static B2UnauthorizedException.RequestCategory valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/B2UnauthorizedException.html b/com/backblaze/b2/client/exceptions/B2UnauthorizedException.html new file mode 100644 index 000000000..a1a541530 --- /dev/null +++ b/com/backblaze/b2/client/exceptions/B2UnauthorizedException.html @@ -0,0 +1,465 @@ + + + + + +B2UnauthorizedException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UnauthorizedException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2UnauthorizedException
    +extends B2Exception
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2UnauthorizedException

        +
        public B2UnauthorizedException​(java.lang.String code,
        +                               java.lang.Integer retryAfterSecondsOrNull,
        +                               java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2UnauthorizedException

        +
        public B2UnauthorizedException​(java.lang.String code,
        +                               java.lang.Integer retryAfterSecondsOrNull,
        +                               java.lang.String message,
        +                               java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/exceptions/package-summary.html b/com/backblaze/b2/client/exceptions/package-summary.html new file mode 100644 index 000000000..dbc46d6e6 --- /dev/null +++ b/com/backblaze/b2/client/exceptions/package-summary.html @@ -0,0 +1,277 @@ + + + + + +com.backblaze.b2.client.exceptions (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.backblaze.b2.client.exceptions

+
+
+ +
+
+ + + diff --git a/com/backblaze/b2/client/exceptions/package-tree.html b/com/backblaze/b2/client/exceptions/package-tree.html new file mode 100644 index 000000000..f493e92a5 --- /dev/null +++ b/com/backblaze/b2/client/exceptions/package-tree.html @@ -0,0 +1,213 @@ + + + + + +com.backblaze.b2.client.exceptions Class Hierarchy (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.backblaze.b2.client.exceptions

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+ + + diff --git a/com/backblaze/b2/client/package-summary.html b/com/backblaze/b2/client/package-summary.html new file mode 100644 index 000000000..0f2c941dc --- /dev/null +++ b/com/backblaze/b2/client/package-summary.html @@ -0,0 +1,361 @@ + + + + + +com.backblaze.b2.client (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.backblaze.b2.client

+
+
+ +
+
+ + + diff --git a/com/backblaze/b2/client/package-tree.html b/com/backblaze/b2/client/package-tree.html new file mode 100644 index 000000000..a1d772822 --- /dev/null +++ b/com/backblaze/b2/client/package-tree.html @@ -0,0 +1,218 @@ + + + + + +com.backblaze.b2.client Class Hierarchy (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.backblaze.b2.client

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+ + + diff --git a/com/backblaze/b2/client/structures/B2AccountAuthorization.html b/com/backblaze/b2/client/structures/B2AccountAuthorization.html new file mode 100644 index 000000000..37bc7e5f4 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2AccountAuthorization.html @@ -0,0 +1,491 @@ + + + + + +B2AccountAuthorization (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2AccountAuthorization

+
+
+ +
+
    +
  • +
    +
    public class B2AccountAuthorization
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2AccountAuthorization

        +
        public B2AccountAuthorization​(java.lang.String accountId,
        +                              java.lang.String authorizationToken,
        +                              java.lang.String apiUrl,
        +                              java.lang.String downloadUrl,
        +                              long recommendedPartSize,
        +                              long absoluteMinimumPartSize,
        +                              B2Allowed allowed,
        +                              java.lang.String s3ApiUrl)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAccountId

        +
        public java.lang.String getAccountId()
        +
      • +
      + + + +
        +
      • +

        getAuthorizationToken

        +
        public java.lang.String getAuthorizationToken()
        +
      • +
      + + + +
        +
      • +

        getApiUrl

        +
        public java.lang.String getApiUrl()
        +
      • +
      + + + +
        +
      • +

        getDownloadUrl

        +
        public java.lang.String getDownloadUrl()
        +
      • +
      + + + +
        +
      • +

        getRecommendedPartSize

        +
        public long getRecommendedPartSize()
        +
      • +
      + + + +
        +
      • +

        getAbsoluteMinimumPartSize

        +
        public long getAbsoluteMinimumPartSize()
        +
      • +
      + + + +
        +
      • +

        getAllowed

        +
        public B2Allowed getAllowed()
        +
      • +
      + + + +
        +
      • +

        getS3ApiUrl

        +
        public java.lang.String getS3ApiUrl()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        withAuthToken

        +
        public B2AccountAuthorization withAuthToken​(java.lang.String authToken)
        +
        +
        Parameters:
        +
        authToken - the desired authToken.
        +
        Returns:
        +
        a new B2AccountAuthorization, just like this one but with the + given authToken. useful for tests, etc.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2Allowed.html b/com/backblaze/b2/client/structures/B2Allowed.html new file mode 100644 index 000000000..48d43ef54 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2Allowed.html @@ -0,0 +1,472 @@ + + + + + +B2Allowed (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2Allowed

+
+
+ +
+
    +
  • +
    +
    public class B2Allowed
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      java.lang.StringbucketId 
      java.lang.StringbucketName 
      java.util.List<java.lang.String>capabilities 
      java.lang.StringnamePrefix 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2Allowed​(java.util.List<java.lang.String> capabilities, + java.lang.String bucketId, + java.lang.String bucketName, + java.lang.String namePrefix) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanequals​(java.lang.Object o) 
      java.lang.StringgetBucketId() 
      java.lang.StringgetBucketName() 
      java.util.List<java.lang.String>getCapabilities() 
      java.lang.StringgetNamePrefix() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        capabilities

        +
        public final java.util.List<java.lang.String> capabilities
        +
      • +
      + + + +
        +
      • +

        bucketId

        +
        public final java.lang.String bucketId
        +
      • +
      + + + +
        +
      • +

        bucketName

        +
        public final java.lang.String bucketName
        +
      • +
      + + + +
        +
      • +

        namePrefix

        +
        public final java.lang.String namePrefix
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2Allowed

        +
        public B2Allowed​(java.util.List<java.lang.String> capabilities,
        +                 java.lang.String bucketId,
        +                 java.lang.String bucketName,
        +                 java.lang.String namePrefix)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCapabilities

        +
        public java.util.List<java.lang.String> getCapabilities()
        +
      • +
      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getBucketName

        +
        public java.lang.String getBucketName()
        +
      • +
      + + + +
        +
      • +

        getNamePrefix

        +
        public java.lang.String getNamePrefix()
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ApplicationKey.html b/com/backblaze/b2/client/structures/B2ApplicationKey.html new file mode 100644 index 000000000..23fabbda5 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ApplicationKey.html @@ -0,0 +1,453 @@ + + + + + +B2ApplicationKey (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ApplicationKey

+
+
+ +
+
    +
  • +
    +
    public class B2ApplicationKey
    +extends java.lang.Object
    +
    Response from b2_delete_key, and included in response from b2_list_keys.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2ApplicationKey​(java.lang.String accountId, + java.lang.String applicationKeyId, + java.lang.String keyName, + java.util.TreeSet<java.lang.String> capabilities, + java.lang.String bucketId, + java.lang.String namePrefix, + java.lang.Long expirationTimestamp, + java.util.Set<java.lang.String> options) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ApplicationKey

        +
        public B2ApplicationKey​(java.lang.String accountId,
        +                        java.lang.String applicationKeyId,
        +                        java.lang.String keyName,
        +                        java.util.TreeSet<java.lang.String> capabilities,
        +                        java.lang.String bucketId,
        +                        java.lang.String namePrefix,
        +                        java.lang.Long expirationTimestamp,
        +                        java.util.Set<java.lang.String> options)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAccountId

        +
        public java.lang.String getAccountId()
        +
      • +
      + + + +
        +
      • +

        getApplicationKeyId

        +
        public java.lang.String getApplicationKeyId()
        +
      • +
      + + + +
        +
      • +

        getKeyName

        +
        public java.lang.String getKeyName()
        +
      • +
      + + + +
        +
      • +

        getCapabilities

        +
        public java.util.TreeSet<java.lang.String> getCapabilities()
        +
      • +
      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getNamePrefix

        +
        public java.lang.String getNamePrefix()
        +
      • +
      + + + +
        +
      • +

        getExpirationTimestamp

        +
        public java.lang.Long getExpirationTimestamp()
        +
      • +
      + + + +
        +
      • +

        getOptions

        +
        public java.util.Set<java.lang.String> getOptions()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2AuthorizationFilteredResponseField.html b/com/backblaze/b2/client/structures/B2AuthorizationFilteredResponseField.html new file mode 100644 index 000000000..b9fac5d37 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2AuthorizationFilteredResponseField.html @@ -0,0 +1,353 @@ + + + + + +B2AuthorizationFilteredResponseField (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2AuthorizationFilteredResponseField<T>

+
+
+ +
+
    +
  • +
    +
    public class B2AuthorizationFilteredResponseField<T>
    +extends java.lang.Object
    +
    A generic class to represent response fields that are filtered based on authorization + + Parameter T will represent the different types of response field (e.g. B2FileRetention, B2BucketServerSideEncryption, etc.) + + This class isn't really for general use, but we need it public in order to build B2FileVersion outside this package.
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanequals​(java.lang.Object o) 
      inthashCode() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + + + +
        +
      • +

        B2AuthorizationFilteredResponseField

        +
        public B2AuthorizationFilteredResponseField​(boolean isClientAuthorizedToRead,
        +                                            T value)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2AuthorizeAccountRequest.Builder.html b/com/backblaze/b2/client/structures/B2AuthorizeAccountRequest.Builder.html new file mode 100644 index 000000000..5886c45ab --- /dev/null +++ b/com/backblaze/b2/client/structures/B2AuthorizeAccountRequest.Builder.html @@ -0,0 +1,310 @@ + + + + + +B2AuthorizeAccountRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2AuthorizeAccountRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2AuthorizeAccountRequest
    +
    +
    +
    public static class B2AuthorizeAccountRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      Builder​(java.lang.String applicationKeyId, + java.lang.String applicationKey) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder​(java.lang.String applicationKeyId,
        +               java.lang.String applicationKey)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2AuthorizeAccountRequest.html b/com/backblaze/b2/client/structures/B2AuthorizeAccountRequest.html new file mode 100644 index 000000000..43e1e1132 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2AuthorizeAccountRequest.html @@ -0,0 +1,399 @@ + + + + + +B2AuthorizeAccountRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2AuthorizeAccountRequest

+
+
+ +
+
    +
  • +
    +
    public class B2AuthorizeAccountRequest
    +extends java.lang.Object
    +
    This structure holds the information for b2_authorize_account. + + If you used getAccountId() in a previous version of the SDK, please + use B2StorageClient.getAccountId() in this version.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2AuthorizeAccountRequest

        +
        public B2AuthorizeAccountRequest​(java.lang.String applicationKeyId,
        +                                 java.lang.String applicationKey)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getApplicationKeyId

        +
        public java.lang.String getApplicationKeyId()
        +
      • +
      + + + +
        +
      • +

        getApplicationKey

        +
        public java.lang.String getApplicationKey()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2Bucket.html b/com/backblaze/b2/client/structures/B2Bucket.html new file mode 100644 index 000000000..cf3bf4216 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2Bucket.html @@ -0,0 +1,630 @@ + + + + + +B2Bucket (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2Bucket

+
+
+ +
+
    +
  • +
    +
    public class B2Bucket
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAccountId

        +
        public java.lang.String getAccountId()
        +
      • +
      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getBucketName

        +
        public java.lang.String getBucketName()
        +
      • +
      + + + +
        +
      • +

        getBucketType

        +
        public java.lang.String getBucketType()
        +
      • +
      + + + +
        +
      • +

        getBucketInfo

        +
        public java.util.Map<java.lang.String,​java.lang.String> getBucketInfo()
        +
      • +
      + + + +
        +
      • +

        getCorsRules

        +
        public java.util.List<B2CorsRule> getCorsRules()
        +
      • +
      + + + +
        +
      • +

        getLifecycleRules

        +
        public java.util.List<B2LifecycleRule> getLifecycleRules()
        +
      • +
      + + + +
        +
      • +

        getOptions

        +
        public java.util.Set<java.lang.String> getOptions()
        +
      • +
      + + + +
        +
      • +

        getRevision

        +
        public int getRevision()
        +
      • +
      + + + +
        +
      • +

        isClientAuthorizedToReadFileLockConfiguration

        +
        public boolean isClientAuthorizedToReadFileLockConfiguration()
        +
        Indicates whether client is authorized to read file lock configuration settings for bucket
        +
        +
        Returns:
        +
        true iff client is authorized to read value of fileLockConfiguration field in B2Bucket
        +
        +
      • +
      + + + +
        +
      • +

        getFileLockConfiguration

        +
        public B2BucketFileLockConfiguration getFileLockConfiguration()
        +                                                       throws B2ForbiddenException
        +
        Returns bucket file lock configuration. Throws B2ForbiddenException if client is not authorized to read + bucket file lock configuration.
        +
        +
        Returns:
        +
        file lock configuration
        +
        Throws:
        +
        B2ForbiddenException - if client is not authorized to read fileLockConfiguration
        +
        +
      • +
      + + + +
        +
      • +

        isClientAuthorizedToReadDefaultServerSideEncryption

        +
        public boolean isClientAuthorizedToReadDefaultServerSideEncryption()
        +
        Indicates whether client is authorized to read default bucket encryption settings for bucket
        +
        +
        Returns:
        +
        true iff client is authorized to read value of defaultServerSideEncryption field in B2Bucket
        +
        +
      • +
      + + + +
        +
      • +

        getDefaultServerSideEncryption

        +
        public B2BucketServerSideEncryption getDefaultServerSideEncryption()
        +                                                            throws B2ForbiddenException
        +
        Returns settings for default bucket encryption (i.e., mode and algorithm) or null if there are none. + Throws B2ForbiddenException if client is not authorized to read bucket default encryption settings.
        +
        +
        Returns:
        +
        default bucket encryption settings
        +
        Throws:
        +
        B2ForbiddenException - if client is not authorized to read defaultServerSideEncryption field
        +
        +
      • +
      + + + +
        +
      • +

        isClientAuthorizedToReadReplicationConfiguration

        +
        public boolean isClientAuthorizedToReadReplicationConfiguration()
        +
        Indicates whether client is authorized to read replication configuration settings for bucket
        +
        +
        Returns:
        +
        true iff client is authorized to read value of replicationConfiguration field in B2Bucket
        +
        +
      • +
      + + + +
        +
      • +

        getReplicationConfiguration

        +
        public B2BucketReplicationConfiguration getReplicationConfiguration()
        +                                                             throws B2ForbiddenException
        +
        Returns settings for bucket replication configuration or null if there are none. + Throws B2ForbiddenException if client is not authorized to read bucket replication configuration settings.
        +
        +
        Returns:
        +
        replication configuration settings
        +
        Throws:
        +
        B2ForbiddenException - if client is not authorized to read replicationConfiguration field
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2BucketDefaultRetention.html b/com/backblaze/b2/client/structures/B2BucketDefaultRetention.html new file mode 100644 index 000000000..1830815da --- /dev/null +++ b/com/backblaze/b2/client/structures/B2BucketDefaultRetention.html @@ -0,0 +1,391 @@ + + + + + +B2BucketDefaultRetention (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2BucketDefaultRetention

+
+
+ +
+
    +
  • +
    +
    public class B2BucketDefaultRetention
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + + + + + +
        +
      • +

        B2BucketDefaultRetention

        +
        public B2BucketDefaultRetention​(java.lang.String mode,
        +                                int duration,
        +                                java.lang.String unit)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMode

        +
        public java.lang.String getMode()
        +
      • +
      + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2BucketDefaultRetentionPeriod.html b/com/backblaze/b2/client/structures/B2BucketDefaultRetentionPeriod.html new file mode 100644 index 000000000..d8514b8e8 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2BucketDefaultRetentionPeriod.html @@ -0,0 +1,374 @@ + + + + + +B2BucketDefaultRetentionPeriod (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2BucketDefaultRetentionPeriod

+
+
+ +
+
    +
  • +
    +
    public class B2BucketDefaultRetentionPeriod
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanequals​(java.lang.Object o) 
      intgetDuration() 
      java.lang.StringgetUnit() 
      inthashCode() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2BucketDefaultRetentionPeriod

        +
        public B2BucketDefaultRetentionPeriod​(int duration,
        +                                      java.lang.String unit)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDuration

        +
        public int getDuration()
        +
      • +
      + + + +
        +
      • +

        getUnit

        +
        public java.lang.String getUnit()
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2BucketFileLockConfiguration.html b/com/backblaze/b2/client/structures/B2BucketFileLockConfiguration.html new file mode 100644 index 000000000..633bfd73c --- /dev/null +++ b/com/backblaze/b2/client/structures/B2BucketFileLockConfiguration.html @@ -0,0 +1,434 @@ + + + + + +B2BucketFileLockConfiguration (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2BucketFileLockConfiguration

+
+
+ +
+
    +
  • +
    +
    public class B2BucketFileLockConfiguration
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2BucketFileLockConfiguration

        +
        public B2BucketFileLockConfiguration​(boolean isFileLockEnabled,
        +                                     B2BucketDefaultRetention defaultRetention)
        +
      • +
      + + + +
        +
      • +

        B2BucketFileLockConfiguration

        +
        public B2BucketFileLockConfiguration​(boolean isFileLockEnabled,
        +                                     java.lang.String mode,
        +                                     int duration,
        +                                     java.lang.String unit)
        +
      • +
      + + + +
        +
      • +

        B2BucketFileLockConfiguration

        +
        public B2BucketFileLockConfiguration​(boolean isFileLockEnabled)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isFileLockEnabled

        +
        public boolean isFileLockEnabled()
        +
      • +
      + + + + + + + +
        +
      • +

        getDefaultRetentionMode

        +
        public java.lang.String getDefaultRetentionMode()
        +
      • +
      + + + + + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2BucketReplicationConfiguration.html b/com/backblaze/b2/client/structures/B2BucketReplicationConfiguration.html new file mode 100644 index 000000000..108a4f397 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2BucketReplicationConfiguration.html @@ -0,0 +1,469 @@ + + + + + +B2BucketReplicationConfiguration (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2BucketReplicationConfiguration

+
+
+ +
+
    +
  • +
    +
    public class B2BucketReplicationConfiguration
    +extends java.lang.Object
    +
    Replication configuration for a bucket. + + Factory methods are available to create configurations for 1) source-only, + 2) destination-only, or 3) simultaneously source and destination buckets.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        NONE

        +
        public static final B2BucketReplicationConfiguration NONE
        +
        Static field for convenience to use with updateBucket() to remove bucket replication configuration
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createForSourceAndDestination

        +
        public static B2BucketReplicationConfiguration createForSourceAndDestination​(java.lang.String sourceApplicationKeyId,
        +                                                                             java.util.List<B2ReplicationRule> replicationRules,
        +                                                                             java.util.Map<java.lang.String,​java.lang.String> sourceToDestinationKeyMapping)
        +
        Returns a ReplicationConfiguration for a bucket that will be a replication source and a replication + destination. All arguments must be non-null, and replicationRules and sourceToDestinationKeyMapping must + not be empty.
        +
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any input arguments are null
        +
        +
      • +
      + + + +
        +
      • +

        createForSource

        +
        public static B2BucketReplicationConfiguration createForSource​(java.lang.String sourceApplicationKeyId,
        +                                                               java.util.List<B2ReplicationRule> replicationRules)
        +
        Returns a B2BucketReplicationConfiguration for a bucket that will only be a replication source. Both arguments + must be non-null and replicationRules must not be empty.
        +
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any input arguments are null or replicationRules is empty
        +
        +
      • +
      + + + +
        +
      • +

        createForDestination

        +
        public static B2BucketReplicationConfiguration createForDestination​(java.util.Map<java.lang.String,​java.lang.String> sourceToDestinationKeyMapping)
        +
        Returns a B2BucketReplicationConfiguration for a bucket that will only be a replication destination. + sourceToDestinationKeyMapping must not be null or empty.
        +
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if sourceToDestinationKeyMapping is null or empty
        +
        +
      • +
      + + + +
        +
      • +

        getSourceApplicationKeyIdOrNull

        +
        public java.lang.String getSourceApplicationKeyIdOrNull()
        +
      • +
      + + + +
        +
      • +

        getReplicationRulesOrNull

        +
        public java.util.List<B2ReplicationRule> getReplicationRulesOrNull()
        +
      • +
      + + + +
        +
      • +

        getSourceToDestinationKeyMappingOrNull

        +
        public java.util.Map<java.lang.String,​java.lang.String> getSourceToDestinationKeyMappingOrNull()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2BucketServerSideEncryption.html b/com/backblaze/b2/client/structures/B2BucketServerSideEncryption.html new file mode 100644 index 000000000..b0ef489ca --- /dev/null +++ b/com/backblaze/b2/client/structures/B2BucketServerSideEncryption.html @@ -0,0 +1,374 @@ + + + + + +B2BucketServerSideEncryption (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2BucketServerSideEncryption

+
+
+ +
+
    +
  • +
    +
    public class B2BucketServerSideEncryption
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createSseB2Aes256

        +
        public static B2BucketServerSideEncryption createSseB2Aes256()
        +
        Create default bucket server-side encryption configuration with mode of SSE-B2 and algorithm of AES256
        +
        +
        Returns:
        +
        default SSE-B2 AES256 bucket encryption configuration
        +
        +
      • +
      + + + +
        +
      • +

        createSseNone

        +
        public static B2BucketServerSideEncryption createSseNone()
        +
        Create default bucket server-side encryption configuration with default encryption disabled.
        +
        +
        Returns:
        +
        default disabled bucket encryption configuration
        +
        +
      • +
      + + + +
        +
      • +

        getMode

        +
        public java.lang.String getMode()
        +
      • +
      + + + +
        +
      • +

        getAlgorithm

        +
        public java.lang.String getAlgorithm()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2BucketTypes.html b/com/backblaze/b2/client/structures/B2BucketTypes.html new file mode 100644 index 000000000..d98020fa2 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2BucketTypes.html @@ -0,0 +1,274 @@ + + + + + +B2BucketTypes (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2BucketTypes

+
+
+
+
    +
  • +
    +
    public interface B2BucketTypes
    +
    B2BucketTypes provides constants for well-known bucket types. + + DESIGN NOTE: It is *not* an enum because new bucket types will be added + over time and we want code to be able to get a bucket from + the service, change an attribute, and use it in an update + operation. If we used an enum, even with the + BzJson.defaultForInvalidEnumValue() annotation, we wouldn't + be able to operate generically on buckets with unknown + bucketTypes. (hmmmm...b2_update_bucket could treat bucketType + 'unknown' as a way of saying "don't change".)
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringALL_PRIVATE 
      static java.lang.StringALL_PUBLIC 
      +
    • +
    +
    +
  • +
+
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CancelLargeFileRequest.Builder.html b/com/backblaze/b2/client/structures/B2CancelLargeFileRequest.Builder.html new file mode 100644 index 000000000..fcf994882 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CancelLargeFileRequest.Builder.html @@ -0,0 +1,308 @@ + + + + + +B2CancelLargeFileRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CancelLargeFileRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2CancelLargeFileRequest
    +
    +
    +
    public static class B2CancelLargeFileRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      Builder​(java.lang.String fileId) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder​(java.lang.String fileId)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CancelLargeFileRequest.html b/com/backblaze/b2/client/structures/B2CancelLargeFileRequest.html new file mode 100644 index 000000000..b24814dcf --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CancelLargeFileRequest.html @@ -0,0 +1,337 @@ + + + + + +B2CancelLargeFileRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CancelLargeFileRequest

+
+
+ +
+
    +
  • +
    +
    public class B2CancelLargeFileRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CancelLargeFileResponse.html b/com/backblaze/b2/client/structures/B2CancelLargeFileResponse.html new file mode 100644 index 000000000..35577a195 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CancelLargeFileResponse.html @@ -0,0 +1,376 @@ + + + + + +B2CancelLargeFileResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CancelLargeFileResponse

+
+
+ +
+
    +
  • +
    +
    public class B2CancelLargeFileResponse
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2CancelLargeFileResponse​(java.lang.String fileId, + java.lang.String bucketId, + java.lang.String fileName) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanequals​(java.lang.Object o) 
      java.lang.StringgetFileId() 
      java.lang.StringgetFileName() 
      inthashCode() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2CancelLargeFileResponse

        +
        public B2CancelLargeFileResponse​(java.lang.String fileId,
        +                                 java.lang.String bucketId,
        +                                 java.lang.String fileName)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      + + + +
        +
      • +

        getFileName

        +
        public java.lang.String getFileName()
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2Capabilities.html b/com/backblaze/b2/client/structures/B2Capabilities.html new file mode 100644 index 000000000..b02df6f27 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2Capabilities.html @@ -0,0 +1,705 @@ + + + + + +B2Capabilities (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2Capabilities

+
+
+
+
    +
  • +
    +
    public interface B2Capabilities
    +
    B2Capabilities provides constants capabilities in application keys. + + DESIGN NOTE: It is *not* an enum because new capabilities will be added + over time and we want code to be able to get a key from + the service and use the list of capabilities to create a new + key with the same capabilities. operation. If we used an enum, + even with the BzJson.defaultForInvalidEnumValue() annotation, + we wouldn't be able to operate generically on keys with unknown + capabilities.
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CopyFileRequest.Builder.html b/com/backblaze/b2/client/structures/B2CopyFileRequest.Builder.html new file mode 100644 index 000000000..0edaa5e35 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CopyFileRequest.Builder.html @@ -0,0 +1,436 @@ + + + + + +B2CopyFileRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CopyFileRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2CopyFileRequest
    +
    +
    +
    public static class B2CopyFileRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CopyFileRequest.html b/com/backblaze/b2/client/structures/B2CopyFileRequest.html new file mode 100644 index 000000000..53ec018fe --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CopyFileRequest.html @@ -0,0 +1,543 @@ + + + + + +B2CopyFileRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CopyFileRequest

+
+
+ +
+
    +
  • +
    +
    public class B2CopyFileRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        COPY_METADATA_DIRECTIVE

        +
        public static final java.lang.String COPY_METADATA_DIRECTIVE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
      • +
      + + + +
        +
      • +

        REPLACE_METADATA_DIRECTIVE

        +
        public static final java.lang.String REPLACE_METADATA_DIRECTIVE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSourceFileId

        +
        public java.lang.String getSourceFileId()
        +
      • +
      + + + +
        +
      • +

        getDestinationBucketId

        +
        public java.lang.String getDestinationBucketId()
        +
      • +
      + + + +
        +
      • +

        getFileName

        +
        public java.lang.String getFileName()
        +
      • +
      + + + +
        +
      • +

        getRange

        +
        public java.lang.String getRange()
        +
      • +
      + + + +
        +
      • +

        getMetadataDirective

        +
        public java.lang.String getMetadataDirective()
        +
      • +
      + + + +
        +
      • +

        getContentType

        +
        public java.lang.String getContentType()
        +
      • +
      + + + +
        +
      • +

        getFileInfo

        +
        public java.util.Map<java.lang.String,​java.lang.String> getFileInfo()
        +
      • +
      + + + +
        +
      • +

        getSourceServerSideEncryption

        +
        public B2FileSseForRequest getSourceServerSideEncryption()
        +
      • +
      + + + +
        +
      • +

        getDestinationServerSideEncryption

        +
        public B2FileSseForRequest getDestinationServerSideEncryption()
        +
      • +
      + + + + + + + +
        +
      • +

        getLegalHold

        +
        public java.lang.String getLegalHold()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        builder

        +
        public static B2CopyFileRequest.Builder builder​(java.lang.String sourceFileId,
        +                                                java.lang.String fileName)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CopyPartRequest.Builder.html b/com/backblaze/b2/client/structures/B2CopyPartRequest.Builder.html new file mode 100644 index 000000000..fd837c0cc --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CopyPartRequest.Builder.html @@ -0,0 +1,354 @@ + + + + + +B2CopyPartRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CopyPartRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2CopyPartRequest
    +
    +
    +
    public static class B2CopyPartRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CopyPartRequest.html b/com/backblaze/b2/client/structures/B2CopyPartRequest.html new file mode 100644 index 000000000..549af1236 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CopyPartRequest.html @@ -0,0 +1,411 @@ + + + + + +B2CopyPartRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CopyPartRequest

+
+
+ +
+
    +
  • +
    +
    public class B2CopyPartRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        builder

        +
        public static B2CopyPartRequest.Builder builder​(int partNumber,
        +                                                java.lang.String sourceFileId,
        +                                                java.lang.String largeFileId)
        +
      • +
      + + + +
        +
      • +

        getPartNumber

        +
        public int getPartNumber()
        +
      • +
      + + + +
        +
      • +

        getSourceFileId

        +
        public java.lang.String getSourceFileId()
        +
      • +
      + + + +
        +
      • +

        getLargeFileId

        +
        public java.lang.String getLargeFileId()
        +
      • +
      + + + +
        +
      • +

        getRange

        +
        public java.lang.String getRange()
        +
      • +
      + + + +
        +
      • +

        getSourceServerSideEncryption

        +
        public B2FileSseForRequest getSourceServerSideEncryption()
        +
      • +
      + + + +
        +
      • +

        getDestinationServerSideEncryption

        +
        public B2FileSseForRequest getDestinationServerSideEncryption()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CorsRule.Builder.html b/com/backblaze/b2/client/structures/B2CorsRule.Builder.html new file mode 100644 index 000000000..b0d75b362 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CorsRule.Builder.html @@ -0,0 +1,296 @@ + + + + + +B2CorsRule.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CorsRule.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2CorsRule
    +
    +
    +
    public static class B2CorsRule.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setAllowedHeaders

        +
        public B2CorsRule.Builder setAllowedHeaders​(java.util.List<java.lang.String> allowedHeaders)
        +
      • +
      + + + +
        +
      • +

        setExposeHeaders

        +
        public B2CorsRule.Builder setExposeHeaders​(java.util.List<java.lang.String> exposeHeaders)
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CorsRule.html b/com/backblaze/b2/client/structures/B2CorsRule.html new file mode 100644 index 000000000..9e3e0d919 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CorsRule.html @@ -0,0 +1,431 @@ + + + + + +B2CorsRule (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CorsRule

+
+
+ +
+
    +
  • +
    +
    public class B2CorsRule
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCorsRuleName

        +
        public java.lang.String getCorsRuleName()
        +
      • +
      + + + +
        +
      • +

        getAllowedOrigins

        +
        public java.util.List<java.lang.String> getAllowedOrigins()
        +
      • +
      + + + +
        +
      • +

        getAllowedOperations

        +
        public java.util.Set<java.lang.String> getAllowedOperations()
        +
      • +
      + + + +
        +
      • +

        getAllowedHeaders

        +
        public java.util.List<java.lang.String> getAllowedHeaders()
        +
      • +
      + + + +
        +
      • +

        getExposeHeaders

        +
        public java.util.List<java.lang.String> getExposeHeaders()
        +
      • +
      + + + +
        +
      • +

        getMaxAgeSeconds

        +
        public int getMaxAgeSeconds()
        +
      • +
      + + + +
        +
      • +

        builder

        +
        public static B2CorsRule.Builder builder​(java.lang.String corsRuleName,
        +                                         java.util.List<java.lang.String> allowedOrigins,
        +                                         java.util.Set<java.lang.String> allowedOperations,
        +                                         int maxAgeSeconds)
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CreateBucketRequest.Builder.html b/com/backblaze/b2/client/structures/B2CreateBucketRequest.Builder.html new file mode 100644 index 000000000..eae2cbeca --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CreateBucketRequest.Builder.html @@ -0,0 +1,352 @@ + + + + + +B2CreateBucketRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CreateBucketRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2CreateBucketRequest
    +
    +
    +
    public static class B2CreateBucketRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CreateBucketRequest.html b/com/backblaze/b2/client/structures/B2CreateBucketRequest.html new file mode 100644 index 000000000..4d164f706 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CreateBucketRequest.html @@ -0,0 +1,455 @@ + + + + + +B2CreateBucketRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CreateBucketRequest

+
+
+ +
+
    +
  • +
    +
    public class B2CreateBucketRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2CreateBucketRequest

        +
        public B2CreateBucketRequest​(java.lang.String bucketName,
        +                             java.lang.String bucketType,
        +                             java.util.Map<java.lang.String,​java.lang.String> bucketInfo,
        +                             java.util.List<B2CorsRule> corsRules,
        +                             java.util.List<B2LifecycleRule> lifecycleRules,
        +                             boolean fileLockEnabled,
        +                             B2BucketServerSideEncryption defaultServerSideEncryption,
        +                             B2BucketReplicationConfiguration replicationConfiguration)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketName

        +
        public java.lang.String getBucketName()
        +
      • +
      + + + +
        +
      • +

        getBucketType

        +
        public java.lang.String getBucketType()
        +
      • +
      + + + +
        +
      • +

        getBucketInfo

        +
        public java.util.Map<java.lang.String,​java.lang.String> getBucketInfo()
        +
      • +
      + + + +
        +
      • +

        getCorsRules

        +
        public java.util.List<B2CorsRule> getCorsRules()
        +
      • +
      + + + +
        +
      • +

        getLifecycleRules

        +
        public java.util.List<B2LifecycleRule> getLifecycleRules()
        +
      • +
      + + + +
        +
      • +

        isFileLockEnabled

        +
        public boolean isFileLockEnabled()
        +
      • +
      + + + + + + + + + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CreateBucketRequestReal.html b/com/backblaze/b2/client/structures/B2CreateBucketRequestReal.html new file mode 100644 index 000000000..803729f2a --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CreateBucketRequestReal.html @@ -0,0 +1,351 @@ + + + + + +B2CreateBucketRequestReal (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CreateBucketRequestReal

+
+
+ +
+
    +
  • +
    +
    public class B2CreateBucketRequestReal
    +extends java.lang.Object
    +
    NOTE: + B2CreateBucketRequestReal has the attributes needed by the B2 API. That's why it's name ends with 'Real'. + Code that calls B2StorageClient uses B2CreateBucketRequest (with no 'Real' at the end) instead. + The B2StorageClient creates a 'Real' request by adding the accountId to the non-real version before + sending it to the webifier.
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanequals​(java.lang.Object o) 
      inthashCode() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2CreateBucketRequestReal

        +
        public B2CreateBucketRequestReal​(java.lang.String accountId,
        +                                 B2CreateBucketRequest mostOfRequest)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CreateKeyRequest.Builder.html b/com/backblaze/b2/client/structures/B2CreateKeyRequest.Builder.html new file mode 100644 index 000000000..dae9ea331 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CreateKeyRequest.Builder.html @@ -0,0 +1,310 @@ + + + + + +B2CreateKeyRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CreateKeyRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2CreateKeyRequest
    +
    +
    +
    public static class B2CreateKeyRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CreateKeyRequest.html b/com/backblaze/b2/client/structures/B2CreateKeyRequest.html new file mode 100644 index 000000000..64b050ca3 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CreateKeyRequest.html @@ -0,0 +1,395 @@ + + + + + +B2CreateKeyRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CreateKeyRequest

+
+
+ +
+
    +
  • +
    +
    public class B2CreateKeyRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        builder

        +
        public static B2CreateKeyRequest.Builder builder​(java.util.Set<java.lang.String> capabilities,
        +                                                 java.lang.String keyName)
        +
      • +
      + + + +
        +
      • +

        getCapabilities

        +
        public java.util.Set<java.lang.String> getCapabilities()
        +
      • +
      + + + +
        +
      • +

        getKeyName

        +
        public java.lang.String getKeyName()
        +
      • +
      + + + +
        +
      • +

        getValidDurationInSeconds

        +
        public java.lang.Long getValidDurationInSeconds()
        +
      • +
      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getNamePrefix

        +
        public java.lang.String getNamePrefix()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CreateKeyRequestReal.html b/com/backblaze/b2/client/structures/B2CreateKeyRequestReal.html new file mode 100644 index 000000000..e75fca72a --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CreateKeyRequestReal.html @@ -0,0 +1,416 @@ + + + + + +B2CreateKeyRequestReal (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CreateKeyRequestReal

+
+
+ +
+
    +
  • +
    +
    public class B2CreateKeyRequestReal
    +extends java.lang.Object
    +
    b2_create_key request, as sent to service, including the accountId. + + Code that calls B2StorageClient uses B2CreateKeyRequest, which doesn't have the + accountId in it. The B2StorageClient makes this real request by adding the accountId.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2CreateKeyRequestReal

        +
        public B2CreateKeyRequestReal​(java.lang.String accountId,
        +                              B2CreateKeyRequest mostOfRequest)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAccountId

        +
        public java.lang.String getAccountId()
        +
      • +
      + + + +
        +
      • +

        getCapabilities

        +
        public java.util.Set<java.lang.String> getCapabilities()
        +
      • +
      + + + +
        +
      • +

        getKeyName

        +
        public java.lang.String getKeyName()
        +
      • +
      + + + +
        +
      • +

        getValidDurationInSeconds

        +
        public java.lang.Long getValidDurationInSeconds()
        +
      • +
      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getNamePrefix

        +
        public java.lang.String getNamePrefix()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2CreatedApplicationKey.html b/com/backblaze/b2/client/structures/B2CreatedApplicationKey.html new file mode 100644 index 000000000..7cfa11830 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2CreatedApplicationKey.html @@ -0,0 +1,492 @@ + + + + + +B2CreatedApplicationKey (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2CreatedApplicationKey

+
+
+ +
+
    +
  • +
    +
    public class B2CreatedApplicationKey
    +extends java.lang.Object
    +
    Information returned from b2_create_key. + + This is like B2ApplicationKey, with the addition of the secret applicationKey, + which is returned when a key is created, but not returned by b2_list_keys, + or b2_delete_key.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2CreatedApplicationKey​(java.lang.String accountId, + java.lang.String applicationKeyId, + java.lang.String applicationKey, + java.lang.String keyName, + java.util.TreeSet<java.lang.String> capabilities, + java.lang.String bucketId, + java.lang.String namePrefix, + java.lang.Long expirationTimestamp, + java.util.Set<java.lang.String> options) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2CreatedApplicationKey

        +
        public B2CreatedApplicationKey​(java.lang.String accountId,
        +                               java.lang.String applicationKeyId,
        +                               java.lang.String applicationKey,
        +                               java.lang.String keyName,
        +                               java.util.TreeSet<java.lang.String> capabilities,
        +                               java.lang.String bucketId,
        +                               java.lang.String namePrefix,
        +                               java.lang.Long expirationTimestamp,
        +                               java.util.Set<java.lang.String> options)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAccountId

        +
        public java.lang.String getAccountId()
        +
      • +
      + + + +
        +
      • +

        getApplicationKeyId

        +
        public java.lang.String getApplicationKeyId()
        +
      • +
      + + + +
        +
      • +

        getApplicationKey

        +
        public java.lang.String getApplicationKey()
        +
      • +
      + + + +
        +
      • +

        getKeyName

        +
        public java.lang.String getKeyName()
        +
      • +
      + + + +
        +
      • +

        getCapabilities

        +
        public java.util.TreeSet<java.lang.String> getCapabilities()
        +
      • +
      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getNamePrefix

        +
        public java.lang.String getNamePrefix()
        +
      • +
      + + + +
        +
      • +

        getExpirationTimestamp

        +
        public java.lang.Long getExpirationTimestamp()
        +
      • +
      + + + +
        +
      • +

        getOptions

        +
        public java.util.Set<java.lang.String> getOptions()
        +
      • +
      + + + +
        +
      • +

        toApplicationKey

        +
        public B2ApplicationKey toApplicationKey()
        +
        Converts to the B2ApplicationKey structure, as returned from b2_list_keys, + which does not contain the secret key.
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2DeleteBucketRequest.Builder.html b/com/backblaze/b2/client/structures/B2DeleteBucketRequest.Builder.html new file mode 100644 index 000000000..2f673e01d --- /dev/null +++ b/com/backblaze/b2/client/structures/B2DeleteBucketRequest.Builder.html @@ -0,0 +1,308 @@ + + + + + +B2DeleteBucketRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2DeleteBucketRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2DeleteBucketRequest
    +
    +
    +
    public static class B2DeleteBucketRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      Builder​(java.lang.String bucketId) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder​(java.lang.String bucketId)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2DeleteBucketRequest.html b/com/backblaze/b2/client/structures/B2DeleteBucketRequest.html new file mode 100644 index 000000000..34f3fcfe2 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2DeleteBucketRequest.html @@ -0,0 +1,337 @@ + + + + + +B2DeleteBucketRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2DeleteBucketRequest

+
+
+ +
+
    +
  • +
    +
    public class B2DeleteBucketRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2DeleteBucketRequestReal.html b/com/backblaze/b2/client/structures/B2DeleteBucketRequestReal.html new file mode 100644 index 000000000..e121d6190 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2DeleteBucketRequestReal.html @@ -0,0 +1,356 @@ + + + + + +B2DeleteBucketRequestReal (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2DeleteBucketRequestReal

+
+
+ +
+
    +
  • +
    +
    public class B2DeleteBucketRequestReal
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2DeleteBucketRequestReal​(java.lang.String accountId, + java.lang.String bucketId) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanequals​(java.lang.Object o) 
      java.lang.StringgetAccountId() 
      java.lang.StringgetBucketId() 
      inthashCode() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2DeleteBucketRequestReal

        +
        public B2DeleteBucketRequestReal​(java.lang.String accountId,
        +                                 java.lang.String bucketId)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAccountId

        +
        public java.lang.String getAccountId()
        +
      • +
      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2DeleteFileVersionRequest.Builder.html b/com/backblaze/b2/client/structures/B2DeleteFileVersionRequest.Builder.html new file mode 100644 index 000000000..e23b1d032 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2DeleteFileVersionRequest.Builder.html @@ -0,0 +1,324 @@ + + + + + +B2DeleteFileVersionRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2DeleteFileVersionRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2DeleteFileVersionRequest
    +
    +
    +
    public static class B2DeleteFileVersionRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2DeleteFileVersionRequest.html b/com/backblaze/b2/client/structures/B2DeleteFileVersionRequest.html new file mode 100644 index 000000000..7f83ebe2e --- /dev/null +++ b/com/backblaze/b2/client/structures/B2DeleteFileVersionRequest.html @@ -0,0 +1,411 @@ + + + + + +B2DeleteFileVersionRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2DeleteFileVersionRequest

+
+
+ +
+
    +
  • +
    +
    public class B2DeleteFileVersionRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2DeleteFileVersionRequest

        +
        public B2DeleteFileVersionRequest​(java.lang.String fileName,
        +                                  java.lang.String fileId,
        +                                  boolean bypassGovernance)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileName

        +
        public java.lang.String getFileName()
        +
      • +
      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      + + + +
        +
      • +

        isBypassGovernance

        +
        public boolean isBypassGovernance()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2DeleteFileVersionResponse.html b/com/backblaze/b2/client/structures/B2DeleteFileVersionResponse.html new file mode 100644 index 000000000..02736b738 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2DeleteFileVersionResponse.html @@ -0,0 +1,374 @@ + + + + + +B2DeleteFileVersionResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2DeleteFileVersionResponse

+
+
+ +
+
    +
  • +
    +
    public class B2DeleteFileVersionResponse
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2DeleteFileVersionResponse​(java.lang.String fileId, + java.lang.String fileName) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanequals​(java.lang.Object o) 
      java.lang.StringgetFileId() 
      java.lang.StringgetFileName() 
      inthashCode() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2DeleteFileVersionResponse

        +
        public B2DeleteFileVersionResponse​(java.lang.String fileId,
        +                                   java.lang.String fileName)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      + + + +
        +
      • +

        getFileName

        +
        public java.lang.String getFileName()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2DeleteKeyRequest.Builder.html b/com/backblaze/b2/client/structures/B2DeleteKeyRequest.Builder.html new file mode 100644 index 000000000..823e888c9 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2DeleteKeyRequest.Builder.html @@ -0,0 +1,308 @@ + + + + + +B2DeleteKeyRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2DeleteKeyRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2DeleteKeyRequest
    +
    +
    +
    public static class B2DeleteKeyRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      Builder​(java.lang.String applicationKeyId) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder​(java.lang.String applicationKeyId)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2DeleteKeyRequest.html b/com/backblaze/b2/client/structures/B2DeleteKeyRequest.html new file mode 100644 index 000000000..7707823f7 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2DeleteKeyRequest.html @@ -0,0 +1,377 @@ + + + + + +B2DeleteKeyRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2DeleteKeyRequest

+
+
+ +
+
    +
  • +
    +
    public class B2DeleteKeyRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2DeleteKeyRequest

        +
        public B2DeleteKeyRequest​(java.lang.String applicationKeyId)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getApplicationKeyId

        +
        public java.lang.String getApplicationKeyId()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2DownloadAuthorization.html b/com/backblaze/b2/client/structures/B2DownloadAuthorization.html new file mode 100644 index 000000000..febc20351 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2DownloadAuthorization.html @@ -0,0 +1,336 @@ + + + + + +B2DownloadAuthorization (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2DownloadAuthorization

+
+
+ +
+
    +
  • +
    +
    public class B2DownloadAuthorization
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2DownloadAuthorization​(java.lang.String bucketId, + java.lang.String fileNamePrefix, + java.lang.String authorizationToken) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2DownloadAuthorization

        +
        public B2DownloadAuthorization​(java.lang.String bucketId,
        +                               java.lang.String fileNamePrefix,
        +                               java.lang.String authorizationToken)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getFileNamePrefix

        +
        public java.lang.String getFileNamePrefix()
        +
      • +
      + + + +
        +
      • +

        getAuthorizationToken

        +
        public java.lang.String getAuthorizationToken()
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2DownloadByIdRequest.Builder.html b/com/backblaze/b2/client/structures/B2DownloadByIdRequest.Builder.html new file mode 100644 index 000000000..a91b7ec35 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2DownloadByIdRequest.Builder.html @@ -0,0 +1,394 @@ + + + + + +B2DownloadByIdRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2DownloadByIdRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2DownloadByIdRequest
    +
    +
    +
    public static class B2DownloadByIdRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2DownloadByIdRequest.html b/com/backblaze/b2/client/structures/B2DownloadByIdRequest.html new file mode 100644 index 000000000..1b1395422 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2DownloadByIdRequest.html @@ -0,0 +1,478 @@ + + + + + +B2DownloadByIdRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2DownloadByIdRequest

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2DownloadByNameRequest.Builder.html b/com/backblaze/b2/client/structures/B2DownloadByNameRequest.Builder.html new file mode 100644 index 000000000..e051d53df --- /dev/null +++ b/com/backblaze/b2/client/structures/B2DownloadByNameRequest.Builder.html @@ -0,0 +1,394 @@ + + + + + +B2DownloadByNameRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2DownloadByNameRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2DownloadByNameRequest
    +
    +
    +
    public static class B2DownloadByNameRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2DownloadByNameRequest.html b/com/backblaze/b2/client/structures/B2DownloadByNameRequest.html new file mode 100644 index 000000000..6acbf62e3 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2DownloadByNameRequest.html @@ -0,0 +1,536 @@ + + + + + +B2DownloadByNameRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2DownloadByNameRequest

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketName

        +
        public java.lang.String getBucketName()
        +
      • +
      + + + +
        +
      • +

        getFileName

        +
        public java.lang.String getFileName()
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        getCustomerAlgorithm

        +
        public java.lang.String getCustomerAlgorithm()
        +
      • +
      + + + +
        +
      • +

        getCustomerKey

        +
        public java.lang.String getCustomerKey()
        +
      • +
      + + + +
        +
      • +

        getCustomerKeyMd5

        +
        public java.lang.String getCustomerKeyMd5()
        +
      • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ErrorStructure.html b/com/backblaze/b2/client/structures/B2ErrorStructure.html new file mode 100644 index 000000000..007b3132d --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ErrorStructure.html @@ -0,0 +1,356 @@ + + + + + +B2ErrorStructure (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ErrorStructure

+
+
+ +
+
    +
  • +
    +
    public class B2ErrorStructure
    +extends java.lang.Object
    +
    This structure describes the json that's returned by b2 for errors.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      java.lang.Stringcode +
      A single token that indicates the cause of the error.
      +
      java.lang.Stringmessage +
      A human-readable string giving details (if available) about what + went wrong.
      +
      intstatus +
      The HTTP status code being returned.
      +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2ErrorStructure​(int status, + java.lang.String code, + java.lang.String message) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        status

        +
        public final int status
        +
        The HTTP status code being returned. + + This is redundant with the status code in the header of the response, + but it's handy to have it here, to.
        +
      • +
      + + + +
        +
      • +

        code

        +
        public final java.lang.String code
        +
        A single token that indicates the cause of the error. If you + need to check for specific error returns, use this, not the message.
        +
      • +
      + + + +
        +
      • +

        message

        +
        public final java.lang.String message
        +
        A human-readable string giving details (if available) about what + went wrong.
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ErrorStructure

        +
        public B2ErrorStructure​(int status,
        +                        java.lang.String code,
        +                        java.lang.String message)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2EventNotification.html b/com/backblaze/b2/client/structures/B2EventNotification.html new file mode 100644 index 000000000..d6dd19934 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2EventNotification.html @@ -0,0 +1,486 @@ + + + + + +B2EventNotification (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2EventNotification

+
+
+ +
+
    +
  • +
    +
    public class B2EventNotification
    +extends java.lang.Object
    +
    The notification that Backblaze sends when object events occur.
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanequals​(java.lang.Object o) 
      java.util.List<B2EventNotificationEvent>getEvents() +
      A list of object events.
      +
      inthashCode() 
      static B2EventNotificationparse​(byte[] json) +
      Create a new EventNotification from JSON content with signature check.
      +
      static B2EventNotificationparse​(byte[] json, + java.lang.String signatureFromHeader, + java.lang.String signingSecret) +
      Create a new EventNotification from JSON content with signature check.
      +
      static B2EventNotificationparse​(java.lang.String json) +
      Create a new EventNotification from JSON content with signature check.
      +
      static B2EventNotificationparse​(java.lang.String json, + java.lang.String signatureFromHeader, + java.lang.String signingSecret) +
      Create a new EventNotification from JSON content with signature check.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        parse

        +
        public static B2EventNotification parse​(byte[] json)
        +                                 throws java.io.IOException,
        +                                        B2JsonException
        +
        Create a new EventNotification from JSON content with signature check.
        +
        +
        Parameters:
        +
        json - - The JSON content to create an B2EventNotification object from. The byte array should be UTF-8 encoded
        +
        Returns:
        +
        The B2EventNotification object
        +
        Throws:
        +
        B2JsonException - - If the content is not valid JSON
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        parse

        +
        public static B2EventNotification parse​(java.lang.String json)
        +                                 throws B2JsonException
        +
        Create a new EventNotification from JSON content with signature check.
        +
        +
        Parameters:
        +
        json - - The JSON content to create an B2EventNotification object from.
        +
        Returns:
        +
        The B2EventNotification object
        +
        Throws:
        +
        B2JsonException - - If the content is not valid JSON
        +
        +
      • +
      + + + +
        +
      • +

        parse

        +
        public static B2EventNotification parse​(byte[] json,
        +                                        java.lang.String signatureFromHeader,
        +                                        java.lang.String signingSecret)
        +                                 throws B2JsonException,
        +                                        java.io.IOException,
        +                                        B2SignatureVerificationException
        +
        Create a new EventNotification from JSON content with signature check.
        +
        +
        Parameters:
        +
        json - - The JSON content to create an B2EventNotification object from. The byte array should be UTF-8 encoded
        +
        signatureFromHeader - - The value of the X-Bz-Event-Notification-Signature header
        +
        signingSecret - - The secret for computing the signature.
        +
        Returns:
        +
        The B2EventNotification object
        +
        Throws:
        +
        B2JsonException - - If the content is not valid JSON
        +
        B2SignatureVerificationException - - if the content does not match the signature from header.
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        parse

        +
        public static B2EventNotification parse​(java.lang.String json,
        +                                        java.lang.String signatureFromHeader,
        +                                        java.lang.String signingSecret)
        +                                 throws B2JsonException,
        +                                        B2SignatureVerificationException
        +
        Create a new EventNotification from JSON content with signature check.
        +
        +
        Parameters:
        +
        json - - The JSON content to create an B2EventNotification object from.
        +
        signatureFromHeader - - The value of the X-Bz-Event-Notification-Signature header
        +
        signingSecret - - The secret for computing the signature.
        +
        Returns:
        +
        The B2EventNotification object
        +
        Throws:
        +
        B2JsonException - - If the content is not valid JSON
        +
        B2SignatureVerificationException - - if the content does not match the signature from header.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2EventNotificationEvent.html b/com/backblaze/b2/client/structures/B2EventNotificationEvent.html new file mode 100644 index 000000000..4371e61e3 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2EventNotificationEvent.html @@ -0,0 +1,554 @@ + + + + + +B2EventNotificationEvent (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2EventNotificationEvent

+
+
+ +
+
    +
  • +
    +
    public class B2EventNotificationEvent
    +extends java.lang.Object
    +
    The individual event notification for an object.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2EventNotificationEvent​(java.lang.String accountId, + java.lang.String bucketId, + java.lang.String bucketName, + long eventTimestamp, + java.lang.String eventType, + java.lang.String eventId, + int eventVersion, + java.lang.String matchedRuleName, + java.lang.String objectName, + java.lang.Long objectSize, + java.lang.String objectVersionId) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanequals​(java.lang.Object o) 
      java.lang.StringgetAccountId() +
      The ID of the account where the objects reside that corresponds to the event.
      +
      java.lang.StringgetBucketId() +
      The ID of the bucket where the objects reside that corresponds to the event.
      +
      java.lang.StringgetBucketName() +
      The name of the bucket where the objects reside that corresponds to the event.
      +
      java.lang.StringgetEventId() +
      The unique ID of the event.
      +
      longgetEventTimestamp() +
      The UTC time when this event was generated.
      +
      java.lang.StringgetEventType() +
      The event type of the event notification rule that corresponds to the event.
      +
      intgetEventVersion() +
      The version of the event notification payload.
      +
      java.lang.StringgetMatchedRuleName() +
      The name of the event notification rule the corresponds to the event.
      +
      java.lang.StringgetObjectName() +
      The name of the object that corresponds to the event.
      +
      java.lang.LonggetObjectSize() +
      The size of bytes of the object that corresponds to the event.
      +
      java.lang.StringgetObjectVersionId() +
      The unique identifier for the version of the object that corresponds to the event.
      +
      inthashCode() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2EventNotificationEvent

        +
        public B2EventNotificationEvent​(java.lang.String accountId,
        +                                java.lang.String bucketId,
        +                                java.lang.String bucketName,
        +                                long eventTimestamp,
        +                                java.lang.String eventType,
        +                                java.lang.String eventId,
        +                                int eventVersion,
        +                                java.lang.String matchedRuleName,
        +                                java.lang.String objectName,
        +                                java.lang.Long objectSize,
        +                                java.lang.String objectVersionId)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        getEventVersion

        +
        public int getEventVersion()
        +
        The version of the event notification payload.
        +
      • +
      + + + +
        +
      • +

        getMatchedRuleName

        +
        public java.lang.String getMatchedRuleName()
        +
        The name of the event notification rule the corresponds to the event.
        +
      • +
      + + + +
        +
      • +

        getBucketName

        +
        public java.lang.String getBucketName()
        +
        The name of the bucket where the objects reside that corresponds to the event.
        +
      • +
      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
        The ID of the bucket where the objects reside that corresponds to the event.
        +
      • +
      + + + +
        +
      • +

        getAccountId

        +
        public java.lang.String getAccountId()
        +
        The ID of the account where the objects reside that corresponds to the event.
        +
      • +
      + + + +
        +
      • +

        getEventTimestamp

        +
        public long getEventTimestamp()
        +
        The UTC time when this event was generated. It is a base 10 number of milliseconds since midnight, January 1, 1970 UTC.
        +
      • +
      + + + +
        +
      • +

        getEventType

        +
        public java.lang.String getEventType()
        +
        The event type of the event notification rule that corresponds to the event.
        +
      • +
      + + + +
        +
      • +

        getEventId

        +
        public java.lang.String getEventId()
        +
        The unique ID of the event.
        +
      • +
      + + + +
        +
      • +

        getObjectName

        +
        public java.lang.String getObjectName()
        +
        The name of the object that corresponds to the event. This will be null for test events.
        +
      • +
      + + + +
        +
      • +

        getObjectSize

        +
        public java.lang.Long getObjectSize()
        +
        The size of bytes of the object that corresponds to the event. The objectSize would be null for hide marker, + delete, and test events.
        +
      • +
      + + + +
        +
      • +

        getObjectVersionId

        +
        public java.lang.String getObjectVersionId()
        +
        The unique identifier for the version of the object that corresponds to the event. This will be null + for test events.
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2EventNotificationRule.html b/com/backblaze/b2/client/structures/B2EventNotificationRule.html new file mode 100644 index 000000000..e4e121227 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2EventNotificationRule.html @@ -0,0 +1,502 @@ + + + + + +B2EventNotificationRule (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2EventNotificationRule

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Comparable<B2EventNotificationRule>
    +
    +
    +
    public class B2EventNotificationRule
    +extends java.lang.Object
    +implements java.lang.Comparable<B2EventNotificationRule>
    +
    One rule about under what condition(s) to send notifications for events in a bucket.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2EventNotificationRule

        +
        public B2EventNotificationRule​(java.lang.String name,
        +                               java.util.TreeSet<java.lang.String> eventTypes,
        +                               java.lang.String objectNamePrefix,
        +                               B2EventNotificationTargetConfiguration targetConfiguration,
        +                               boolean isEnabled,
        +                               java.lang.Boolean isSuspended,
        +                               java.lang.String suspensionReason)
        +
      • +
      + + + +
        +
      • +

        B2EventNotificationRule

        +
        public B2EventNotificationRule​(java.lang.String name,
        +                               java.util.TreeSet<java.lang.String> eventTypes,
        +                               java.lang.String objectNamePrefix,
        +                               B2EventNotificationTargetConfiguration targetConfiguration,
        +                               boolean isEnabled)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
      • +
      + + + +
        +
      • +

        getEventTypes

        +
        public java.util.TreeSet<java.lang.String> getEventTypes()
        +
      • +
      + + + +
        +
      • +

        getObjectNamePrefix

        +
        public java.lang.String getObjectNamePrefix()
        +
      • +
      + + + + + + + +
        +
      • +

        isEnabled

        +
        public boolean isEnabled()
        +
      • +
      + + + +
        +
      • +

        isSuspended

        +
        public boolean isSuspended()
        +
      • +
      + + + +
        +
      • +

        getSuspensionReason

        +
        public java.lang.String getSuspensionReason()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        compareTo

        +
        public int compareTo​(B2EventNotificationRule r)
        +
        Rules are sorted by name first, and then additional attributes if necessary.
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<B2EventNotificationRule>
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2EventNotificationTargetConfiguration.html b/com/backblaze/b2/client/structures/B2EventNotificationTargetConfiguration.html new file mode 100644 index 000000000..20800fb59 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2EventNotificationTargetConfiguration.html @@ -0,0 +1,314 @@ + + + + + +B2EventNotificationTargetConfiguration (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2EventNotificationTargetConfiguration

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    B2WebhookConfiguration
    +
    +
    +
    public class B2EventNotificationTargetConfiguration
    +extends java.lang.Object
    +
    A destination for an event notification. Used in B2EventNotificationRule.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2EventNotificationTargetConfiguration

        +
        public B2EventNotificationTargetConfiguration()
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2FileRetention.html b/com/backblaze/b2/client/structures/B2FileRetention.html new file mode 100644 index 000000000..a87552cc5 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2FileRetention.html @@ -0,0 +1,442 @@ + + + + + +B2FileRetention (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2FileRetention

+
+
+ +
+
    +
  • +
    +
    public class B2FileRetention
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static B2FileRetentionNONE +
      static field for convenience to use with updateFileRetention() to turn off retention
      +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2FileRetention​(java.lang.String mode, + java.lang.Long retainUntilTimestamp) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        NONE

        +
        public static final B2FileRetention NONE
        +
        static field for convenience to use with updateFileRetention() to turn off retention
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2FileRetention

        +
        public B2FileRetention​(java.lang.String mode,
        +                       java.lang.Long retainUntilTimestamp)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileRetentionFromHeadersOrNull

        +
        public static B2FileRetention getFileRetentionFromHeadersOrNull​(B2Headers headers)
        +
        Construct a B2FileRetention from B2Headers, or null if the required headers are not present
        +
        +
        Parameters:
        +
        headers - B2Headers
        +
        Returns:
        +
        a new B2FileRetention or null
        +
        +
      • +
      + + + +
        +
      • +

        getMode

        +
        public java.lang.String getMode()
        +
      • +
      + + + +
        +
      • +

        getRetainUntilTimestamp

        +
        public java.lang.Long getRetainUntilTimestamp()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2FileRetentionMode.html b/com/backblaze/b2/client/structures/B2FileRetentionMode.html new file mode 100644 index 000000000..303547758 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2FileRetentionMode.html @@ -0,0 +1,265 @@ + + + + + +B2FileRetentionMode (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2FileRetentionMode

+
+
+
+
    +
  • +
    +
    public interface B2FileRetentionMode
    +
    B2FileRetentionMode provides constants for a bucket's default retention mode
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringCOMPLIANCE 
      static java.lang.StringGOVERNANCE 
      +
    • +
    +
    +
  • +
+
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2FileRetentionPeriodUnit.html b/com/backblaze/b2/client/structures/B2FileRetentionPeriodUnit.html new file mode 100644 index 000000000..c8eecc04c --- /dev/null +++ b/com/backblaze/b2/client/structures/B2FileRetentionPeriodUnit.html @@ -0,0 +1,265 @@ + + + + + +B2FileRetentionPeriodUnit (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2FileRetentionPeriodUnit

+
+
+
+
    +
  • +
    +
    public interface B2FileRetentionPeriodUnit
    +
    B2FileRetentionPeriodUnit provides constants for a bucket's default retention period
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringDAYS 
      static java.lang.StringYEARS 
      +
    • +
    +
    +
  • +
+
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2FileSseForRequest.html b/com/backblaze/b2/client/structures/B2FileSseForRequest.html new file mode 100644 index 000000000..2cc38ed32 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2FileSseForRequest.html @@ -0,0 +1,432 @@ + + + + + +B2FileSseForRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2FileSseForRequest

+
+
+ +
+
    +
  • +
    +
    public class B2FileSseForRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createSseB2Aes256

        +
        public static B2FileSseForRequest createSseB2Aes256()
        +
        Creates and returns a B2FileSseForRequest for SSE-B2 with algorithm set to AES256.
        +
        +
        Returns:
        +
        B2FileSseForRequest with mode=SSE-B2 and algorithm=AES256
        +
        +
      • +
      + + + +
        +
      • +

        createSseCAes256

        +
        public static B2FileSseForRequest createSseCAes256​(java.lang.String customerKey)
        +
        Creates and returns a B2FileSseForRequest for SSE-C with algorithm set to AES256 and encryption key as specified.
        +
        +
        Parameters:
        +
        customerKey - customer encryption key encoded in Base64
        +
        Returns:
        +
        B2FileSseForRequest with mode=SSE-C and algorithm=AES256 and customer key and MD5 set according to + input parameter.
        +
        +
      • +
      + + + +
        +
      • +

        createSseCAes256

        +
        public static B2FileSseForRequest createSseCAes256​(java.lang.String customerKey,
        +                                                   java.lang.String customerKeyMd5)
        +
        Creates and returns a B2FileSseForRequest for SSE-C with algorithm set to AES256 and key/MD5 as specified.
        +
        +
        Parameters:
        +
        customerKey - customer encryption key encoded in Base64
        +
        customerKeyMd5 - customer encryption key MD5 digest encoded in Base64
        +
        Returns:
        +
        B2FileSseForRequest with mode=SSE-C and algorithm=AES256 and customer key and MD5 set according to + input parameters.
        +
        +
      • +
      + + + +
        +
      • +

        getMode

        +
        public java.lang.String getMode()
        +
      • +
      + + + +
        +
      • +

        getAlgorithm

        +
        public java.lang.String getAlgorithm()
        +
      • +
      + + + +
        +
      • +

        getCustomerKey

        +
        public java.lang.String getCustomerKey()
        +
      • +
      + + + +
        +
      • +

        getCustomerKeyMd5

        +
        public java.lang.String getCustomerKeyMd5()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2FileSseForResponse.html b/com/backblaze/b2/client/structures/B2FileSseForResponse.html new file mode 100644 index 000000000..5a22680d5 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2FileSseForResponse.html @@ -0,0 +1,413 @@ + + + + + +B2FileSseForResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2FileSseForResponse

+
+
+ +
+
    +
  • +
    +
    public class B2FileSseForResponse
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2FileSseForResponse

        +
        public B2FileSseForResponse​(java.lang.String mode,
        +                            java.lang.String algorithm,
        +                            java.lang.String customerKeyMd5)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMode

        +
        public java.lang.String getMode()
        +
      • +
      + + + +
        +
      • +

        getAlgorithm

        +
        public java.lang.String getAlgorithm()
        +
      • +
      + + + +
        +
      • +

        getCustomerKeyMd5

        +
        public java.lang.String getCustomerKeyMd5()
        +
      • +
      + + + +
        +
      • +

        getEncryptionFromHeadersOrNull

        +
        public static B2FileSseForResponse getEncryptionFromHeadersOrNull​(B2Headers headers)
        +
        Construct a B2FileSseForResponse from B2Headers, or null if the required headers are not present
        +
        +
        Parameters:
        +
        headers - B2Headers
        +
        Returns:
        +
        a new B2FileSseForResponse or null
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2FileVersion.html b/com/backblaze/b2/client/structures/B2FileVersion.html new file mode 100644 index 000000000..b54829a64 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2FileVersion.html @@ -0,0 +1,794 @@ + + + + + +B2FileVersion (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2FileVersion

+
+
+ +
+
    +
  • +
    +
    public class B2FileVersion
    +extends java.lang.Object
    +
    Information about a file, as returned by the B2 API. + + The API returns two fields that are not included here: accountId and bucketId. + The reason for not including them is that this SDK also returns the same + structure from getFileInfoByName, which gets the info from the headers returned + by a HEAD request on the file, which do not include them.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2FileVersion

        +
        public B2FileVersion​(java.lang.String fileId,
        +                     java.lang.String fileName,
        +                     long contentLength,
        +                     java.lang.String contentType,
        +                     java.lang.String contentSha1,
        +                     java.lang.String contentMd5,
        +                     java.util.Map<java.lang.String,​java.lang.String> fileInfo,
        +                     java.lang.String action,
        +                     long uploadTimestamp,
        +                     B2AuthorizationFilteredResponseField<B2FileRetention> fileRetention,
        +                     B2AuthorizationFilteredResponseField<java.lang.String> legalHold,
        +                     B2FileSseForResponse serverSideEncryption,
        +                     java.lang.String replicationStatus)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      + + + +
        +
      • +

        getFileName

        +
        public java.lang.String getFileName()
        +
      • +
      + + + +
        +
      • +

        getContentLength

        +
        public long getContentLength()
        +
      • +
      + + + +
        +
      • +

        getContentType

        +
        public java.lang.String getContentType()
        +
      • +
      + + + +
        +
      • +

        getContentSha1

        +
        public java.lang.String getContentSha1()
        +
      • +
      + + + +
        +
      • +

        getContentMd5

        +
        public java.lang.String getContentMd5()
        +
      • +
      + + + +
        +
      • +

        getLargeFileSha1OrNull

        +
        public java.lang.String getLargeFileSha1OrNull()
        +
      • +
      + + + +
        +
      • +

        getFileInfo

        +
        public java.util.Map<java.lang.String,​java.lang.String> getFileInfo()
        +
      • +
      + + + +
        +
      • +

        getAction

        +
        public java.lang.String getAction()
        +
      • +
      + + + +
        +
      • +

        getUploadTimestamp

        +
        public long getUploadTimestamp()
        +
      • +
      + + + +
        +
      • +

        isClientAuthorizedToReadFileRetention

        +
        public boolean isClientAuthorizedToReadFileRetention()
        +
        Indicates whether or not the client is authorized to read the file retention + from this file version. If fileRetention field is null (e.g., for hidden + files and folders), then this method returns true.
        +
        +
        Returns:
        +
        true iff the client is authorized to read value of the file retention
        +
        +
      • +
      + + + +
        +
      • +

        getFileRetention

        +
        public B2FileRetention getFileRetention()
        +                                 throws B2ForbiddenException
        +
        Returns the file retention setting on the file version
        +
        +
        Returns:
        +
        the file retention settings of the file version
        +
        Throws:
        +
        B2ForbiddenException - if the client is not authorized to read the file retention setting
        +
        +
      • +
      + + + +
        +
      • +

        isClientAuthorizedToReadLegalHold

        +
        public boolean isClientAuthorizedToReadLegalHold()
        +
        Indicates whether or not the client is authorized to read the legal hold + status from this file version. If legalHold field is null (e.g., for hidden + files and folders), then this method returns true.
        +
        +
        Returns:
        +
        true iff the client is authorized to read value of the legal hold status
        +
        +
      • +
      + + + +
        +
      • +

        getLegalHold

        +
        public java.lang.String getLegalHold()
        +                              throws B2ForbiddenException
        +
        Returns the legal hold status on the file version
        +
        +
        Returns:
        +
        the legal hold status of the file version
        +
        Throws:
        +
        B2ForbiddenException - if the client is not authorized to read the legal hold status
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getReplicationStatus

        +
        public java.lang.String getReplicationStatus()
        +
      • +
      + + + +
        +
      • +

        isUpload

        +
        public boolean isUpload()
        +
      • +
      + + + +
        +
      • +

        isHide

        +
        public boolean isHide()
        +
      • +
      + + + +
        +
      • +

        isStart

        +
        public boolean isStart()
        +
      • +
      + + + +
        +
      • +

        isFolder

        +
        public boolean isFolder()
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2FinishLargeFileRequest.Builder.html b/com/backblaze/b2/client/structures/B2FinishLargeFileRequest.Builder.html new file mode 100644 index 000000000..23b88424d --- /dev/null +++ b/com/backblaze/b2/client/structures/B2FinishLargeFileRequest.Builder.html @@ -0,0 +1,310 @@ + + + + + +B2FinishLargeFileRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2FinishLargeFileRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2FinishLargeFileRequest
    +
    +
    +
    public static class B2FinishLargeFileRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      Builder​(java.lang.String fileId, + java.util.List<java.lang.String> partSha1Array) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder​(java.lang.String fileId,
        +               java.util.List<java.lang.String> partSha1Array)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2FinishLargeFileRequest.html b/com/backblaze/b2/client/structures/B2FinishLargeFileRequest.html new file mode 100644 index 000000000..ca36b4b3c --- /dev/null +++ b/com/backblaze/b2/client/structures/B2FinishLargeFileRequest.html @@ -0,0 +1,395 @@ + + + + + +B2FinishLargeFileRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2FinishLargeFileRequest

+
+
+ +
+
    +
  • +
    +
    public class B2FinishLargeFileRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2FinishLargeFileRequest

        +
        public B2FinishLargeFileRequest​(java.lang.String fileId,
        +                                java.util.List<java.lang.String> partSha1Array)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      + + + +
        +
      • +

        getPartSha1Array

        +
        public java.util.List<java.lang.String> getPartSha1Array()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2GetBucketNotificationRulesRequest.Builder.html b/com/backblaze/b2/client/structures/B2GetBucketNotificationRulesRequest.Builder.html new file mode 100644 index 000000000..8c0f7ec75 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2GetBucketNotificationRulesRequest.Builder.html @@ -0,0 +1,308 @@ + + + + + +B2GetBucketNotificationRulesRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2GetBucketNotificationRulesRequest.Builder

+
+
+ +
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      Builder​(java.lang.String bucketId) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2GetBucketNotificationRulesRequest.html b/com/backblaze/b2/client/structures/B2GetBucketNotificationRulesRequest.html new file mode 100644 index 000000000..702693bfd --- /dev/null +++ b/com/backblaze/b2/client/structures/B2GetBucketNotificationRulesRequest.html @@ -0,0 +1,355 @@ + + + + + +B2GetBucketNotificationRulesRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2GetBucketNotificationRulesRequest

+
+
+ +
+
    +
  • +
    +
    public class B2GetBucketNotificationRulesRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2GetBucketNotificationRulesResponse.Builder.html b/com/backblaze/b2/client/structures/B2GetBucketNotificationRulesResponse.Builder.html new file mode 100644 index 000000000..73b7cfeea --- /dev/null +++ b/com/backblaze/b2/client/structures/B2GetBucketNotificationRulesResponse.Builder.html @@ -0,0 +1,310 @@ + + + + + +B2GetBucketNotificationRulesResponse.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2GetBucketNotificationRulesResponse.Builder

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2GetBucketNotificationRulesResponse.html b/com/backblaze/b2/client/structures/B2GetBucketNotificationRulesResponse.html new file mode 100644 index 000000000..95dbde771 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2GetBucketNotificationRulesResponse.html @@ -0,0 +1,413 @@ + + + + + +B2GetBucketNotificationRulesResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2GetBucketNotificationRulesResponse

+
+
+ +
+
    +
  • +
    +
    public class B2GetBucketNotificationRulesResponse
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2GetBucketNotificationRulesResponse

        +
        public B2GetBucketNotificationRulesResponse​(java.lang.String bucketId,
        +                                            java.util.List<B2EventNotificationRule> eventNotificationRules)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2GetDownloadAuthorizationRequest.Builder.html b/com/backblaze/b2/client/structures/B2GetDownloadAuthorizationRequest.Builder.html new file mode 100644 index 000000000..9ffeede0a --- /dev/null +++ b/com/backblaze/b2/client/structures/B2GetDownloadAuthorizationRequest.Builder.html @@ -0,0 +1,410 @@ + + + + + +B2GetDownloadAuthorizationRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2GetDownloadAuthorizationRequest.Builder

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2GetDownloadAuthorizationRequest.html b/com/backblaze/b2/client/structures/B2GetDownloadAuthorizationRequest.html new file mode 100644 index 000000000..11f94e75c --- /dev/null +++ b/com/backblaze/b2/client/structures/B2GetDownloadAuthorizationRequest.html @@ -0,0 +1,453 @@ + + + + + +B2GetDownloadAuthorizationRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2GetDownloadAuthorizationRequest

+
+
+ +
+
    +
  • +
    +
    public class B2GetDownloadAuthorizationRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getFileNamePrefix

        +
        public java.lang.String getFileNamePrefix()
        +
      • +
      + + + +
        +
      • +

        getValidDurationInSeconds

        +
        public int getValidDurationInSeconds()
        +
      • +
      + + + +
        +
      • +

        getB2ContentDisposition

        +
        public java.lang.String getB2ContentDisposition()
        +
      • +
      + + + +
        +
      • +

        getB2ContentLanguage

        +
        public java.lang.String getB2ContentLanguage()
        +
      • +
      + + + +
        +
      • +

        getB2Expires

        +
        public java.lang.String getB2Expires()
        +
      • +
      + + + +
        +
      • +

        getB2CacheControl

        +
        public java.lang.String getB2CacheControl()
        +
      • +
      + + + +
        +
      • +

        getB2ContentEncoding

        +
        public java.lang.String getB2ContentEncoding()
        +
      • +
      + + + +
        +
      • +

        getB2ContentType

        +
        public java.lang.String getB2ContentType()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2GetFileInfoByNameRequest.Builder.html b/com/backblaze/b2/client/structures/B2GetFileInfoByNameRequest.Builder.html new file mode 100644 index 000000000..d9181b877 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2GetFileInfoByNameRequest.Builder.html @@ -0,0 +1,282 @@ + + + + + +B2GetFileInfoByNameRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2GetFileInfoByNameRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2GetFileInfoByNameRequest
    +
    +
    +
    public static class B2GetFileInfoByNameRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2GetFileInfoByNameRequest.html b/com/backblaze/b2/client/structures/B2GetFileInfoByNameRequest.html new file mode 100644 index 000000000..096f0d588 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2GetFileInfoByNameRequest.html @@ -0,0 +1,426 @@ + + + + + +B2GetFileInfoByNameRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2GetFileInfoByNameRequest

+
+
+ +
+
    +
  • +
    +
    public class B2GetFileInfoByNameRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2GetFileInfoByNameRequest

        +
        public B2GetFileInfoByNameRequest​(java.lang.String bucketName,
        +                                  java.lang.String fileName)
        +
      • +
      + + + +
        +
      • +

        B2GetFileInfoByNameRequest

        +
        public B2GetFileInfoByNameRequest​(java.lang.String bucketName,
        +                                  java.lang.String fileName,
        +                                  B2FileSseForRequest serverSideEncryption)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketName

        +
        public java.lang.String getBucketName()
        +
      • +
      + + + +
        +
      • +

        getFileName

        +
        public java.lang.String getFileName()
        +
      • +
      + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2GetFileInfoRequest.Builder.html b/com/backblaze/b2/client/structures/B2GetFileInfoRequest.Builder.html new file mode 100644 index 000000000..2290e0c99 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2GetFileInfoRequest.Builder.html @@ -0,0 +1,308 @@ + + + + + +B2GetFileInfoRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2GetFileInfoRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2GetFileInfoRequest
    +
    +
    +
    public static class B2GetFileInfoRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      Builder​(java.lang.String fileId) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder​(java.lang.String fileId)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2GetFileInfoRequest.html b/com/backblaze/b2/client/structures/B2GetFileInfoRequest.html new file mode 100644 index 000000000..f1d86aa15 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2GetFileInfoRequest.html @@ -0,0 +1,337 @@ + + + + + +B2GetFileInfoRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2GetFileInfoRequest

+
+
+ +
+
    +
  • +
    +
    public class B2GetFileInfoRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2GetUploadPartUrlRequest.Builder.html b/com/backblaze/b2/client/structures/B2GetUploadPartUrlRequest.Builder.html new file mode 100644 index 000000000..1e4789a23 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2GetUploadPartUrlRequest.Builder.html @@ -0,0 +1,308 @@ + + + + + +B2GetUploadPartUrlRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2GetUploadPartUrlRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2GetUploadPartUrlRequest
    +
    +
    +
    public static class B2GetUploadPartUrlRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      Builder​(java.lang.String fileId) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder​(java.lang.String fileId)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2GetUploadPartUrlRequest.html b/com/backblaze/b2/client/structures/B2GetUploadPartUrlRequest.html new file mode 100644 index 000000000..99354e6d8 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2GetUploadPartUrlRequest.html @@ -0,0 +1,337 @@ + + + + + +B2GetUploadPartUrlRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2GetUploadPartUrlRequest

+
+
+ +
+
    +
  • +
    +
    public class B2GetUploadPartUrlRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2GetUploadUrlRequest.Builder.html b/com/backblaze/b2/client/structures/B2GetUploadUrlRequest.Builder.html new file mode 100644 index 000000000..aba10ff83 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2GetUploadUrlRequest.Builder.html @@ -0,0 +1,308 @@ + + + + + +B2GetUploadUrlRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2GetUploadUrlRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2GetUploadUrlRequest
    +
    +
    +
    public static class B2GetUploadUrlRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      Builder​(java.lang.String bucketId) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder​(java.lang.String bucketId)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2GetUploadUrlRequest.html b/com/backblaze/b2/client/structures/B2GetUploadUrlRequest.html new file mode 100644 index 000000000..d5e8bf34c --- /dev/null +++ b/com/backblaze/b2/client/structures/B2GetUploadUrlRequest.html @@ -0,0 +1,337 @@ + + + + + +B2GetUploadUrlRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2GetUploadUrlRequest

+
+
+ +
+
    +
  • +
    +
    public class B2GetUploadUrlRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2HideFileRequest.Builder.html b/com/backblaze/b2/client/structures/B2HideFileRequest.Builder.html new file mode 100644 index 000000000..547579df0 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2HideFileRequest.Builder.html @@ -0,0 +1,310 @@ + + + + + +B2HideFileRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2HideFileRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2HideFileRequest
    +
    +
    +
    public static class B2HideFileRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      Builder​(java.lang.String bucketId, + java.lang.String fileName) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      B2HideFileRequestbuild() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder​(java.lang.String bucketId,
        +               java.lang.String fileName)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2HideFileRequest.html b/com/backblaze/b2/client/structures/B2HideFileRequest.html new file mode 100644 index 000000000..2812c640f --- /dev/null +++ b/com/backblaze/b2/client/structures/B2HideFileRequest.html @@ -0,0 +1,353 @@ + + + + + +B2HideFileRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2HideFileRequest

+
+
+ +
+
    +
  • +
    +
    public class B2HideFileRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getFileName

        +
        public java.lang.String getFileName()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        builder

        +
        public static B2HideFileRequest.Builder builder​(java.lang.String bucketId,
        +                                                java.lang.String fileName)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2LegalHold.html b/com/backblaze/b2/client/structures/B2LegalHold.html new file mode 100644 index 000000000..a3d9dbad9 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2LegalHold.html @@ -0,0 +1,271 @@ + + + + + +B2LegalHold (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2LegalHold

+
+
+
+
    +
  • +
    +
    public interface B2LegalHold
    +
    B2LegalHold provides constants for file lock legal hold
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringOFF +
      Legal hold is off (disabled)
      +
      static java.lang.StringON +
      Legal hold is on (enabled)
      +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2LifecycleRule.Builder.html b/com/backblaze/b2/client/structures/B2LifecycleRule.Builder.html new file mode 100644 index 000000000..7333b15f7 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2LifecycleRule.Builder.html @@ -0,0 +1,350 @@ + + + + + +B2LifecycleRule.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2LifecycleRule.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2LifecycleRule
    +
    +
    +
    public static class B2LifecycleRule.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder​(java.lang.String fileNamePrefix)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setDaysFromUploadingToHiding

        +
        public B2LifecycleRule.Builder setDaysFromUploadingToHiding​(java.lang.Integer daysFromUploadingToHiding)
        +
      • +
      + + + +
        +
      • +

        setDaysFromHidingToDeleting

        +
        public B2LifecycleRule.Builder setDaysFromHidingToDeleting​(java.lang.Integer daysFromHidingToDeleting)
        +
      • +
      + + + +
        +
      • +

        setDaysFromStartingToCancelingUnfinishedLargeFiles

        +
        public B2LifecycleRule.Builder setDaysFromStartingToCancelingUnfinishedLargeFiles​(java.lang.Integer daysFromStartingToCancelingUnfinishedLargeFiles)
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2LifecycleRule.html b/com/backblaze/b2/client/structures/B2LifecycleRule.html new file mode 100644 index 000000000..f533a1b39 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2LifecycleRule.html @@ -0,0 +1,398 @@ + + + + + +B2LifecycleRule (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2LifecycleRule

+
+
+ +
+
    +
  • +
    +
    public class B2LifecycleRule
    +extends java.lang.Object
    +
    One rule about when to delete files in a bucket.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getFileNamePrefix

        +
        public java.lang.String getFileNamePrefix()
        +
      • +
      + + + +
        +
      • +

        getDaysFromUploadingToHiding

        +
        public java.lang.Integer getDaysFromUploadingToHiding()
        +
      • +
      + + + +
        +
      • +

        getDaysFromHidingToDeleting

        +
        public java.lang.Integer getDaysFromHidingToDeleting()
        +
      • +
      + + + +
        +
      • +

        getDaysFromStartingToCancelingUnfinishedLargeFiles

        +
        public java.lang.Integer getDaysFromStartingToCancelingUnfinishedLargeFiles()
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListBucketsRequest.Builder.html b/com/backblaze/b2/client/structures/B2ListBucketsRequest.Builder.html new file mode 100644 index 000000000..3f74fb4f5 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListBucketsRequest.Builder.html @@ -0,0 +1,350 @@ + + + + + +B2ListBucketsRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListBucketsRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2ListBucketsRequest
    +
    +
    +
    public static class B2ListBucketsRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListBucketsRequest.html b/com/backblaze/b2/client/structures/B2ListBucketsRequest.html new file mode 100644 index 000000000..2076ee74b --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListBucketsRequest.html @@ -0,0 +1,379 @@ + + + + + +B2ListBucketsRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListBucketsRequest

+
+
+ +
+
    +
  • +
    +
    public class B2ListBucketsRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAccountId

        +
        public java.lang.String getAccountId()
        +
      • +
      + + + +
        +
      • +

        getBucketName

        +
        public java.lang.String getBucketName()
        +
      • +
      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getBucketTypes

        +
        public java.util.Set<java.lang.String> getBucketTypes()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListBucketsResponse.html b/com/backblaze/b2/client/structures/B2ListBucketsResponse.html new file mode 100644 index 000000000..9a98e6d81 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListBucketsResponse.html @@ -0,0 +1,340 @@ + + + + + +B2ListBucketsResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListBucketsResponse

+
+
+ +
+
    +
  • +
    +
    public class B2ListBucketsResponse
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanequals​(java.lang.Object o) 
      java.util.List<B2Bucket>getBuckets() 
      inthashCode() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ListBucketsResponse

        +
        public B2ListBucketsResponse​(java.util.List<B2Bucket> buckets)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBuckets

        +
        public java.util.List<B2Bucket> getBuckets()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListFileNamesRequest.Builder.html b/com/backblaze/b2/client/structures/B2ListFileNamesRequest.Builder.html new file mode 100644 index 000000000..8b3553522 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListFileNamesRequest.Builder.html @@ -0,0 +1,378 @@ + + + + + +B2ListFileNamesRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListFileNamesRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2ListFileNamesRequest
    +
    +
    +
    public static class B2ListFileNamesRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListFileNamesRequest.html b/com/backblaze/b2/client/structures/B2ListFileNamesRequest.html new file mode 100644 index 000000000..717368deb --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListFileNamesRequest.html @@ -0,0 +1,407 @@ + + + + + +B2ListFileNamesRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListFileNamesRequest

+
+
+ +
+
    +
  • +
    +
    public class B2ListFileNamesRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getStartFileName

        +
        public java.lang.String getStartFileName()
        +
      • +
      + + + +
        +
      • +

        getMaxFileCount

        +
        public java.lang.Integer getMaxFileCount()
        +
      • +
      + + + +
        +
      • +

        getPrefix

        +
        public java.lang.String getPrefix()
        +
      • +
      + + + +
        +
      • +

        getDelimiter

        +
        public java.lang.String getDelimiter()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListFileNamesResponse.html b/com/backblaze/b2/client/structures/B2ListFileNamesResponse.html new file mode 100644 index 000000000..453a71347 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListFileNamesResponse.html @@ -0,0 +1,387 @@ + + + + + +B2ListFileNamesResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListFileNamesResponse

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ListFileNamesResponse

        +
        public B2ListFileNamesResponse​(java.util.List<B2FileVersion> files,
        +                               java.lang.String nextFileName)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        atEnd

        +
        public boolean atEnd()
        +
        +
        Specified by:
        +
        atEnd in interface B2ListFilesResponse
        +
        Returns:
        +
        true iff this is the last set of responses.
        +
        +
      • +
      + + + +
        +
      • +

        getNextFileName

        +
        public java.lang.String getNextFileName()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListFileVersionsRequest.Builder.html b/com/backblaze/b2/client/structures/B2ListFileVersionsRequest.Builder.html new file mode 100644 index 000000000..4daac740d --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListFileVersionsRequest.Builder.html @@ -0,0 +1,394 @@ + + + + + +B2ListFileVersionsRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListFileVersionsRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2ListFileVersionsRequest
    +
    +
    +
    public static class B2ListFileVersionsRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListFileVersionsRequest.html b/com/backblaze/b2/client/structures/B2ListFileVersionsRequest.html new file mode 100644 index 000000000..40772641b --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListFileVersionsRequest.html @@ -0,0 +1,421 @@ + + + + + +B2ListFileVersionsRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListFileVersionsRequest

+
+
+ +
+
    +
  • +
    +
    public class B2ListFileVersionsRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getStartFileName

        +
        public java.lang.String getStartFileName()
        +
      • +
      + + + +
        +
      • +

        getStartFileId

        +
        public java.lang.String getStartFileId()
        +
      • +
      + + + +
        +
      • +

        getMaxFileCount

        +
        public java.lang.Integer getMaxFileCount()
        +
      • +
      + + + +
        +
      • +

        getPrefix

        +
        public java.lang.String getPrefix()
        +
      • +
      + + + +
        +
      • +

        getDelimiter

        +
        public java.lang.String getDelimiter()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListFileVersionsResponse.html b/com/backblaze/b2/client/structures/B2ListFileVersionsResponse.html new file mode 100644 index 000000000..661eb4ffd --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListFileVersionsResponse.html @@ -0,0 +1,403 @@ + + + + + +B2ListFileVersionsResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListFileVersionsResponse

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ListFileVersionsResponse

        +
        public B2ListFileVersionsResponse​(java.util.List<B2FileVersion> files,
        +                                  java.lang.String nextFileName,
        +                                  java.lang.String nextFileId)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        atEnd

        +
        public boolean atEnd()
        +
        +
        Specified by:
        +
        atEnd in interface B2ListFilesResponse
        +
        Returns:
        +
        true iff this is the last set of responses.
        +
        +
      • +
      + + + +
        +
      • +

        getNextFileName

        +
        public java.lang.String getNextFileName()
        +
      • +
      + + + +
        +
      • +

        getNextFileId

        +
        public java.lang.String getNextFileId()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListFilesResponse.html b/com/backblaze/b2/client/structures/B2ListFilesResponse.html new file mode 100644 index 000000000..841b5d2cb --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListFilesResponse.html @@ -0,0 +1,274 @@ + + + + + +B2ListFilesResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2ListFilesResponse

+
+
+
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFiles

        +
        java.util.List<B2FileVersion> getFiles()
        +
        +
        Returns:
        +
        the files in this response.
        +
        +
      • +
      + + + +
        +
      • +

        atEnd

        +
        boolean atEnd()
        +
        +
        Returns:
        +
        true iff this is the last set of responses.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListKeysRequest.Builder.html b/com/backblaze/b2/client/structures/B2ListKeysRequest.Builder.html new file mode 100644 index 000000000..870917b5f --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListKeysRequest.Builder.html @@ -0,0 +1,336 @@ + + + + + +B2ListKeysRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListKeysRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2ListKeysRequest
    +
    +
    +
    public static class B2ListKeysRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListKeysRequest.html b/com/backblaze/b2/client/structures/B2ListKeysRequest.html new file mode 100644 index 000000000..6b3b9063a --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListKeysRequest.html @@ -0,0 +1,393 @@ + + + + + +B2ListKeysRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListKeysRequest

+
+
+ +
+
    +
  • +
    +
    public class B2ListKeysRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ListKeysRequest

        +
        public B2ListKeysRequest​(java.lang.Integer maxKeyCount,
        +                         java.lang.String startApplicationKeyId)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMaxKeyCount

        +
        public java.lang.Integer getMaxKeyCount()
        +
      • +
      + + + +
        +
      • +

        getStartApplicationKeyId

        +
        public java.lang.String getStartApplicationKeyId()
        +
      • +
      + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListKeysRequestReal.html b/com/backblaze/b2/client/structures/B2ListKeysRequestReal.html new file mode 100644 index 000000000..dd89bcf46 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListKeysRequestReal.html @@ -0,0 +1,377 @@ + + + + + +B2ListKeysRequestReal (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListKeysRequestReal

+
+
+ +
+
    +
  • +
    +
    public class B2ListKeysRequestReal
    +extends java.lang.Object
    +
    NOTE: + B2ListKeysRequestReal has the attributes needed by the B2 API. That's why it's name ends with 'Real'. + Code that calls B2StorageClient uses B2ListKeysRequest (with no 'Real' at the end) instead. + The B2StorageClient creates a 'Real' request by adding the accountId to the non-real version before + sending it to the webifier.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2ListKeysRequestReal​(java.lang.String accountId, + java.lang.Integer maxKeyCount, + java.lang.String startApplicationKeyId) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ListKeysRequestReal

        +
        public B2ListKeysRequestReal​(java.lang.String accountId,
        +                             java.lang.Integer maxKeyCount,
        +                             java.lang.String startApplicationKeyId)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAccountId

        +
        public java.lang.String getAccountId()
        +
      • +
      + + + +
        +
      • +

        getMaxKeyCount

        +
        public java.lang.Integer getMaxKeyCount()
        +
      • +
      + + + +
        +
      • +

        getStartApplicationKeyId

        +
        public java.lang.String getStartApplicationKeyId()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListKeysResponse.html b/com/backblaze/b2/client/structures/B2ListKeysResponse.html new file mode 100644 index 000000000..e6923476b --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListKeysResponse.html @@ -0,0 +1,356 @@ + + + + + +B2ListKeysResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListKeysResponse

+
+
+ +
+
    +
  • +
    +
    public class B2ListKeysResponse
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ListKeysResponse

        +
        public B2ListKeysResponse​(java.util.List<B2ApplicationKey> keys,
        +                          java.lang.String nextApplicationKeyId)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getNextApplicationKeyId

        +
        public java.lang.String getNextApplicationKeyId()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListPartsRequest.Builder.html b/com/backblaze/b2/client/structures/B2ListPartsRequest.Builder.html new file mode 100644 index 000000000..a901f2e36 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListPartsRequest.Builder.html @@ -0,0 +1,349 @@ + + + + + +B2ListPartsRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListPartsRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2ListPartsRequest
    +
    +
    +
    public static class B2ListPartsRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListPartsRequest.html b/com/backblaze/b2/client/structures/B2ListPartsRequest.html new file mode 100644 index 000000000..54d240524 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListPartsRequest.html @@ -0,0 +1,423 @@ + + + + + +B2ListPartsRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListPartsRequest

+
+
+ +
+
    +
  • +
    +
    public class B2ListPartsRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ListPartsRequest

        +
        public B2ListPartsRequest​(java.lang.String fileId,
        +                          java.lang.Integer startPartNumber,
        +                          java.lang.Integer maxPartCount)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      + + + +
        +
      • +

        getStartPartNumber

        +
        public java.lang.Integer getStartPartNumber()
        +
      • +
      + + + +
        +
      • +

        getMaxPartCount

        +
        public java.lang.Integer getMaxPartCount()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListPartsResponse.html b/com/backblaze/b2/client/structures/B2ListPartsResponse.html new file mode 100644 index 000000000..ede60e7ed --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListPartsResponse.html @@ -0,0 +1,374 @@ + + + + + +B2ListPartsResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListPartsResponse

+
+
+ +
+
    +
  • +
    +
    public class B2ListPartsResponse
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2ListPartsResponse​(java.util.List<B2Part> parts, + java.lang.Integer nextPartNumber) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ListPartsResponse

        +
        public B2ListPartsResponse​(java.util.List<B2Part> parts,
        +                           java.lang.Integer nextPartNumber)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getParts

        +
        public java.util.List<B2Part> getParts()
        +
      • +
      + + + +
        +
      • +

        getNextPartNumber

        +
        public java.lang.Integer getNextPartNumber()
        +
      • +
      + + + +
        +
      • +

        atEnd

        +
        public boolean atEnd()
        +
        +
        Returns:
        +
        true iff this is the last set of responses.
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListUnfinishedLargeFilesRequest.Builder.html b/com/backblaze/b2/client/structures/B2ListUnfinishedLargeFilesRequest.Builder.html new file mode 100644 index 000000000..2aaac3181 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListUnfinishedLargeFilesRequest.Builder.html @@ -0,0 +1,363 @@ + + + + + +B2ListUnfinishedLargeFilesRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListUnfinishedLargeFilesRequest.Builder

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListUnfinishedLargeFilesRequest.html b/com/backblaze/b2/client/structures/B2ListUnfinishedLargeFilesRequest.html new file mode 100644 index 000000000..1c8c4911f --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListUnfinishedLargeFilesRequest.html @@ -0,0 +1,439 @@ + + + + + +B2ListUnfinishedLargeFilesRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListUnfinishedLargeFilesRequest

+
+
+ +
+
    +
  • +
    +
    public class B2ListUnfinishedLargeFilesRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ListUnfinishedLargeFilesRequest

        +
        public B2ListUnfinishedLargeFilesRequest​(java.lang.String bucketId,
        +                                         java.lang.String namePrefix,
        +                                         java.lang.String startFileId,
        +                                         java.lang.Integer maxFileCount)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getNamePrefix

        +
        public java.lang.String getNamePrefix()
        +
      • +
      + + + +
        +
      • +

        getStartFileId

        +
        public java.lang.String getStartFileId()
        +
      • +
      + + + +
        +
      • +

        getMaxFileCount

        +
        public java.lang.Integer getMaxFileCount()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ListUnfinishedLargeFilesResponse.html b/com/backblaze/b2/client/structures/B2ListUnfinishedLargeFilesResponse.html new file mode 100644 index 000000000..48c2b9100 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ListUnfinishedLargeFilesResponse.html @@ -0,0 +1,387 @@ + + + + + +B2ListUnfinishedLargeFilesResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ListUnfinishedLargeFilesResponse

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ListUnfinishedLargeFilesResponse

        +
        public B2ListUnfinishedLargeFilesResponse​(java.util.List<B2FileVersion> files,
        +                                          java.lang.String nextFileId)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        atEnd

        +
        public boolean atEnd()
        +
        +
        Specified by:
        +
        atEnd in interface B2ListFilesResponse
        +
        Returns:
        +
        true iff this is the last set of responses.
        +
        +
      • +
      + + + +
        +
      • +

        getNextFileId

        +
        public java.lang.String getNextFileId()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2OverrideableHeaders.html b/com/backblaze/b2/client/structures/B2OverrideableHeaders.html new file mode 100644 index 000000000..8a049efa0 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2OverrideableHeaders.html @@ -0,0 +1,323 @@ + + + + + +B2OverrideableHeaders (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2OverrideableHeaders

+
+
+
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getB2ContentDisposition

        +
        java.lang.String getB2ContentDisposition()
        +
      • +
      + + + +
        +
      • +

        getB2ContentLanguage

        +
        java.lang.String getB2ContentLanguage()
        +
      • +
      + + + +
        +
      • +

        getB2Expires

        +
        java.lang.String getB2Expires()
        +
      • +
      + + + +
        +
      • +

        getB2CacheControl

        +
        java.lang.String getB2CacheControl()
        +
      • +
      + + + +
        +
      • +

        getB2ContentEncoding

        +
        java.lang.String getB2ContentEncoding()
        +
      • +
      + + + +
        +
      • +

        getB2ContentType

        +
        java.lang.String getB2ContentType()
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2Part.html b/com/backblaze/b2/client/structures/B2Part.html new file mode 100644 index 000000000..a13195f57 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2Part.html @@ -0,0 +1,454 @@ + + + + + +B2Part (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2Part

+
+
+ +
+
    +
  • +
    +
    public class B2Part
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2Part

        +
        public B2Part​(java.lang.String fileId,
        +              int partNumber,
        +              long contentLength,
        +              java.lang.String contentSha1,
        +              java.lang.String contentMd5,
        +              long uploadTimestamp,
        +              B2FileSseForResponse serverSideEncryption)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      + + + +
        +
      • +

        getPartNumber

        +
        public int getPartNumber()
        +
      • +
      + + + +
        +
      • +

        getContentLength

        +
        public long getContentLength()
        +
      • +
      + + + +
        +
      • +

        getContentSha1

        +
        public java.lang.String getContentSha1()
        +
      • +
      + + + +
        +
      • +

        getContentMd5

        +
        public java.lang.String getContentMd5()
        +
      • +
      + + + +
        +
      • +

        getUploadTimestamp

        +
        public long getUploadTimestamp()
        +
      • +
      + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ReplicationRule.html b/com/backblaze/b2/client/structures/B2ReplicationRule.html new file mode 100644 index 000000000..163949f28 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ReplicationRule.html @@ -0,0 +1,443 @@ + + + + + +B2ReplicationRule (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ReplicationRule

+
+
+ +
+
    +
  • +
    +
    public class B2ReplicationRule
    +extends java.lang.Object
    +
    One rule about how files should be replicated + to the destination bucket.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2ReplicationRule​(java.lang.String replicationRuleName, + java.lang.String destinationBucketId, + int priority, + java.lang.String fileNamePrefix, + boolean isEnabled, + boolean includeExistingFiles) +
      Initializes a new, immutable rule.
      +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ReplicationRule

        +
        public B2ReplicationRule​(java.lang.String replicationRuleName,
        +                         java.lang.String destinationBucketId,
        +                         int priority,
        +                         java.lang.String fileNamePrefix,
        +                         boolean isEnabled,
        +                         boolean includeExistingFiles)
        +
        Initializes a new, immutable rule.
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getReplicationRuleName

        +
        public java.lang.String getReplicationRuleName()
        +
      • +
      + + + +
        +
      • +

        getDestinationBucketId

        +
        public java.lang.String getDestinationBucketId()
        +
      • +
      + + + +
        +
      • +

        getPriority

        +
        public int getPriority()
        +
      • +
      + + + +
        +
      • +

        getFileNamePrefix

        +
        public java.lang.String getFileNamePrefix()
        +
      • +
      + + + +
        +
      • +

        isEnabled

        +
        public boolean isEnabled()
        +
      • +
      + + + +
        +
      • +

        includeExistingFiles

        +
        public boolean includeExistingFiles()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ReplicationStatus.html b/com/backblaze/b2/client/structures/B2ReplicationStatus.html new file mode 100644 index 000000000..9adbf8b10 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ReplicationStatus.html @@ -0,0 +1,301 @@ + + + + + +B2ReplicationStatus (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2ReplicationStatus

+
+
+
+
    +
  • +
    +
    public interface B2ReplicationStatus
    +
    B2ReplicationStatus provides constants for cloud file replication
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringCOMPLETED 
      static java.lang.StringFAILED 
      static java.lang.StringPENDING 
      static java.lang.StringREPLICA 
      +
    • +
    +
    +
  • +
+
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2ServerSideEncryptionMode.html b/com/backblaze/b2/client/structures/B2ServerSideEncryptionMode.html new file mode 100644 index 000000000..404b0a61a --- /dev/null +++ b/com/backblaze/b2/client/structures/B2ServerSideEncryptionMode.html @@ -0,0 +1,265 @@ + + + + + +B2ServerSideEncryptionMode (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2ServerSideEncryptionMode

+
+
+
+
    +
  • +
    +
    public interface B2ServerSideEncryptionMode
    +
    B2ServerSideEncryptionMode provides constants for the Server-Side Encryption Modes
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringSSE_B2 
      static java.lang.StringSSE_C 
      +
    • +
    +
    +
  • +
+
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2SetBucketNotificationRulesRequest.Builder.html b/com/backblaze/b2/client/structures/B2SetBucketNotificationRulesRequest.Builder.html new file mode 100644 index 000000000..081a9953b --- /dev/null +++ b/com/backblaze/b2/client/structures/B2SetBucketNotificationRulesRequest.Builder.html @@ -0,0 +1,310 @@ + + + + + +B2SetBucketNotificationRulesRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2SetBucketNotificationRulesRequest.Builder

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2SetBucketNotificationRulesRequest.html b/com/backblaze/b2/client/structures/B2SetBucketNotificationRulesRequest.html new file mode 100644 index 000000000..397e6997a --- /dev/null +++ b/com/backblaze/b2/client/structures/B2SetBucketNotificationRulesRequest.html @@ -0,0 +1,371 @@ + + + + + +B2SetBucketNotificationRulesRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2SetBucketNotificationRulesRequest

+
+
+ +
+
    +
  • +
    +
    public class B2SetBucketNotificationRulesRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2SetBucketNotificationRulesResponse.Builder.html b/com/backblaze/b2/client/structures/B2SetBucketNotificationRulesResponse.Builder.html new file mode 100644 index 000000000..81e0807c7 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2SetBucketNotificationRulesResponse.Builder.html @@ -0,0 +1,310 @@ + + + + + +B2SetBucketNotificationRulesResponse.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2SetBucketNotificationRulesResponse.Builder

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2SetBucketNotificationRulesResponse.html b/com/backblaze/b2/client/structures/B2SetBucketNotificationRulesResponse.html new file mode 100644 index 000000000..0bd9a15f1 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2SetBucketNotificationRulesResponse.html @@ -0,0 +1,413 @@ + + + + + +B2SetBucketNotificationRulesResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2SetBucketNotificationRulesResponse

+
+
+ +
+
    +
  • +
    +
    public class B2SetBucketNotificationRulesResponse
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2SetBucketNotificationRulesResponse

        +
        public B2SetBucketNotificationRulesResponse​(java.lang.String bucketId,
        +                                            java.util.List<B2EventNotificationRule> eventNotificationRules)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2StartLargeFileRequest.Builder.html b/com/backblaze/b2/client/structures/B2StartLargeFileRequest.Builder.html new file mode 100644 index 000000000..303e14424 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2StartLargeFileRequest.Builder.html @@ -0,0 +1,389 @@ + + + + + +B2StartLargeFileRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2StartLargeFileRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2StartLargeFileRequest
    +
    +
    +
    public static class B2StartLargeFileRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2StartLargeFileRequest.html b/com/backblaze/b2/client/structures/B2StartLargeFileRequest.html new file mode 100644 index 000000000..54adc3d4e --- /dev/null +++ b/com/backblaze/b2/client/structures/B2StartLargeFileRequest.html @@ -0,0 +1,462 @@ + + + + + +B2StartLargeFileRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2StartLargeFileRequest

+
+
+ +
+
    +
  • +
    +
    public class B2StartLargeFileRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getFileName

        +
        public java.lang.String getFileName()
        +
      • +
      + + + +
        +
      • +

        getContentType

        +
        public java.lang.String getContentType()
        +
      • +
      + + + + + + + +
        +
      • +

        getFileInfo

        +
        public java.util.Map<java.lang.String,​java.lang.String> getFileInfo()
        +
      • +
      + + + + + + + +
        +
      • +

        getLegalHold

        +
        public java.lang.String getLegalHold()
        +
      • +
      + + + +
        +
      • +

        getCustomUploadTimestamp

        +
        public java.lang.Long getCustomUploadTimestamp()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + + + + +
        +
      • +

        builder

        +
        public static B2StartLargeFileRequest.Builder builder​(java.lang.String bucketId,
        +                                                      java.lang.String fileName,
        +                                                      java.lang.String contentType)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2StoreLargeFileRequest.Builder.html b/com/backblaze/b2/client/structures/B2StoreLargeFileRequest.Builder.html new file mode 100644 index 000000000..2f071c800 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2StoreLargeFileRequest.Builder.html @@ -0,0 +1,282 @@ + + + + + +B2StoreLargeFileRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2StoreLargeFileRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2StoreLargeFileRequest
    +
    +
    +
    public static class B2StoreLargeFileRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2StoreLargeFileRequest.html b/com/backblaze/b2/client/structures/B2StoreLargeFileRequest.html new file mode 100644 index 000000000..b8bb47021 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2StoreLargeFileRequest.html @@ -0,0 +1,387 @@ + + + + + +B2StoreLargeFileRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2StoreLargeFileRequest

+
+
+ +
+
    +
  • +
    +
    public class B2StoreLargeFileRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      + + + +
        +
      • +

        getFileVersion

        +
        @Deprecated
        +public B2FileVersion getFileVersion()
        +
        Deprecated.
        +
      • +
      + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2TestMode.html b/com/backblaze/b2/client/structures/B2TestMode.html new file mode 100644 index 000000000..597628326 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2TestMode.html @@ -0,0 +1,406 @@ + + + + + +B2TestMode (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Enum B2TestMode

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<B2TestMode>
    +
    +
    +
    public enum B2TestMode
    +extends java.lang.Enum<B2TestMode>
    +
    TestModes allow the client to ask the server to cause errors to help + with testing the client. Don't want to use them in your production + code.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        FAIL_SOME_UPLOADS

        +
        public static final B2TestMode FAIL_SOME_UPLOADS
        +
      • +
      + + + +
        +
      • +

        FORCE_CAP_EXCEEDED

        +
        public static final B2TestMode FORCE_CAP_EXCEEDED
        +
      • +
      + + + +
        +
      • +

        EXPIRE_SOME_ACCOUNT_AUTHORIZATION_TOKENS

        +
        public static final B2TestMode EXPIRE_SOME_ACCOUNT_AUTHORIZATION_TOKENS
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static B2TestMode[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (B2TestMode c : B2TestMode.values())
        +    System.out.println(c);
        +
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
      • +
      + + + +
        +
      • +

        valueOf

        +
        public static B2TestMode valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
      • +
      + + + +
        +
      • +

        getValueForHeader

        +
        public java.lang.String getValueForHeader()
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UpdateBucketRequest.Builder.html b/com/backblaze/b2/client/structures/B2UpdateBucketRequest.Builder.html new file mode 100644 index 000000000..609a8dec0 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UpdateBucketRequest.Builder.html @@ -0,0 +1,380 @@ + + + + + +B2UpdateBucketRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UpdateBucketRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2UpdateBucketRequest
    +
    +
    +
    public static class B2UpdateBucketRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UpdateBucketRequest.html b/com/backblaze/b2/client/structures/B2UpdateBucketRequest.html new file mode 100644 index 000000000..ac9037db1 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UpdateBucketRequest.html @@ -0,0 +1,477 @@ + + + + + +B2UpdateBucketRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UpdateBucketRequest

+
+
+ +
+
    +
  • +
    +
    public class B2UpdateBucketRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAccountId

        +
        public java.lang.String getAccountId()
        +
      • +
      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getBucketType

        +
        public java.lang.String getBucketType()
        +
      • +
      + + + +
        +
      • +

        getBucketInfo

        +
        public java.util.Map<java.lang.String,​java.lang.String> getBucketInfo()
        +
      • +
      + + + +
        +
      • +

        getCorsRules

        +
        public java.util.List<B2CorsRule> getCorsRules()
        +
      • +
      + + + +
        +
      • +

        getLifecycleRules

        +
        public java.util.List<B2LifecycleRule> getLifecycleRules()
        +
      • +
      + + + + + + + + + + + + + + + +
        +
      • +

        getFileLockEnabled

        +
        public java.lang.Boolean getFileLockEnabled()
        +
      • +
      + + + +
        +
      • +

        getIfRevisionIs

        +
        public java.lang.Integer getIfRevisionIs()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UpdateFileLegalHoldRequest.Builder.html b/com/backblaze/b2/client/structures/B2UpdateFileLegalHoldRequest.Builder.html new file mode 100644 index 000000000..5e463057c --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UpdateFileLegalHoldRequest.Builder.html @@ -0,0 +1,312 @@ + + + + + +B2UpdateFileLegalHoldRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UpdateFileLegalHoldRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2UpdateFileLegalHoldRequest
    +
    +
    +
    public static class B2UpdateFileLegalHoldRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      Builder​(java.lang.String fileName, + java.lang.String fileId, + java.lang.String legalHold) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder​(java.lang.String fileName,
        +               java.lang.String fileId,
        +               java.lang.String legalHold)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UpdateFileLegalHoldRequest.html b/com/backblaze/b2/client/structures/B2UpdateFileLegalHoldRequest.html new file mode 100644 index 000000000..d57ca50ea --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UpdateFileLegalHoldRequest.html @@ -0,0 +1,439 @@ + + + + + +B2UpdateFileLegalHoldRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UpdateFileLegalHoldRequest

+
+
+ +
+
    +
  • +
    +
    public class B2UpdateFileLegalHoldRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fileName

        +
        public final java.lang.String fileName
        +
      • +
      + + + +
        +
      • +

        fileId

        +
        public final java.lang.String fileId
        +
      • +
      + + + +
        +
      • +

        legalHold

        +
        public final java.lang.String legalHold
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileName

        +
        public java.lang.String getFileName()
        +
      • +
      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      + + + +
        +
      • +

        getLegalHold

        +
        public java.lang.String getLegalHold()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UpdateFileLegalHoldResponse.html b/com/backblaze/b2/client/structures/B2UpdateFileLegalHoldResponse.html new file mode 100644 index 000000000..dee1f5a70 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UpdateFileLegalHoldResponse.html @@ -0,0 +1,460 @@ + + + + + +B2UpdateFileLegalHoldResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UpdateFileLegalHoldResponse

+
+
+ +
+
    +
  • +
    +
    public class B2UpdateFileLegalHoldResponse
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      java.lang.StringfileId 
      java.lang.StringfileName 
      java.lang.StringlegalHold 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2UpdateFileLegalHoldResponse​(java.lang.String fileName, + java.lang.String fileId, + java.lang.String legalHold) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanequals​(java.lang.Object o) 
      java.lang.StringgetFileId() 
      java.lang.StringgetFileName() 
      java.lang.StringgetLegalHold() 
      inthashCode() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fileName

        +
        public final java.lang.String fileName
        +
      • +
      + + + +
        +
      • +

        fileId

        +
        public final java.lang.String fileId
        +
      • +
      + + + +
        +
      • +

        legalHold

        +
        public final java.lang.String legalHold
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2UpdateFileLegalHoldResponse

        +
        public B2UpdateFileLegalHoldResponse​(java.lang.String fileName,
        +                                     java.lang.String fileId,
        +                                     java.lang.String legalHold)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileName

        +
        public java.lang.String getFileName()
        +
      • +
      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      + + + +
        +
      • +

        getLegalHold

        +
        public java.lang.String getLegalHold()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UpdateFileRetentionRequest.Builder.html b/com/backblaze/b2/client/structures/B2UpdateFileRetentionRequest.Builder.html new file mode 100644 index 000000000..c0d6e0305 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UpdateFileRetentionRequest.Builder.html @@ -0,0 +1,326 @@ + + + + + +B2UpdateFileRetentionRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UpdateFileRetentionRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2UpdateFileRetentionRequest
    +
    +
    +
    public static class B2UpdateFileRetentionRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UpdateFileRetentionRequest.html b/com/backblaze/b2/client/structures/B2UpdateFileRetentionRequest.html new file mode 100644 index 000000000..bccdb1c8b --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UpdateFileRetentionRequest.html @@ -0,0 +1,467 @@ + + + + + +B2UpdateFileRetentionRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UpdateFileRetentionRequest

+
+
+ +
+
    +
  • +
    +
    public class B2UpdateFileRetentionRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fileName

        +
        public final java.lang.String fileName
        +
      • +
      + + + +
        +
      • +

        fileId

        +
        public final java.lang.String fileId
        +
      • +
      + + + +
        +
      • +

        bypassGovernance

        +
        public final boolean bypassGovernance
        +
      • +
      + + + + +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileName

        +
        public java.lang.String getFileName()
        +
      • +
      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      + + + +
        +
      • +

        isBypassGovernance

        +
        public boolean isBypassGovernance()
        +
      • +
      + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UpdateFileRetentionResponse.html b/com/backblaze/b2/client/structures/B2UpdateFileRetentionResponse.html new file mode 100644 index 000000000..0a99251c1 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UpdateFileRetentionResponse.html @@ -0,0 +1,460 @@ + + + + + +B2UpdateFileRetentionResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UpdateFileRetentionResponse

+
+
+ +
+
    +
  • +
    +
    public class B2UpdateFileRetentionResponse
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fileName

        +
        public final java.lang.String fileName
        +
      • +
      + + + +
        +
      • +

        fileId

        +
        public final java.lang.String fileId
        +
      • +
      + + + + +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2UpdateFileRetentionResponse

        +
        public B2UpdateFileRetentionResponse​(java.lang.String fileName,
        +                                     java.lang.String fileId,
        +                                     B2FileRetention fileRetention)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileName

        +
        public java.lang.String getFileName()
        +
      • +
      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UploadFileRequest.Builder.html b/com/backblaze/b2/client/structures/B2UploadFileRequest.Builder.html new file mode 100644 index 000000000..6e47f1c53 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UploadFileRequest.Builder.html @@ -0,0 +1,368 @@ + + + + + +B2UploadFileRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UploadFileRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2UploadFileRequest
    +
    +
    +
    public static class B2UploadFileRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UploadFileRequest.html b/com/backblaze/b2/client/structures/B2UploadFileRequest.html new file mode 100644 index 000000000..072a8b096 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UploadFileRequest.html @@ -0,0 +1,433 @@ + + + + + +B2UploadFileRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UploadFileRequest

+
+
+ +
+
    +
  • +
    +
    public class B2UploadFileRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getFileName

        +
        public java.lang.String getFileName()
        +
      • +
      + + + +
        +
      • +

        getContentType

        +
        public java.lang.String getContentType()
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        getLegalHold

        +
        public java.lang.String getLegalHold()
        +
      • +
      + + + + + + + +
        +
      • +

        getFileInfo

        +
        public java.util.Map<java.lang.String,​java.lang.String> getFileInfo()
        +
      • +
      + + + + + + + +
        +
      • +

        getCustomUploadTimestamp

        +
        public java.lang.Long getCustomUploadTimestamp()
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UploadListener.html b/com/backblaze/b2/client/structures/B2UploadListener.html new file mode 100644 index 000000000..8e3ec9ab7 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UploadListener.html @@ -0,0 +1,291 @@ + + + + + +B2UploadListener (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2UploadListener

+
+
+
+
    +
  • +
    +
    public interface B2UploadListener
    +
    A B2UploadListener is called by periodically by the upload processes to + provide an indication of progress. + + This interface is used for both small files and for large files. + In both cases, partIndex is zero-based. (Don't confuse partIndex with + a large file's part's partNumber.) For a small file, you'll only get + updates for partIndex=0 and partCount will always be 1. + For a large file with N parts, partIndex will range from 0 to N-1 and + partCount will always be N. + + You may be called with state FAILED more than once in a row as various + layers of the software notice the error. Further, because of the way + the SDK retries, you may see updates indicating progress and perhaps + even failure and then you may see updates showing one or more subsequent + attempts to upload the same content. + + THREAD-SAFETY: Listeners will be called from arbitrary threads and may be + called from multiple threads simultaneously. As a result, implementations + of B2UploadListener must be thread-safe. + + PERFORMANCE: do not do anything that might block the thread for any appreciable + amount of time. doing so will slow down the upload.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        progress

        +
        void progress​(B2UploadProgress progress)
        +
        Called with progress about an upload.
        +
      • +
      + + + +
        +
      • +

        noopListener

        +
        static B2UploadListener noopListener()
        +
        +
        Returns:
        +
        A listener that doesn't do anything when called.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UploadPartRequest.Builder.html b/com/backblaze/b2/client/structures/B2UploadPartRequest.Builder.html new file mode 100644 index 000000000..bbfbc2cf0 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UploadPartRequest.Builder.html @@ -0,0 +1,282 @@ + + + + + +B2UploadPartRequest.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UploadPartRequest.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2UploadPartRequest
    +
    +
    +
    public static class B2UploadPartRequest.Builder
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UploadPartRequest.html b/com/backblaze/b2/client/structures/B2UploadPartRequest.html new file mode 100644 index 000000000..c27ca3978 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UploadPartRequest.html @@ -0,0 +1,367 @@ + + + + + +B2UploadPartRequest (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UploadPartRequest

+
+
+ +
+
    +
  • +
    +
    public class B2UploadPartRequest
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPartNumber

        +
        public int getPartNumber()
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UploadPartUrlResponse.html b/com/backblaze/b2/client/structures/B2UploadPartUrlResponse.html new file mode 100644 index 000000000..99180ac7a --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UploadPartUrlResponse.html @@ -0,0 +1,372 @@ + + + + + +B2UploadPartUrlResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UploadPartUrlResponse

+
+
+ +
+
    +
  • +
    +
    public class B2UploadPartUrlResponse
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2UploadPartUrlResponse​(java.lang.String fileId, + java.lang.String uploadUrl, + java.lang.String authorizationToken) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2UploadPartUrlResponse

        +
        public B2UploadPartUrlResponse​(java.lang.String fileId,
        +                               java.lang.String uploadUrl,
        +                               java.lang.String authorizationToken)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getUploadUrl

        +
        public java.lang.String getUploadUrl()
        +
      • +
      + + + +
        +
      • +

        getAuthorizationToken

        +
        public java.lang.String getAuthorizationToken()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        getFileId

        +
        public java.lang.String getFileId()
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UploadProgress.html b/com/backblaze/b2/client/structures/B2UploadProgress.html new file mode 100644 index 000000000..a42554545 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UploadProgress.html @@ -0,0 +1,550 @@ + + + + + +B2UploadProgress (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UploadProgress

+
+
+ +
+
    +
  • +
    +
    public class B2UploadProgress
    +extends java.lang.Object
    +
    The B2UploadProgress summarizes the state of an upload. + It's a structure so we can extend it later, if needed. + + NOTE: the length field may sometimes be a little longer than you expect. + For example, if we're adding a SHA1 to the thing being uploaded, + the contentLength will be at least 40 bytes longer than you expect + because we're adding an ascii-hex-encoded SHA1. + + NOTE: when storing a large file that involves copying parts, it's not + possible to reliably compute the startByte for parts that come + after a copied part. As a result, these values will be set to + the constant UNKNOWN_PART_START_BYTE. + + Additionally, until copied parts are successfully stored and the + B2 API returns the corresponding B2Part, progress events for copied + parts will show the length as UNKNOWN_PART_SIZE_PLACEHOLDER. Once a copy succeeds, + the progress event for that success will contain the correct length.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        UNKNOWN_PART_SIZE_PLACEHOLDER

        +
        public static final long UNKNOWN_PART_SIZE_PLACEHOLDER
        +
        Placeholder value for part sizes that will not be known until the + part is stored in B2. For copy operations, we will not always know + the true part size until we receive the B2Part from b2_copy_part. + Unless the part being stored is 1 byte, using this value will lead + to underestimates on the progress percentage until the part is + properly stored.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
      • +
      + + + +
        +
      • +

        UNKNOWN_PART_START_BYTE

        +
        public static final long UNKNOWN_PART_START_BYTE
        +
        Constant value used to indicate that the starting byte position of + the part is unknown. This can happen when storing a large file + involves copy operations. Since the sizes of those parts will not + be known until they finish copying, parts that come after them + will have unknown starting positions in the final file.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2UploadProgress

        +
        public B2UploadProgress​(int partIndex,
        +                        int partCount,
        +                        long startByte,
        +                        long length,
        +                        long bytesSoFar,
        +                        B2UploadState state)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPartIndex

        +
        public int getPartIndex()
        +
      • +
      + + + +
        +
      • +

        getPartCount

        +
        public int getPartCount()
        +
      • +
      + + + +
        +
      • +

        isStartByteKnown

        +
        public boolean isStartByteKnown()
        +
      • +
      + + + +
        +
      • +

        getStartByte

        +
        public long getStartByte()
        +
      • +
      + + + +
        +
      • +

        getLength

        +
        public long getLength()
        +
      • +
      + + + +
        +
      • +

        getBytesSoFar

        +
        public long getBytesSoFar()
        +
      • +
      + + + + + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UploadState.html b/com/backblaze/b2/client/structures/B2UploadState.html new file mode 100644 index 000000000..541f4ac90 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UploadState.html @@ -0,0 +1,442 @@ + + + + + +B2UploadState (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Enum B2UploadState

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<B2UploadState>
    +
    +
    +
    public enum B2UploadState
    +extends java.lang.Enum<B2UploadState>
    +

    + Generally, uploads follow this state diagram: +

    +
    +   WAITING_TO_START--|
    +           |         |
    +           |         |
    +           v         |
    +        STARTING ----|
    +           |         |
    +           |         |
    +           v         |
    +        UPLOADING    |
    +        |       |    |
    +        |       |    |
    +        v       v    v
    +  SUCCEEDED     FAILED
    + 
    + Generally, the purpose of these updates is to provide high-level + progress information. Don't count on the rate at which you get the + updates and don't count on seeing all of them. For instance, if a + part of an upload succeeded previously, you may only see an update + for state SUCCEEDED. Similarly, if the upload is canceled violently + somehow you might not get any more updates. + + If the upload hits retryable errors, it may jump back to an earlier state + and the bytesSoFar may go back to zero. Attempt count will be incremented.
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static B2UploadStatevalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static B2UploadState[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static B2UploadState[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (B2UploadState c : B2UploadState.values())
        +    System.out.println(c);
        +
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
      • +
      + + + +
        +
      • +

        valueOf

        +
        public static B2UploadState valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2UploadUrlResponse.html b/com/backblaze/b2/client/structures/B2UploadUrlResponse.html new file mode 100644 index 000000000..e59784cdc --- /dev/null +++ b/com/backblaze/b2/client/structures/B2UploadUrlResponse.html @@ -0,0 +1,372 @@ + + + + + +B2UploadUrlResponse (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2UploadUrlResponse

+
+
+ +
+
    +
  • +
    +
    public class B2UploadUrlResponse
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2UploadUrlResponse​(java.lang.String bucketId, + java.lang.String uploadUrl, + java.lang.String authorizationToken) 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2UploadUrlResponse

        +
        public B2UploadUrlResponse​(java.lang.String bucketId,
        +                           java.lang.String uploadUrl,
        +                           java.lang.String authorizationToken)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBucketId

        +
        public java.lang.String getBucketId()
        +
      • +
      + + + +
        +
      • +

        getUploadUrl

        +
        public java.lang.String getUploadUrl()
        +
      • +
      + + + +
        +
      • +

        getAuthorizationToken

        +
        public java.lang.String getAuthorizationToken()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2WebhookConfiguration.html b/com/backblaze/b2/client/structures/B2WebhookConfiguration.html new file mode 100644 index 000000000..de4a380d3 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2WebhookConfiguration.html @@ -0,0 +1,446 @@ + + + + + +B2WebhookConfiguration (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2WebhookConfiguration

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2WebhookConfiguration

        +
        public B2WebhookConfiguration​(java.lang.String url,
        +                              java.util.TreeSet<B2WebhookCustomHeader> customHeaders,
        +                              java.lang.String hmacSha256SigningSecret)
        +
      • +
      + + + +
        +
      • +

        B2WebhookConfiguration

        +
        public B2WebhookConfiguration​(java.lang.String url)
        +
      • +
      + + + +
        +
      • +

        B2WebhookConfiguration

        +
        public B2WebhookConfiguration​(java.lang.String url,
        +                              java.util.TreeSet<B2WebhookCustomHeader> customHeaders)
        +
      • +
      + + + +
        +
      • +

        B2WebhookConfiguration

        +
        public B2WebhookConfiguration​(java.lang.String url,
        +                              java.lang.String hmacSha256SigningSecret)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getUrl

        +
        public java.lang.String getUrl()
        +
      • +
      + + + + + + + +
        +
      • +

        getHmacSha256SigningSecret

        +
        public java.lang.String getHmacSha256SigningSecret()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/B2WebhookCustomHeader.html b/com/backblaze/b2/client/structures/B2WebhookCustomHeader.html new file mode 100644 index 000000000..45cd986e2 --- /dev/null +++ b/com/backblaze/b2/client/structures/B2WebhookCustomHeader.html @@ -0,0 +1,401 @@ + + + + + +B2WebhookCustomHeader (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2WebhookCustomHeader

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Comparable<B2WebhookCustomHeader>
    +
    +
    +
    public class B2WebhookCustomHeader
    +extends java.lang.Object
    +implements java.lang.Comparable<B2WebhookCustomHeader>
    +
    Custom headers for B2WebhookConfiguration
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2WebhookCustomHeader​(java.lang.String name, + java.lang.String value) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      intcompareTo​(B2WebhookCustomHeader c) +
      B2CustomHeaders are sorted (without case sensitivity) by name first, and then value.
      +
      booleanequals​(java.lang.Object o) 
      java.lang.StringgetName() 
      java.lang.StringgetValue() 
      inthashCode() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2WebhookCustomHeader

        +
        public B2WebhookCustomHeader​(java.lang.String name,
        +                             java.lang.String value)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
      • +
      + + + +
        +
      • +

        getValue

        +
        public java.lang.String getValue()
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        compareTo

        +
        public int compareTo​(B2WebhookCustomHeader c)
        +
        B2CustomHeaders are sorted (without case sensitivity) by name first, and then value.
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<B2WebhookCustomHeader>
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/structures/package-summary.html b/com/backblaze/b2/client/structures/package-summary.html new file mode 100644 index 000000000..6bcb2ac06 --- /dev/null +++ b/com/backblaze/b2/client/structures/package-summary.html @@ -0,0 +1,762 @@ + + + + + +com.backblaze.b2.client.structures (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.backblaze.b2.client.structures

+
+
+ +
+
+ + + diff --git a/com/backblaze/b2/client/structures/package-tree.html b/com/backblaze/b2/client/structures/package-tree.html new file mode 100644 index 000000000..b30d1d911 --- /dev/null +++ b/com/backblaze/b2/client/structures/package-tree.html @@ -0,0 +1,309 @@ + + + + + +com.backblaze.b2.client.structures Class Hierarchy (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.backblaze.b2.client.structures

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Hierarchy

+
    +
  • java.lang.Object +
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
    • +
    +
  • +
+
+
+
+ + + diff --git a/com/backblaze/b2/client/webApiClients/B2WebApiClient.html b/com/backblaze/b2/client/webApiClients/B2WebApiClient.html new file mode 100644 index 000000000..48b95bcb5 --- /dev/null +++ b/com/backblaze/b2/client/webApiClients/B2WebApiClient.html @@ -0,0 +1,397 @@ + + + + + +B2WebApiClient (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2WebApiClient

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    public interface B2WebApiClient
    +extends java.lang.AutoCloseable
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      voidclose() +
      Closes this object and its underlying resources.
      +
      voidgetContent​(java.lang.String url, + B2Headers headersOrNull, + B2ContentSink handler) +
      GETs from a web service that returns content.
      +
      B2Headershead​(java.lang.String url, + B2Headers headersOrNull) +
      HEADSs to a web service that returns content, and returns the headers.
      +
      <ResponseType>
      ResponseType
      postDataReturnJson​(java.lang.String url, + B2Headers headersOrNull, + java.io.InputStream contentSource, + long contentLength, + java.lang.Class<ResponseType> responseClass) +
      POSTs to a web service that takes content and returns JSON.
      +
      <ResponseType>
      ResponseType
      postJsonReturnJson​(java.lang.String url, + B2Headers headersOrNull, + java.lang.Object request, + java.lang.Class<ResponseType> responseClass) +
      POSTs to a web service that takes JSON and returns JSON.
      +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        postJsonReturnJson

        +
        <ResponseType> ResponseType postJsonReturnJson​(java.lang.String url,
        +                                               B2Headers headersOrNull,
        +                                               java.lang.Object request,
        +                                               java.lang.Class<ResponseType> responseClass)
        +                                        throws B2Exception
        +
        POSTs to a web service that takes JSON and returns JSON.
        +
        +
        Type Parameters:
        +
        ResponseType - the class
        +
        Parameters:
        +
        url - the url to post to
        +
        headersOrNull - if non-null, some headers to include in the post
        +
        request - the object to be converted to json (with B2Json) and posted as the body of the request
        +
        responseClass - the class to convert the response body into (with B2Json)
        +
        Returns:
        +
        the response object (converted from json by B2Json)
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        postDataReturnJson

        +
        <ResponseType> ResponseType postDataReturnJson​(java.lang.String url,
        +                                               B2Headers headersOrNull,
        +                                               java.io.InputStream contentSource,
        +                                               long contentLength,
        +                                               java.lang.Class<ResponseType> responseClass)
        +                                        throws B2Exception
        +
        POSTs to a web service that takes content and returns JSON.
        +
        +
        Type Parameters:
        +
        ResponseType - the class
        +
        Parameters:
        +
        url - the url to post to
        +
        headersOrNull - if non-null, some headers to include in the post
        +
        contentSource - the content to post as the body of the request
        +
        contentLength - the number of bytes in the content to post
        +
        responseClass - the class to convert the response body into (with B2Json)
        +
        Returns:
        +
        the response object (converted from json by B2Json)
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        getContent

        +
        void getContent​(java.lang.String url,
        +                B2Headers headersOrNull,
        +                B2ContentSink handler)
        +         throws B2Exception
        +
        GETs from a web service that returns content.
        +
        +
        Parameters:
        +
        url - the url to post to
        +
        headersOrNull - if non-null, some headers to include in the post
        +
        handler - the object which will be called with the response's headers and content
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        head

        +
        B2Headers head​(java.lang.String url,
        +               B2Headers headersOrNull)
        +        throws B2Exception
        +
        HEADSs to a web service that returns content, and returns the headers.
        +
        +
        Parameters:
        +
        url - the url to head to
        +
        headersOrNull - the headers, if any.
        +
        Returns:
        +
        the headers of the response.
        +
        Throws:
        +
        B2Exception - if there's any trouble
        +
        +
      • +
      + + + +
        +
      • +

        close

        +
        void close()
        +
        Closes this object and its underlying resources. + This is overridden from AutoCloseable to declare that it can't throw any exception.
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/client/webApiClients/package-summary.html b/com/backblaze/b2/client/webApiClients/package-summary.html new file mode 100644 index 000000000..591c3c300 --- /dev/null +++ b/com/backblaze/b2/client/webApiClients/package-summary.html @@ -0,0 +1,164 @@ + + + + + +com.backblaze.b2.client.webApiClients (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.backblaze.b2.client.webApiClients

+
+
+ +
+
+ + + diff --git a/com/backblaze/b2/client/webApiClients/package-tree.html b/com/backblaze/b2/client/webApiClients/package-tree.html new file mode 100644 index 000000000..f41da6fed --- /dev/null +++ b/com/backblaze/b2/client/webApiClients/package-tree.html @@ -0,0 +1,161 @@ + + + + + +com.backblaze.b2.client.webApiClients Class Hierarchy (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.backblaze.b2.client.webApiClients

+Package Hierarchies: + +
+
+
+

Interface Hierarchy

+
    +
  • java.lang.AutoCloseable + +
  • +
+
+
+
+ + + diff --git a/com/backblaze/b2/json/B2Json.constructor.html b/com/backblaze/b2/json/B2Json.constructor.html new file mode 100644 index 000000000..82259515f --- /dev/null +++ b/com/backblaze/b2/json/B2Json.constructor.html @@ -0,0 +1,312 @@ + + + + + +B2Json.constructor (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Annotation Type B2Json.constructor

+
+
+
+
    +
  • +
    +
    @Retention(RUNTIME)
    +@Target(CONSTRUCTOR)
    +public static @interface B2Json.constructor
    +
    Constructor annotation saying that this is the constructor B2Json + should use. This constructor must take ALL of the serializable + fields as parameters. +

    + You must either compile classes with the '-parameters' javac option + or else provide a "params" parameter that lists the order of + the parameters to the constructor. +

    + If present, the "discards" parameter is a comma-separated list of + field names which are allowed to be present in the parsed json, + but whose values will be discarded. The names may be for fields + that don't exist or for fields marked @ignored. This is useful + for accepting deprecated fields without having to use + ALLOW_EXTRA_FIELDS, which would accept ALL unknown fields. +

    + When versionParam is non-empty, it is the name of a parameter that + is not a field name, and will take the version number being constructed. + This should be included for objects that have multiple versions, + and the code in the constructor should validate the data based on it.

    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional ElementDescription
      java.lang.Stringdiscards 
      java.lang.Stringparams +
      This is optional for classes compiled with the '-parameters' javac argument
      +
      java.lang.StringversionParam 
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        params

        +
        java.lang.String params
        +
        This is optional for classes compiled with the '-parameters' javac argument
        +
        +
        Default:
        +
        ""
        +
        +
      • +
      +
    • +
    +
    +
    +
      +
    • + + +
        +
      • +

        discards

        +
        java.lang.String discards
        +
        +
        Default:
        +
        ""
        +
        +
      • +
      +
    • +
    +
    +
    +
      +
    • + + +
        +
      • +

        versionParam

        +
        java.lang.String versionParam
        +
        +
        Default:
        +
        ""
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2Json.defaultForInvalidEnumValue.html b/com/backblaze/b2/json/B2Json.defaultForInvalidEnumValue.html new file mode 100644 index 000000000..8ff836d18 --- /dev/null +++ b/com/backblaze/b2/json/B2Json.defaultForInvalidEnumValue.html @@ -0,0 +1,190 @@ + + + + + +B2Json.defaultForInvalidEnumValue (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Annotation Type B2Json.defaultForInvalidEnumValue

+
+
+
+
    +
  • +
    +
    @Retention(RUNTIME)
    +@Target(FIELD)
    +public static @interface B2Json.defaultForInvalidEnumValue
    +
    Field annotation that designates the enum value to use when the + value in a field isn't one of the known values. Use this at most + once in an enum. If no values have this annotation, we will throw + a B2JsonException at runtime when we hit an invalid value.
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2Json.defaultForUnknownType.html b/com/backblaze/b2/json/B2Json.defaultForUnknownType.html new file mode 100644 index 000000000..b75270911 --- /dev/null +++ b/com/backblaze/b2/json/B2Json.defaultForUnknownType.html @@ -0,0 +1,243 @@ + + + + + +B2Json.defaultForUnknownType (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Annotation Type B2Json.defaultForUnknownType

+
+
+
+
    +
  • +
    +
    @Retention(RUNTIME)
    +@Target(TYPE)
    +public static @interface B2Json.defaultForUnknownType
    +

    Class annotation that applies to a class that is a @union.

    + +

    The value provided when de-serializing and the type is unknown.

    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired ElementDescription
      java.lang.Stringvalue 
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        java.lang.String value
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2Json.firstVersion.html b/com/backblaze/b2/json/B2Json.firstVersion.html new file mode 100644 index 000000000..1fc67ea40 --- /dev/null +++ b/com/backblaze/b2/json/B2Json.firstVersion.html @@ -0,0 +1,241 @@ + + + + + +B2Json.firstVersion (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Annotation Type B2Json.firstVersion

+
+
+
+
    +
  • +
    +
    @Retention(RUNTIME)
    +@Target(FIELD)
    +public static @interface B2Json.firstVersion
    +
    Annotation that says that a field exists in all versions at or after this one.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired ElementDescription
      intfirstVersion 
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        firstVersion

        +
        int firstVersion
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2Json.html b/com/backblaze/b2/json/B2Json.html new file mode 100644 index 000000000..4d4abf5ad --- /dev/null +++ b/com/backblaze/b2/json/B2Json.html @@ -0,0 +1,1470 @@ + + + + + +B2Json (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2Json

+
+
+ +
+
    +
  • +
    +
    public class B2Json
    +extends java.lang.Object
    +

    JSON (de)serialization of Java objects.

    + +

    This class knows how to take a Java object and turn it + into JSON, and then reverse the process and take JSON and create + a Java object.

    + +

    A number of classes are built in to B2Json. In addition to all + of the primitive types (byte, char, int, etc.) these classes are + all handled: Byte, Character, Integer, Long, Float, Double, Boolean, + String, LocalDate, LocalDateTime, and BigDecimal.

    + +

    For other classes to be used, you can either add a static getJsonTypeHandler() + method to it or add annotations to the class to say how it should go to JSON. + For classes without a getJsonTypeHandler() method, there must be a "required", + "optional", or "ignored" annotation on every field. And there must be exactly + one constructor with the "constructor" annotation.

    + +

    The selected constructor must take as arguments all of the non-ignored + fields in the object. If any validation of values needs to happen + during deserialization, it should happen in the constructor.

    + +

    During deserialization, an exception will be thrown if any required + fields are missing or null. Optional fields are set to 0/false/null + if they are not present in the JSON. If unexpected fields are present + in the JSON, they will cause an exception unless ALLOW_EXTRA_FIELDS + is selected.

    + +

    java.util.Map objects turn into JSON objects when serialized, and + java.util.List and java.util.Set objects turn into JSON arrays. On + deserialization, the values for Map fields are created as TreeMaps, + the values for List fields are created as ArrayLists, and the values for + Set fields are created as HashSets.

    + +

    The JSON produced is always "pretty", with newlines and indentation. + Field names are always sorted alphabetically.

    + +

    B2Json objects are THREAD SAFE.

    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClassDescription
      static interface B2Json.constructor +
      Constructor annotation saying that this is the constructor B2Json + should use.
      +
      static interface B2Json.defaultForInvalidEnumValue +
      Field annotation that designates the enum value to use when the + value in a field isn't one of the known values.
      +
      static interface B2Json.defaultForUnknownType +
      Class annotation that applies to a class that is a @union.
      +
      static interface B2Json.firstVersion +
      Annotation that says that a field exists in all versions at or after this one.
      +
      static interface B2Json.ignored +
      Field annotation that says the field is not included in JSON.
      +
      static interface B2Json.optional +
      Field annotation that says a field is optional.
      +
      static interface B2Json.optionalWithDefault +
      Field annotation that says a field is optional.
      +
      static interface B2Json.required +
      Field annotation that says a field is required to be present.
      +
      static interface B2Json.sensitive +
      Annotation that says this is a sensitive field and should be redacted when outputting + for logging
      +
      static interface B2Json.serializedName +
      Annotation to declare that this member will be serialized to JSON + with the specified name, instead of the field name in the Java class.
      +
      static interface B2Json.type +
      Type annotation used to configure B2Json serialization/deserialization.
      +
      static interface B2Json.union +
      Class annotation that says a class is the base class for a union type.
      +
      static interface B2Json.unionSubtypes +
      Class annotation that applies to an interface that is a @union.
      +
      static interface B2Json.versionRange +
      Annotation that says that a field exists in all versions in a range (inclusive).
      +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static intALLOW_EXTRA_FIELDS +
      Deprecated.
      +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethodDescription
      <T> TfromJson​(byte[] jsonUtf8Bytes, + java.lang.Class<T> clazz) +
      Parse JSON as an object of the given class.
      +
      <T> TfromJson​(byte[] jsonUtf8Bytes, + java.lang.Class<T> clazz, + int optionFlags) +
      Deprecated.
      +
      <T> TfromJson​(byte[] jsonUtf8Bytes, + java.lang.Class<T> clazz, + B2JsonOptions options) 
      <T> TfromJson​(java.io.InputStream in, + java.lang.Class<T> clazz) +
      Parse JSON as an object of the given class with the given options.
      +
      <T> TfromJson​(java.io.InputStream in, + java.lang.Class<T> clazz, + int optionFlags) +
      Deprecated.
      +
      <T> TfromJson​(java.io.InputStream in, + java.lang.reflect.Type type, + B2JsonOptions options) +
      Parse the bytes from an InputStream as JSON using the supplied options, returning the parsed object.
      +
      <T> TfromJson​(java.io.Reader reader, + java.lang.Class<T> clazz) +
      Parse JSON as an object of the given class with the given options.
      +
      <T> TfromJson​(java.io.Reader reader, + java.lang.reflect.Type type, + B2JsonOptions options) +
      Parse the bytes from a Reader as JSON using the supplied options, returning the parsed object.
      +
      <T> TfromJson​(java.lang.String json, + java.lang.Class<T> clazz) +
      Parse JSON as an object of the given class.
      +
      <T> TfromJson​(java.lang.String json, + java.lang.Class<T> clazz, + int optionFlags) +
      Deprecated.
      +
      <T> TfromJson​(java.lang.String json, + java.lang.Class<T> clazz, + B2JsonOptions options) 
      static <T> TfromJsonOrThrowRuntime​(java.lang.String json, + java.lang.Class<T> clazz) +
      Parse an assumed JSON string into a defined class.
      +
      static <T> TfromJsonOrThrowRuntime​(java.lang.String json, + java.lang.Class<T> clazz, + B2JsonOptions options) 
      <T> TfromJsonUntilEof​(java.io.InputStream in, + java.lang.Class<T> clazz) +
      Parse JSON as an object of the given class with the given options, + reading from the input stream until reaching EOF.
      +
      <T> TfromJsonUntilEof​(java.io.InputStream in, + java.lang.Class<T> clazz, + int optionFlags) +
      Deprecated.
      +
      <T> TfromJsonUntilEof​(java.io.InputStream in, + java.lang.Class<T> clazz, + B2JsonOptions options) 
      <T> TfromUrlParameterMap​(java.util.Map<java.lang.String,​java.lang.String> parameterMap, + java.lang.Class<T> clazz) +
      Parse a URL parameter map as an object of the given class.
      +
      <T> TfromUrlParameterMap​(java.util.Map<java.lang.String,​java.lang.String> parameterMap, + java.lang.Class<T> clazz, + int optionFlags) +
      Deprecated.
      +
      <T> TfromUrlParameterMap​(java.util.Map<java.lang.String,​java.lang.String> parameterMap, + java.lang.Class<T> clazz, + B2JsonOptions options) 
      static B2Jsonget() 
      <V> java.util.List<V>listFromJson​(java.lang.String json, + java.lang.Class<V> valueClass) +
      Parses a JSON object into a map.
      +
      <V> java.util.List<V>listFromJson​(java.lang.String json, + java.lang.Class<V> valueClass, + B2JsonOptions options) 
      java.lang.StringlistToJson​(java.util.List<?> list, + java.lang.Class<?> valueClass) +
      Turn a map into JSON, returning the result as a string.
      +
      java.lang.StringlistToJson​(java.util.List<?> list, + java.lang.Class<?> valueClass, + B2JsonOptions options) 
      <K,​V>
      java.util.Map<K,​V>
      mapFromJson​(java.lang.String json, + java.lang.Class<K> keyClass, + java.lang.Class<V> valueClass) +
      Parses a JSON object into a map.
      +
      <K,​V>
      java.util.Map<K,​V>
      mapFromJson​(java.lang.String json, + java.lang.Class<K> keyClass, + java.lang.Class<V> valueClass, + B2JsonOptions options) 
      java.lang.StringmapToJson​(java.util.Map<?,​?> map, + java.lang.Class<?> keyClass, + java.lang.Class<?> valueClass) +
      Turn a map into JSON, returning the result as a string.
      +
      java.lang.StringmapToJson​(java.util.Map<?,​?> map, + java.lang.Class<?> keyClass, + java.lang.Class<?> valueClass, + B2JsonOptions options) 
      java.lang.StringtoJson​(java.lang.Object obj) +
      Turn an object into JSON, returning the result as a string.
      +
      java.lang.StringtoJson​(java.lang.Object obj, + B2JsonOptions options) 
      voidtoJson​(java.lang.Object obj, + B2JsonOptions options, + java.io.OutputStream out) +
      Turn an object into JSON, writing the results to given output stream and + using the supplied options.
      +
      voidtoJson​(java.lang.Object obj, + B2JsonOptions options, + java.io.OutputStream out, + java.lang.reflect.Type objTypeOrNull) +
      Turn an object into JSON, writing the results to given + output stream.
      +
      voidtoJson​(java.lang.Object obj, + java.io.OutputStream out) +
      Turn an object into JSON, writing the results to given output stream.
      +
      static java.lang.StringtoJsonOrThrowRuntime​(java.lang.Object obj) +
      Turn an object into JSON, returning the result as a string.
      +
      static java.lang.StringtoJsonOrThrowRuntime​(java.lang.Object obj, + B2JsonOptions options) 
      byte[]toJsonUtf8Bytes​(java.lang.Object obj) +
      Turn an object into JSON, returning the result as an array of UTF-8 + bytes.
      +
      byte[]toJsonUtf8Bytes​(java.lang.Object obj, + B2JsonOptions options) 
      byte[]toJsonUtf8BytesWithNewline​(java.lang.Object obj) +
      Turn an object into JSON, returning the result as an array of UTF-8 + bytes.
      +
      byte[]toJsonUtf8BytesWithNewline​(java.lang.Object obj, + B2JsonOptions options) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        ALLOW_EXTRA_FIELDS

        +
        @Deprecated
        +public static final int ALLOW_EXTRA_FIELDS
        +
        Deprecated.
        +
        Bit map values for the options parameter to the constructor. +

        + Deprecated in favor of using B2JsonOptions.

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        get

        +
        public static B2Json get()
        +
        +
        Returns:
        +
        A shared instance.
        +
        +
      • +
      + + + +
        +
      • +

        toJsonUtf8Bytes

        +
        public byte[] toJsonUtf8Bytes​(java.lang.Object obj)
        +                       throws B2JsonException
        +
        Turn an object into JSON, returning the result as an array of UTF-8 + bytes.
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + + + + + +
        +
      • +

        toJsonUtf8BytesWithNewline

        +
        public byte[] toJsonUtf8BytesWithNewline​(java.lang.Object obj)
        +                                  throws B2JsonException
        +
        Turn an object into JSON, returning the result as an array of UTF-8 + bytes.
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + + + + + +
        +
      • +

        toJson

        +
        public void toJson​(java.lang.Object obj,
        +                   java.io.OutputStream out)
        +            throws java.io.IOException,
        +                   B2JsonException
        +
        Turn an object into JSON, writing the results to given output stream.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        toJson

        +
        public void toJson​(java.lang.Object obj,
        +                   B2JsonOptions options,
        +                   java.io.OutputStream out)
        +            throws java.io.IOException,
        +                   B2JsonException
        +
        Turn an object into JSON, writing the results to given output stream and + using the supplied options.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        toJson

        +
        public void toJson​(java.lang.Object obj,
        +                   B2JsonOptions options,
        +                   java.io.OutputStream out,
        +                   java.lang.reflect.Type objTypeOrNull)
        +            throws java.io.IOException,
        +                   B2JsonException
        +
        Turn an object into JSON, writing the results to given + output stream. +

        + objTypeOrNull can be set to null if obj is not a parameterized class. However, + if obj contains type parameters (like if obj is a List<String>, then + you will need to pass in its type information via objTypeOrNull. This will instruct + B2Json to derive the B2JsonTypeHandler from the type information instead of the + object's class. +

        + Getting the Type of obj can be done in at least two ways: + 1. If it is a member of an enclosing class, EnclosingClass.getDeclaredField(...).getGenericType() + 2. By constructing a class that implements Type. +

        + Note that the output stream is NOT closed as a side-effect of calling this. + It was a bug that it was being closed in version 1.1.1 and earlier.

        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        toJson

        +
        public java.lang.String toJson​(java.lang.Object obj)
        +                        throws B2JsonException
        +
        Turn an object into JSON, returning the result as a string.
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + + + + + +
        +
      • +

        toJsonOrThrowRuntime

        +
        public static java.lang.String toJsonOrThrowRuntime​(java.lang.Object obj)
        +
        Turn an object into JSON, returning the result as a string. + This throws a RuntimeException instead of a B2JsonException, + so use it carefully.
        +
      • +
      + + + +
        +
      • +

        toJsonOrThrowRuntime

        +
        public static java.lang.String toJsonOrThrowRuntime​(java.lang.Object obj,
        +                                                    B2JsonOptions options)
        +
      • +
      + + + +
        +
      • +

        fromJsonOrThrowRuntime

        +
        public static <T> T fromJsonOrThrowRuntime​(java.lang.String json,
        +                                           java.lang.Class<T> clazz)
        +
        Parse an assumed JSON string into a defined class. + This throws a RuntimeException instead of a B2JsonException, + so use it carefully.
        +
        +
        Type Parameters:
        +
        T - The deserialized object casted to the specific type from clazz
        +
        Parameters:
        +
        json - JSON String to try and parse
        +
        clazz - Class to map the JSON String to.
        +
        Returns:
        +
        the object deserialized from the JSON String
        +
        +
      • +
      + + + +
        +
      • +

        fromJsonOrThrowRuntime

        +
        public static <T> T fromJsonOrThrowRuntime​(java.lang.String json,
        +                                           java.lang.Class<T> clazz,
        +                                           B2JsonOptions options)
        +
      • +
      + + + +
        +
      • +

        mapToJson

        +
        public java.lang.String mapToJson​(java.util.Map<?,​?> map,
        +                                  java.lang.Class<?> keyClass,
        +                                  java.lang.Class<?> valueClass)
        +                           throws B2JsonException
        +
        Turn a map into JSON, returning the result as a string.
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        mapToJson

        +
        public java.lang.String mapToJson​(java.util.Map<?,​?> map,
        +                                  java.lang.Class<?> keyClass,
        +                                  java.lang.Class<?> valueClass,
        +                                  B2JsonOptions options)
        +                           throws B2JsonException
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        mapFromJson

        +
        public <K,​V> java.util.Map<K,​V> mapFromJson​(java.lang.String json,
        +                                                        java.lang.Class<K> keyClass,
        +                                                        java.lang.Class<V> valueClass)
        +                                                 throws B2JsonException
        +
        Parses a JSON object into a map.
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        mapFromJson

        +
        public <K,​V> java.util.Map<K,​V> mapFromJson​(java.lang.String json,
        +                                                        java.lang.Class<K> keyClass,
        +                                                        java.lang.Class<V> valueClass,
        +                                                        B2JsonOptions options)
        +                                                 throws B2JsonException
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        listToJson

        +
        public java.lang.String listToJson​(java.util.List<?> list,
        +                                   java.lang.Class<?> valueClass)
        +                            throws B2JsonException
        +
        Turn a map into JSON, returning the result as a string.
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + + + + + +
        +
      • +

        listFromJson

        +
        public <V> java.util.List<V> listFromJson​(java.lang.String json,
        +                                          java.lang.Class<V> valueClass)
        +                                   throws B2JsonException
        +
        Parses a JSON object into a map.
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + + + + + +
        +
      • +

        fromJsonUntilEof

        +
        public <T> T fromJsonUntilEof​(java.io.InputStream in,
        +                              java.lang.Class<T> clazz)
        +                       throws java.io.IOException,
        +                              B2JsonException
        +
        Parse JSON as an object of the given class with the given options, + reading from the input stream until reaching EOF. Throws an error + if there is anything but whitespace after the JSON value.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        fromJsonUntilEof

        +
        @Deprecated
        +public <T> T fromJsonUntilEof​(java.io.InputStream in,
        +                              java.lang.Class<T> clazz,
        +                              int optionFlags)
        +                       throws java.io.IOException,
        +                              B2JsonException
        +
        Deprecated.
        +
        Use the call that takes B2JsonOptions, no this one with 'int optionFlags'.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        fromJsonUntilEof

        +
        public <T> T fromJsonUntilEof​(java.io.InputStream in,
        +                              java.lang.Class<T> clazz,
        +                              B2JsonOptions options)
        +                       throws java.io.IOException,
        +                              B2JsonException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        fromJson

        +
        public <T> T fromJson​(java.io.InputStream in,
        +                      java.lang.Class<T> clazz)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Parse JSON as an object of the given class with the given options.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        fromJson

        +
        @Deprecated
        +public <T> T fromJson​(java.io.InputStream in,
        +                      java.lang.Class<T> clazz,
        +                      int optionFlags)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Deprecated.
        +
        Use the call that takes B2JsonOptions, no this one with 'int optionFlags'.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        fromJson

        +
        public <T> T fromJson​(java.io.InputStream in,
        +                      java.lang.reflect.Type type,
        +                      B2JsonOptions options)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Parse the bytes from an InputStream as JSON using the supplied options, returning the parsed object. +

        + The Type parameter will usually be a class, which is straightforward to supply. However, + if you are trying to deserialize a parameterized type (like if obj is a + List<String>, then you will need to supply a proper Type instance. +

        + Getting the Type can be done in at least two ways: + 1. If it is a member of an enclosing class, EnclosingClass.getDeclaredField(...).getGenericType() + 2. By constructing a class that implements Type.

        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        fromJson

        +
        public <T> T fromJson​(java.io.Reader reader,
        +                      java.lang.Class<T> clazz)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Parse JSON as an object of the given class with the given options.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        fromJson

        +
        public <T> T fromJson​(java.io.Reader reader,
        +                      java.lang.reflect.Type type,
        +                      B2JsonOptions options)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Parse the bytes from a Reader as JSON using the supplied options, returning the parsed object. +

        + The Type parameter will usually be a class, which is straightforward to supply. However, + if you are trying to deserialize a parameterized type (for instance, if the object is a + List<String>), then you will need to supply a proper Type instance. +

        + Getting the Type can be done in at least two ways: + 1. If it is a member of an enclosing class, EnclosingClass.getDeclaredField(...).getGenericType() + 2. By constructing a class that implements Type.

        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        fromJson

        +
        public <T> T fromJson​(java.lang.String json,
        +                      java.lang.Class<T> clazz)
        +               throws B2JsonException
        +
        Parse JSON as an object of the given class.
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        fromJson

        +
        @Deprecated
        +public <T> T fromJson​(java.lang.String json,
        +                      java.lang.Class<T> clazz,
        +                      int optionFlags)
        +               throws B2JsonException
        +
        Deprecated.
        +
        Use the call that takes B2JsonOptions, no this one with 'int optionFlags'.
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + + + + + +
        +
      • +

        fromJson

        +
        public <T> T fromJson​(byte[] jsonUtf8Bytes,
        +                      java.lang.Class<T> clazz)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Parse JSON as an object of the given class.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        fromJson

        +
        @Deprecated
        +public <T> T fromJson​(byte[] jsonUtf8Bytes,
        +                      java.lang.Class<T> clazz,
        +                      int optionFlags)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Deprecated.
        +
        Use the call that takes B2JsonOptions, no this one with 'int optionFlags'.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        fromJson

        +
        public <T> T fromJson​(byte[] jsonUtf8Bytes,
        +                      java.lang.Class<T> clazz,
        +                      B2JsonOptions options)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        fromUrlParameterMap

        +
        public <T> T fromUrlParameterMap​(java.util.Map<java.lang.String,​java.lang.String> parameterMap,
        +                                 java.lang.Class<T> clazz)
        +                          throws java.io.IOException,
        +                                 B2JsonException
        +
        Parse a URL parameter map as an object of the given class. +

        + The values in the map are the values that will be used in the + object. The caller is responsible for URL-decoding them + before passing them to this method.

        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        fromUrlParameterMap

        +
        @Deprecated
        +public <T> T fromUrlParameterMap​(java.util.Map<java.lang.String,​java.lang.String> parameterMap,
        +                                 java.lang.Class<T> clazz,
        +                                 int optionFlags)
        +                          throws java.io.IOException,
        +                                 B2JsonException
        +
        Deprecated.
        +
        Use the call that takes B2JsonOptions, no this one with 'int optionFlags'.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        fromUrlParameterMap

        +
        public <T> T fromUrlParameterMap​(java.util.Map<java.lang.String,​java.lang.String> parameterMap,
        +                                 java.lang.Class<T> clazz,
        +                                 B2JsonOptions options)
        +                          throws java.io.IOException,
        +                                 B2JsonException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2Json.ignored.html b/com/backblaze/b2/json/B2Json.ignored.html new file mode 100644 index 000000000..80408cd39 --- /dev/null +++ b/com/backblaze/b2/json/B2Json.ignored.html @@ -0,0 +1,187 @@ + + + + + +B2Json.ignored (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Annotation Type B2Json.ignored

+
+
+
+
    +
  • +
    +
    @Retention(RUNTIME)
    +@Target(FIELD)
    +public static @interface B2Json.ignored
    +
    Field annotation that says the field is not included in JSON.
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2Json.optional.html b/com/backblaze/b2/json/B2Json.optional.html new file mode 100644 index 000000000..0cb7d7b3d --- /dev/null +++ b/com/backblaze/b2/json/B2Json.optional.html @@ -0,0 +1,284 @@ + + + + + +B2Json.optional (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Annotation Type B2Json.optional

+
+
+
+
    +
  • +
    +
    @Retention(RUNTIME)
    +@Target(FIELD)
    +public static @interface B2Json.optional
    +
    Field annotation that says a field is optional. + + The value will almost always be included when serializing, with + two exceptions. If omitNull is true and the value is null, it will + be left out of the serialized representation. Similarly, if omitZero + is true and the value is zero, it will be left out of the serialized + representation. Note that both omitNull and omitZero default to false. + + A B2JsonException is thrown when omitNull is set to true on a primitive field; + primitives are not nullable objects so omitNull does not apply. + Similarly, a B2JsonException is thrown when omitZero is set to true on a + field that's either non-numeric, non-primitive, or not built into B2Json. + Note that they can't both be used on the same field because one only works + on non-primitive fields and the other only works on primitive fields. + + When deserializing, null/false/0 will be passed to + the constructor if the value is not present in the JSON.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional ElementDescription
      booleanomitNull 
      booleanomitZero 
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        omitNull

        +
        boolean omitNull
        +
        +
        Default:
        +
        false
        +
        +
      • +
      +
    • +
    +
    +
    +
      +
    • + + +
        +
      • +

        omitZero

        +
        boolean omitZero
        +
        +
        Default:
        +
        false
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2Json.optionalWithDefault.html b/com/backblaze/b2/json/B2Json.optionalWithDefault.html new file mode 100644 index 000000000..90b91153d --- /dev/null +++ b/com/backblaze/b2/json/B2Json.optionalWithDefault.html @@ -0,0 +1,321 @@ + + + + + +B2Json.optionalWithDefault (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Annotation Type B2Json.optionalWithDefault

+
+
+
+
    +
  • +
    +
    @Retention(RUNTIME)
    +@Target(FIELD)
    +public static @interface B2Json.optionalWithDefault
    +
    Field annotation that says a field is optional. + When deserializing, the provided default value will be used. The default + provided should be the JSON form of the value, as a string. + + The value will almost always be included when serializing, with + two exceptions. If omitNull is true and the value is null, it will + be left out of the serialized representation. Similarly, if omitZero + is true and the value is zero, it will be left out of the serialized + representation. Note that both omitNull and omitZero default to false. + + A B2JsonException is thrown when omitNull is set to true on a primitive field; + primitives are not nullable objects so omitNull does not apply. + Similarly, a B2JsonException is thrown when omitZero is set to true on a + field that's either non-numeric, non-primitive, or not built into B2Json. + Note that they can't both be used on the same field because one only works + on non-primitive fields and the other only works on primitive fields.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired ElementDescription
      java.lang.StringdefaultValue 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional ElementDescription
      booleanomitNull 
      booleanomitZero 
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        defaultValue

        +
        java.lang.String defaultValue
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +
        +
      • +

        omitNull

        +
        boolean omitNull
        +
        +
        Default:
        +
        false
        +
        +
      • +
      +
    • +
    +
    +
    +
      +
    • + + +
        +
      • +

        omitZero

        +
        boolean omitZero
        +
        +
        Default:
        +
        false
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2Json.required.html b/com/backblaze/b2/json/B2Json.required.html new file mode 100644 index 000000000..74c5cc293 --- /dev/null +++ b/com/backblaze/b2/json/B2Json.required.html @@ -0,0 +1,187 @@ + + + + + +B2Json.required (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Annotation Type B2Json.required

+
+
+
+
    +
  • +
    +
    @Retention(RUNTIME)
    +@Target(FIELD)
    +public static @interface B2Json.required
    +
    Field annotation that says a field is required to be present.
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2Json.sensitive.html b/com/backblaze/b2/json/B2Json.sensitive.html new file mode 100644 index 000000000..c5425dedf --- /dev/null +++ b/com/backblaze/b2/json/B2Json.sensitive.html @@ -0,0 +1,188 @@ + + + + + +B2Json.sensitive (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Annotation Type B2Json.sensitive

+
+
+
+
    +
  • +
    +
    @Retention(RUNTIME)
    +@Target(FIELD)
    +public static @interface B2Json.sensitive
    +
    Annotation that says this is a sensitive field and should be redacted when outputting + for logging
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2Json.serializedName.html b/com/backblaze/b2/json/B2Json.serializedName.html new file mode 100644 index 000000000..16c0d1eae --- /dev/null +++ b/com/backblaze/b2/json/B2Json.serializedName.html @@ -0,0 +1,264 @@ + + + + + +B2Json.serializedName (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Annotation Type B2Json.serializedName

+
+
+
+
    +
  • +
    +
    @Retention(RUNTIME)
    +@Target(FIELD)
    +public static @interface B2Json.serializedName
    +
    Annotation to declare that this member will be serialized to JSON + with the specified name, instead of the field name in the Java class. +

    + The Java class's field name is used for the params list in the + B2Json.constructor annotation +

    + For example: +

    + class Example {
    +     @B2Json.serializedName(value = "@field")
    +      private String field;
    +
    +     @B2Json.constructor(params = "field")
    +      public Example(String field) {
    +          this.field = field;
    +      }
    + }
    + 
    + will serialize to the following JSON: +
    +     {
    +         "@field": "value"
    +     }
    + 
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired ElementDescription
      java.lang.Stringvalue 
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        java.lang.String value
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2Json.type.html b/com/backblaze/b2/json/B2Json.type.html new file mode 100644 index 000000000..9851b8336 --- /dev/null +++ b/com/backblaze/b2/json/B2Json.type.html @@ -0,0 +1,298 @@ + + + + + +B2Json.type (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Annotation Type B2Json.type

+
+
+
+
    +
  • +
    +
    @Retention(RUNTIME)
    +@Target(TYPE)
    +public static @interface B2Json.type
    +
    Type annotation used to configure B2Json serialization/deserialization. + + When versionParam is non-empty, it is the name of a parameter that + is not a field name, and will take the version number being constructed. + This should be included for objects that have multiple versions, + and the code in the constructor should validate the data based on it.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional ElementDescription
      java.lang.Stringdiscards +
      When discards is non-empty, is a comma-separated list of field names which are + allowed to be present in the parsed json, + but whose values will be discarded.
      +
      java.lang.StringversionParam +
      When versionParam is non-empty, it is the name of a parameter that + is not a field name, and will take the version number being constructed.
      +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        discards

        +
        java.lang.String discards
        +
        When discards is non-empty, is a comma-separated list of field names which are + allowed to be present in the parsed json, + but whose values will be discarded. The names may be for fields + that don't exist or for fields marked @ignored. This is useful + for accepting deprecated fields without having to use + ALLOW_EXTRA_FIELDS, which would accept ALL unknown fields.
        +
        +
        Returns:
        +
        A comma separated list of fields to discard, or an empty string
        +
        +
        +
        Default:
        +
        ""
        +
        +
      • +
      +
    • +
    +
    +
    +
      +
    • + + +
        +
      • +

        versionParam

        +
        java.lang.String versionParam
        +
        When versionParam is non-empty, it is the name of a parameter that + is not a field name, and will take the version number being constructed. + This should be included for objects that have multiple versions, + and the code in the constructor should validate the data based on it.
        +
        +
        Returns:
        +
        the version parameter if present, or an empty string
        +
        +
        +
        Default:
        +
        ""
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2Json.union.html b/com/backblaze/b2/json/B2Json.union.html new file mode 100644 index 000000000..f031306a9 --- /dev/null +++ b/com/backblaze/b2/json/B2Json.union.html @@ -0,0 +1,250 @@ + + + + + +B2Json.union (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Annotation Type B2Json.union

+
+
+
+
    +
  • +
    +
    @Retention(RUNTIME)
    +@Target(TYPE)
    +public static @interface B2Json.union
    +

    Class annotation that says a class is the base class for a union type.

    + +

    The class must not extend any other classes, but may implement interfaces. + It must have no B2Json field or constructor annotations

    + +

    Direct instances of this class cannot be (de)serialized. Instances of + subclasses can be.

    + +

    For now, the implementation of deserialization is INEFFICIENT, so union + types should be used only for small objects.

    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired ElementDescription
      java.lang.StringtypeField 
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        typeField

        +
        java.lang.String typeField
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2Json.unionSubtypes.html b/com/backblaze/b2/json/B2Json.unionSubtypes.html new file mode 100644 index 000000000..e5a139541 --- /dev/null +++ b/com/backblaze/b2/json/B2Json.unionSubtypes.html @@ -0,0 +1,243 @@ + + + + + +B2Json.unionSubtypes (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Annotation Type B2Json.unionSubtypes

+
+
+
+
    +
  • +
    +
    @Retention(RUNTIME)
    +@Target(TYPE)
    +public static @interface B2Json.unionSubtypes
    +

    Class annotation that applies to an interface that is a @union.

    + +

    Provides a mapping from type name to class

    +
  • +
+
+
+
    +
  • + +
    + +
    +
  • +
+
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2Json.unionSubtypes.type.html b/com/backblaze/b2/json/B2Json.unionSubtypes.type.html new file mode 100644 index 000000000..2c41be0ae --- /dev/null +++ b/com/backblaze/b2/json/B2Json.unionSubtypes.type.html @@ -0,0 +1,257 @@ + + + + + +B2Json.unionSubtypes.type (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Annotation Type B2Json.unionSubtypes.type

+
+
+
+
    +
  • +
    +
    public static @interface B2Json.unionSubtypes.type
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired ElementDescription
      java.lang.Class<?>clazz 
      java.lang.Stringname 
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        clazz

        +
        java.lang.Class<?> clazz
        +
      • +
      +
    • +
    +
    +
    +
      +
    • + + +
        +
      • +

        name

        +
        java.lang.String name
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2Json.versionRange.html b/com/backblaze/b2/json/B2Json.versionRange.html new file mode 100644 index 000000000..3c762c78b --- /dev/null +++ b/com/backblaze/b2/json/B2Json.versionRange.html @@ -0,0 +1,260 @@ + + + + + +B2Json.versionRange (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Annotation Type B2Json.versionRange

+
+
+
+
    +
  • +
    +
    @Retention(RUNTIME)
    +@Target(FIELD)
    +public static @interface B2Json.versionRange
    +
    Annotation that says that a field exists in all versions in a range (inclusive).
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired ElementDescription
      intfirstVersion 
      intlastVersion 
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        firstVersion

        +
        int firstVersion
        +
      • +
      +
    • +
    +
    +
    +
      +
    • + + +
        +
      • +

        lastVersion

        +
        int lastVersion
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonAtomicLongArrayHandler.html b/com/backblaze/b2/json/B2JsonAtomicLongArrayHandler.html new file mode 100644 index 000000000..4b63dbcd3 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonAtomicLongArrayHandler.html @@ -0,0 +1,436 @@ + + + + + +B2JsonAtomicLongArrayHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonAtomicLongArrayHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<java.util.concurrent.atomic.AtomicLongArray>
    +
    +
    +
    public class B2JsonAtomicLongArrayHandler
    +extends B2JsonNonUrlTypeHandler<java.util.concurrent.atomic.AtomicLongArray>
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonAtomicLongArrayHandler

        +
        public B2JsonAtomicLongArrayHandler​(B2JsonTypeHandler<java.lang.Long> itemHandler)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(java.util.concurrent.atomic.AtomicLongArray array,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public java.util.concurrent.atomic.AtomicLongArray deserialize​(B2JsonReader in,
        +                                                               B2JsonOptions options)
        +                                                        throws B2JsonException,
        +                                                               java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public java.util.concurrent.atomic.AtomicLongArray defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonBadValueException.html b/com/backblaze/b2/json/B2JsonBadValueException.html new file mode 100644 index 000000000..82e0877ac --- /dev/null +++ b/com/backblaze/b2/json/B2JsonBadValueException.html @@ -0,0 +1,313 @@ + + + + + +B2JsonBadValueException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonBadValueException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    public class B2JsonBadValueException
    +extends B2JsonException
    +
    Exception thrown when a value in a JSON object is bad, even though it + is valid JSON.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonBadValueException

        +
        public B2JsonBadValueException​(java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2JsonBadValueException

        +
        public B2JsonBadValueException​(java.lang.String message,
        +                               java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonBigDecimalHandler.html b/com/backblaze/b2/json/B2JsonBigDecimalHandler.html new file mode 100644 index 000000000..91a90420a --- /dev/null +++ b/com/backblaze/b2/json/B2JsonBigDecimalHandler.html @@ -0,0 +1,455 @@ + + + + + +B2JsonBigDecimalHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonBigDecimalHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<java.math.BigDecimal>
    +
    +
    +
    public class B2JsonBigDecimalHandler
    +extends java.lang.Object
    +implements B2JsonTypeHandler<java.math.BigDecimal>
    +
    (De)serializes BigDecimal objects.
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.math.BigDecimaldefaultValueForOptional() +
      Returns the default value to use when an optional field is not present.
      +
      java.math.BigDecimaldeserialize​(B2JsonReader in, + B2JsonOptions options) +
      Deserialize one object from a JSON input stream.
      +
      java.math.BigDecimaldeserializeUrlParam​(java.lang.String urlValue) +
      When an API is called with GET, this is used to deserialize one of the + values.
      +
      java.lang.reflect.TypegetHandledType() +
      What class does this handle?
      +
      booleanisStringInJson() +
      Does this type look like a string in JSON?
      +
      voidserialize​(java.math.BigDecimal obj, + B2JsonOptions options, + B2JsonWriter out) +
      Serialize one object of the class to a JSON output stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonBigDecimalHandler

        +
        public B2JsonBigDecimalHandler()
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonBigIntegerHandler.html b/com/backblaze/b2/json/B2JsonBigIntegerHandler.html new file mode 100644 index 000000000..059bfde08 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonBigIntegerHandler.html @@ -0,0 +1,455 @@ + + + + + +B2JsonBigIntegerHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonBigIntegerHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<java.math.BigInteger>
    +
    +
    +
    public class B2JsonBigIntegerHandler
    +extends java.lang.Object
    +implements B2JsonTypeHandler<java.math.BigInteger>
    +
    (De)serializes BigInteger objects.
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.math.BigIntegerdefaultValueForOptional() +
      Returns the default value to use when an optional field is not present.
      +
      java.math.BigIntegerdeserialize​(B2JsonReader in, + B2JsonOptions options) +
      Deserialize one object from a JSON input stream.
      +
      java.math.BigIntegerdeserializeUrlParam​(java.lang.String urlValue) +
      When an API is called with GET, this is used to deserialize one of the + values.
      +
      java.lang.reflect.TypegetHandledType() +
      What class does this handle?
      +
      booleanisStringInJson() +
      Does this type look like a string in JSON?
      +
      voidserialize​(java.math.BigInteger obj, + B2JsonOptions options, + B2JsonWriter out) +
      Serialize one object of the class to a JSON output stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonBigIntegerHandler

        +
        public B2JsonBigIntegerHandler()
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonBooleanArrayHandler.html b/com/backblaze/b2/json/B2JsonBooleanArrayHandler.html new file mode 100644 index 000000000..7ac54adec --- /dev/null +++ b/com/backblaze/b2/json/B2JsonBooleanArrayHandler.html @@ -0,0 +1,436 @@ + + + + + +B2JsonBooleanArrayHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonBooleanArrayHandler

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonBooleanArrayHandler

        +
        public B2JsonBooleanArrayHandler​(B2JsonTypeHandler itemHandler)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.Class<boolean[]> getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(boolean[] array,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public boolean[] deserialize​(B2JsonReader in,
        +                             B2JsonOptions options)
        +                      throws B2JsonException,
        +                             java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public boolean[] defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonBooleanHandler.html b/com/backblaze/b2/json/B2JsonBooleanHandler.html new file mode 100644 index 000000000..39fb33def --- /dev/null +++ b/com/backblaze/b2/json/B2JsonBooleanHandler.html @@ -0,0 +1,453 @@ + + + + + +B2JsonBooleanHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonBooleanHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<java.lang.Boolean>
    +
    +
    +
    public class B2JsonBooleanHandler
    +extends java.lang.Object
    +implements B2JsonTypeHandler<java.lang.Boolean>
    +
    (De)serializes Boolean objects.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2JsonBooleanHandler​(boolean isPrimitive) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.BooleandefaultValueForOptional() +
      Returns the default value to use when an optional field is not present.
      +
      java.lang.Booleandeserialize​(B2JsonReader in, + B2JsonOptions options) +
      Deserialize one object from a JSON input stream.
      +
      java.lang.BooleandeserializeUrlParam​(java.lang.String urlValue) +
      When an API is called with GET, this is used to deserialize one of the + values.
      +
      java.lang.reflect.TypegetHandledType() +
      What class does this handle?
      +
      booleanisStringInJson() +
      Does this type look like a string in JSON?
      +
      voidserialize​(java.lang.Boolean obj, + B2JsonOptions options, + B2JsonWriter out) +
      Serialize one object of the class to a JSON output stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonBooleanHandler

        +
        public B2JsonBooleanHandler​(boolean isPrimitive)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Specified by:
        +
        getHandledType in interface B2JsonTypeHandler<java.lang.Boolean>
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(java.lang.Boolean obj,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Specified by:
        +
        serialize in interface B2JsonTypeHandler<java.lang.Boolean>
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        defaultValueForOptional

        +
        public java.lang.Boolean defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
        +
        Specified by:
        +
        defaultValueForOptional in interface B2JsonTypeHandler<java.lang.Boolean>
        +
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
        +
        Specified by:
        +
        isStringInJson in interface B2JsonTypeHandler<java.lang.Boolean>
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonBoundedByteArrayOutputStream.html b/com/backblaze/b2/json/B2JsonBoundedByteArrayOutputStream.html new file mode 100644 index 000000000..8f711649d --- /dev/null +++ b/com/backblaze/b2/json/B2JsonBoundedByteArrayOutputStream.html @@ -0,0 +1,517 @@ + + + + + +B2JsonBoundedByteArrayOutputStream (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonBoundedByteArrayOutputStream

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
    +
    +
    +
    public class B2JsonBoundedByteArrayOutputStream
    +extends java.io.OutputStream
    +
    A B2Json implementation of OutputStream that + - stores stream content in a byte array + - expands capacity when needed (typically doubles) + - has an upper bound limit on output array size (max capacity) + - throws IOException if the max capacity threshold is crossed. + + The last behavior is different from standard Java ByteArrayOutputStream + Implementation where an OutOfMemoryError would be thrown. OutOfMemoryError + is typically interpreted as JVM running out of heap space, and JVM could be + killed if configured so. This may not be desired for Java applications + configured with heap space much larger than 2 GB, and such applications may + want to continue to run after catching this threshold-crossing exception. + + THREAD-SAFE
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static intSYSTEM_MAX_CAPACITY 
      +
    • +
    +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      intgetMaxCapacity() +
      returns the max capacity of output array
      +
      intgetSize() +
      returns the current output array size
      +
      byte[]toByteArray() +
      returns a copy of the output byte array
      +
      java.lang.StringtoString​(java.lang.String charsetName) +
      makes a new String by decoding the bytes in output array + using the specified charset.
      +
      voidwrite​(byte[] bytes, + int offset, + int length) +
      writes an array of bytes into the output array
      +
      voidwrite​(int i) +
      writes one byte into the output array
      +
      +
        +
      • + + +

        Methods inherited from class java.io.OutputStream

        +close, flush, nullOutputStream, write
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonBoundedByteArrayOutputStream

        +
        public B2JsonBoundedByteArrayOutputStream​(int maxCapacity)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        write

        +
        public void write​(int i)
        +           throws java.io.IOException
        +
        writes one byte into the output array
        +
        +
        Specified by:
        +
        write in class java.io.OutputStream
        +
        Parameters:
        +
        i - one byte
        +
        Throws:
        +
        java.io.IOException - if expanding capacity would cross + the maxCapacity threshold
        +
        +
      • +
      + + + +
        +
      • +

        write

        +
        public void write​(byte[] bytes,
        +                  int offset,
        +                  int length)
        +           throws java.io.IOException
        +
        writes an array of bytes into the output array
        +
        +
        Overrides:
        +
        write in class java.io.OutputStream
        +
        Parameters:
        +
        bytes - input array of bytes
        +
        offset - offset for the input array
        +
        length - number of bytes to write
        +
        Throws:
        +
        java.io.IOException - if expanding capacity would cross + the maxCapacity threshold
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString​(java.lang.String charsetName)
        +                          throws java.io.UnsupportedEncodingException
        +
        makes a new String by decoding the bytes in output array + using the specified charset.
        +
        +
        Parameters:
        +
        charsetName - the charset to be used in decoding
        +
        Returns:
        +
        the string representation of output bytes after decoding
        +
        Throws:
        +
        java.io.UnsupportedEncodingException - if the named charset is not supported
        +
        +
      • +
      + + + +
        +
      • +

        toByteArray

        +
        public byte[] toByteArray()
        +
        returns a copy of the output byte array
        +
        +
        Returns:
        +
        a copy of output buffer
        +
        +
      • +
      + + + +
        +
      • +

        getMaxCapacity

        +
        public int getMaxCapacity()
        +
        returns the max capacity of output array
        +
        +
        Returns:
        +
        the max capacity
        +
        +
      • +
      + + + +
        +
      • +

        getSize

        +
        public int getSize()
        +
        returns the current output array size
        +
        +
        Returns:
        +
        output output array size
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonByteArrayHandler.html b/com/backblaze/b2/json/B2JsonByteArrayHandler.html new file mode 100644 index 000000000..2f44a37dc --- /dev/null +++ b/com/backblaze/b2/json/B2JsonByteArrayHandler.html @@ -0,0 +1,436 @@ + + + + + +B2JsonByteArrayHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonByteArrayHandler

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonByteArrayHandler

        +
        public B2JsonByteArrayHandler​(B2JsonTypeHandler itemHandler)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(byte[] array,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public byte[] deserialize​(B2JsonReader in,
        +                          B2JsonOptions options)
        +                   throws B2JsonException,
        +                          java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public byte[] defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonByteHandler.html b/com/backblaze/b2/json/B2JsonByteHandler.html new file mode 100644 index 000000000..a7c7de8c7 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonByteHandler.html @@ -0,0 +1,453 @@ + + + + + +B2JsonByteHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonByteHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<java.lang.Byte>
    +
    +
    +
    public class B2JsonByteHandler
    +extends java.lang.Object
    +implements B2JsonTypeHandler<java.lang.Byte>
    +
    (De)serializes Byte objects.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2JsonByteHandler​(boolean isPrimitive) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.BytedefaultValueForOptional() +
      Returns the default value to use when an optional field is not present.
      +
      java.lang.Bytedeserialize​(B2JsonReader in, + B2JsonOptions options) +
      Deserialize one object from a JSON input stream.
      +
      java.lang.BytedeserializeUrlParam​(java.lang.String urlValue) +
      When an API is called with GET, this is used to deserialize one of the + values.
      +
      java.lang.reflect.TypegetHandledType() +
      What class does this handle?
      +
      booleanisStringInJson() +
      Does this type look like a string in JSON?
      +
      voidserialize​(java.lang.Byte obj, + B2JsonOptions options, + B2JsonWriter out) +
      Serialize one object of the class to a JSON output stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonByteHandler

        +
        public B2JsonByteHandler​(boolean isPrimitive)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonCharArrayHandler.html b/com/backblaze/b2/json/B2JsonCharArrayHandler.html new file mode 100644 index 000000000..dd448c5a4 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonCharArrayHandler.html @@ -0,0 +1,436 @@ + + + + + +B2JsonCharArrayHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonCharArrayHandler

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonCharArrayHandler

        +
        public B2JsonCharArrayHandler​(B2JsonTypeHandler itemHandler)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(char[] array,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public char[] deserialize​(B2JsonReader in,
        +                          B2JsonOptions options)
        +                   throws B2JsonException,
        +                          java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public char[] defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonCharSquenceHandler.html b/com/backblaze/b2/json/B2JsonCharSquenceHandler.html new file mode 100644 index 000000000..6ea5e20d7 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonCharSquenceHandler.html @@ -0,0 +1,458 @@ + + + + + +B2JsonCharSquenceHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonCharSquenceHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<java.lang.CharSequence>
    +
    +
    +
    public class B2JsonCharSquenceHandler
    +extends java.lang.Object
    +implements B2JsonTypeHandler<java.lang.CharSequence>
    +
    (De)serializes CharSequence objects + + When deserializing, the underlying concrete type is String and thus will allocate even + when the JSON input is a string.
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.CharSequencedefaultValueForOptional() +
      Returns the default value to use when an optional field is not present.
      +
      java.lang.CharSequencedeserialize​(B2JsonReader in, + B2JsonOptions options) +
      Deserialize one object from a JSON input stream.
      +
      java.lang.CharSequencedeserializeUrlParam​(java.lang.String urlValue) +
      When an API is called with GET, this is used to deserialize one of the + values.
      +
      java.lang.reflect.TypegetHandledType() +
      What class does this handle?
      +
      booleanisStringInJson() +
      Does this type look like a string in JSON?
      +
      voidserialize​(java.lang.CharSequence obj, + B2JsonOptions options, + B2JsonWriter out) +
      Serialize one object of the class to a JSON output stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonCharSquenceHandler

        +
        public B2JsonCharSquenceHandler()
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonCharacterHandler.html b/com/backblaze/b2/json/B2JsonCharacterHandler.html new file mode 100644 index 000000000..22600e1b8 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonCharacterHandler.html @@ -0,0 +1,453 @@ + + + + + +B2JsonCharacterHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonCharacterHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<java.lang.Character>
    +
    +
    +
    public class B2JsonCharacterHandler
    +extends java.lang.Object
    +implements B2JsonTypeHandler<java.lang.Character>
    +
    (De)serializes Character objects.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2JsonCharacterHandler​(boolean isPrimitive) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.CharacterdefaultValueForOptional() +
      Returns the default value to use when an optional field is not present.
      +
      java.lang.Characterdeserialize​(B2JsonReader in, + B2JsonOptions options) +
      Deserialize one object from a JSON input stream.
      +
      java.lang.CharacterdeserializeUrlParam​(java.lang.String urlValue) +
      When an API is called with GET, this is used to deserialize one of the + values.
      +
      java.lang.reflect.TypegetHandledType() +
      What class does this handle?
      +
      booleanisStringInJson() +
      Does this type look like a string in JSON?
      +
      voidserialize​(java.lang.Character obj, + B2JsonOptions options, + B2JsonWriter out) +
      Serialize one object of the class to a JSON output stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonCharacterHandler

        +
        public B2JsonCharacterHandler​(boolean isPrimitive)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Specified by:
        +
        getHandledType in interface B2JsonTypeHandler<java.lang.Character>
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(java.lang.Character obj,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Specified by:
        +
        serialize in interface B2JsonTypeHandler<java.lang.Character>
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        defaultValueForOptional

        +
        public java.lang.Character defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
        +
        Specified by:
        +
        defaultValueForOptional in interface B2JsonTypeHandler<java.lang.Character>
        +
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
        +
        Specified by:
        +
        isStringInJson in interface B2JsonTypeHandler<java.lang.Character>
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonConcurrentMapHandler.html b/com/backblaze/b2/json/B2JsonConcurrentMapHandler.html new file mode 100644 index 000000000..619cff69b --- /dev/null +++ b/com/backblaze/b2/json/B2JsonConcurrentMapHandler.html @@ -0,0 +1,443 @@ + + + + + +B2JsonConcurrentMapHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonConcurrentMapHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<java.util.concurrent.ConcurrentMap>
    +
    +
    +
    public class B2JsonConcurrentMapHandler
    +extends B2JsonNonUrlTypeHandler<java.util.concurrent.ConcurrentMap>
    +
  • +
+
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(java.util.concurrent.ConcurrentMap obj,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public java.util.concurrent.ConcurrentMap deserialize​(B2JsonReader in,
        +                                                      B2JsonOptions options)
        +                                               throws B2JsonException,
        +                                                      java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public java.util.concurrent.ConcurrentMap defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonDoubleArrayHandler.html b/com/backblaze/b2/json/B2JsonDoubleArrayHandler.html new file mode 100644 index 000000000..f596dbf5b --- /dev/null +++ b/com/backblaze/b2/json/B2JsonDoubleArrayHandler.html @@ -0,0 +1,436 @@ + + + + + +B2JsonDoubleArrayHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonDoubleArrayHandler

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonDoubleArrayHandler

        +
        public B2JsonDoubleArrayHandler​(B2JsonTypeHandler itemHandler)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(double[] array,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public double[] deserialize​(B2JsonReader in,
        +                            B2JsonOptions options)
        +                     throws B2JsonException,
        +                            java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public double[] defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonDoubleHandler.html b/com/backblaze/b2/json/B2JsonDoubleHandler.html new file mode 100644 index 000000000..a190e5ce7 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonDoubleHandler.html @@ -0,0 +1,453 @@ + + + + + +B2JsonDoubleHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonDoubleHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<java.lang.Double>
    +
    +
    +
    public class B2JsonDoubleHandler
    +extends java.lang.Object
    +implements B2JsonTypeHandler<java.lang.Double>
    +
    (De)serializes Double objects.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2JsonDoubleHandler​(boolean isPrimitive) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.DoubledefaultValueForOptional() +
      Returns the default value to use when an optional field is not present.
      +
      java.lang.Doubledeserialize​(B2JsonReader in, + B2JsonOptions options) +
      Deserialize one object from a JSON input stream.
      +
      java.lang.DoubledeserializeUrlParam​(java.lang.String str) +
      When an API is called with GET, this is used to deserialize one of the + values.
      +
      java.lang.reflect.TypegetHandledType() +
      What class does this handle?
      +
      booleanisStringInJson() +
      Does this type look like a string in JSON?
      +
      voidserialize​(java.lang.Double obj, + B2JsonOptions options, + B2JsonWriter out) +
      Serialize one object of the class to a JSON output stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonDoubleHandler

        +
        public B2JsonDoubleHandler​(boolean isPrimitive)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonEnumHandler.html b/com/backblaze/b2/json/B2JsonEnumHandler.html new file mode 100644 index 000000000..34f0cfe82 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonEnumHandler.html @@ -0,0 +1,461 @@ + + + + + +B2JsonEnumHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonEnumHandler<T>

+
+
+ +
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2JsonEnumHandler​(java.lang.Class<T> enumClass) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      TdefaultValueForOptional() +
      Returns the default value to use when an optional field is not present.
      +
      Tdeserialize​(B2JsonReader in, + B2JsonOptions options) +
      Deserialize one object from a JSON input stream.
      +
      TdeserializeUrlParam​(java.lang.String urlValue) +
      When an API is called with GET, this is used to deserialize one of the + values.
      +
      java.lang.reflect.TypegetHandledType() +
      What class does this handle?
      +
      booleanisStringInJson() +
      Does this type look like a string in JSON?
      +
      voidserialize​(T obj, + B2JsonOptions options, + B2JsonWriter out) +
      Serialize one object of the class to a JSON output stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonEnumSetHandler.html b/com/backblaze/b2/json/B2JsonEnumSetHandler.html new file mode 100644 index 000000000..966d1174c --- /dev/null +++ b/com/backblaze/b2/json/B2JsonEnumSetHandler.html @@ -0,0 +1,437 @@ + + + + + +B2JsonEnumSetHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonEnumSetHandler

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonEnumSetHandler

        +
        public B2JsonEnumSetHandler​(B2JsonTypeHandler itemHandler)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(java.util.EnumSet obj,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public java.util.EnumSet deserialize​(B2JsonReader in,
        +                                     B2JsonOptions options)
        +                              throws B2JsonException,
        +                                     java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public java.util.EnumSet defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonException.html b/com/backblaze/b2/json/B2JsonException.html new file mode 100644 index 000000000..45e5feb6d --- /dev/null +++ b/com/backblaze/b2/json/B2JsonException.html @@ -0,0 +1,311 @@ + + + + + +B2JsonException (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    B2JsonBadValueException
    +
    +
    +
    public class B2JsonException
    +extends java.lang.Exception
    +
    Exception thrown when there is a problem reading or writing JSON.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2JsonException​(java.lang.String message) 
      B2JsonException​(java.lang.String message, + java.lang.Throwable cause) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonException

        +
        public B2JsonException​(java.lang.String message)
        +
      • +
      + + + +
        +
      • +

        B2JsonException

        +
        public B2JsonException​(java.lang.String message,
        +                       java.lang.Throwable cause)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonFloatArrayHandler.html b/com/backblaze/b2/json/B2JsonFloatArrayHandler.html new file mode 100644 index 000000000..ddb967f45 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonFloatArrayHandler.html @@ -0,0 +1,436 @@ + + + + + +B2JsonFloatArrayHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonFloatArrayHandler

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonFloatArrayHandler

        +
        public B2JsonFloatArrayHandler​(B2JsonTypeHandler itemHandler)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(float[] array,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public float[] deserialize​(B2JsonReader in,
        +                           B2JsonOptions options)
        +                    throws B2JsonException,
        +                           java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public float[] defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonFloatHandler.html b/com/backblaze/b2/json/B2JsonFloatHandler.html new file mode 100644 index 000000000..be756d6dc --- /dev/null +++ b/com/backblaze/b2/json/B2JsonFloatHandler.html @@ -0,0 +1,453 @@ + + + + + +B2JsonFloatHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonFloatHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<java.lang.Float>
    +
    +
    +
    public class B2JsonFloatHandler
    +extends java.lang.Object
    +implements B2JsonTypeHandler<java.lang.Float>
    +
    (De)serializes Float objects.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2JsonFloatHandler​(boolean isPrimitive) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.FloatdefaultValueForOptional() +
      Returns the default value to use when an optional field is not present.
      +
      java.lang.Floatdeserialize​(B2JsonReader in, + B2JsonOptions options) +
      Deserialize one object from a JSON input stream.
      +
      java.lang.FloatdeserializeUrlParam​(java.lang.String urlValue) +
      When an API is called with GET, this is used to deserialize one of the + values.
      +
      java.lang.reflect.TypegetHandledType() +
      What class does this handle?
      +
      booleanisStringInJson() +
      Does this type look like a string in JSON?
      +
      voidserialize​(java.lang.Float obj, + B2JsonOptions options, + B2JsonWriter out) +
      Serialize one object of the class to a JSON output stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonFloatHandler

        +
        public B2JsonFloatHandler​(boolean isPrimitive)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonHandlerMap.html b/com/backblaze/b2/json/B2JsonHandlerMap.html new file mode 100644 index 000000000..28a60eb38 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonHandlerMap.html @@ -0,0 +1,327 @@ + + + + + +B2JsonHandlerMap (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonHandlerMap

+
+
+ +
+
    +
  • +
    +
    public class B2JsonHandlerMap
    +extends java.lang.Object
    +
    Holds a mapping from Class to B2JsonTypeHandler. +

    + The mapping starts out with initial contents, which must be ALL + of the non-default mappings that will be used. If any other + handlers are needed, the default B2JsonObjectHandler will be used + for that class. +

    + This class is THREAD SAFE.

    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2JsonHandlerMap() 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      <T> B2JsonTypeHandler<T>getHandler​(java.lang.reflect.Type type) +
      Gets the handler for a given class at the top level.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonHandlerMap

        +
        public B2JsonHandlerMap()
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandler

        +
        public <T> B2JsonTypeHandler<T> getHandler​(java.lang.reflect.Type type)
        +                                    throws B2JsonException
        +
        Gets the handler for a given class at the top level. +

        + This method is called when it's time to (de)serialize some JSON, from the + toJson() and fromJson() methods. It is not called by other handlers. When + one handler depends on another, it should call the getUninitializedHandler() + method from its own initialize() method. +

        + So, this method does NOT need to be re-entrant, and in fact we assume that it's not.

        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonInitializedTypeHandler.html b/com/backblaze/b2/json/B2JsonInitializedTypeHandler.html new file mode 100644 index 000000000..ad599b869 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonInitializedTypeHandler.html @@ -0,0 +1,375 @@ + + + + + +B2JsonInitializedTypeHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonInitializedTypeHandler<T>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<T>
    +
    +
    +
    Direct Known Subclasses:
    +
    B2JsonNonUrlTypeHandler, B2JsonTypeHandlerWithDefaults
    +
    +
    +
    public abstract class B2JsonInitializedTypeHandler<T>
    +extends java.lang.Object
    +implements B2JsonTypeHandler<T>
    +
    Base class for all implementations of B2JsonTypeHandler that have an initialize() method. +

    + (De)serialization is expected to be fast, so each implementation class gathers + information it needs when it's set up, so when it's time to run it has all of + the necessary information at hand. This gets tricky because dependencies between + handlers may have loops. +

    + The plan is to initialize in three phases: +

    + First, the constructor, which must not depend on any other handlers, and which + must gather all of the information that other handlers will need. +

    + Second, the initialize() method does any work that needs information from other + type handlers. +

    + Third, check the validity of default values, now that all type handlers have + gone through at least the second phase. +

    + All phases are protected by the lock on B2JsonHandlerMap, so they don't need to + lock, and the data they store in the object is guaranteed to be visible without + further locking. +

    + Methods that return data set during initialize() should include this check: +

    + Preconditions.checkState(isInitialized()); +

    + NOTE: adding the initialize() method to BzJsonTypeHandler would change the interface + and break any clients who have written their own handlers.

    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonInitializedTypeHandler

        +
        public B2JsonInitializedTypeHandler()
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initializeImplementation

        +
        protected void initializeImplementation​(B2JsonHandlerMap b2JsonHandlerMap)
        +                                 throws B2JsonException
        +
        Does any initialization specific to the concrete class. + + Override in classes that need to gather information from other handlers.
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        isInitialized

        +
        protected boolean isInitialized()
        +
        Has the initialize method run?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonIntArrayHandler.html b/com/backblaze/b2/json/B2JsonIntArrayHandler.html new file mode 100644 index 000000000..6189e67b9 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonIntArrayHandler.html @@ -0,0 +1,436 @@ + + + + + +B2JsonIntArrayHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonIntArrayHandler

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonIntArrayHandler

        +
        public B2JsonIntArrayHandler​(B2JsonTypeHandler itemHandler)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(int[] array,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public int[] deserialize​(B2JsonReader in,
        +                         B2JsonOptions options)
        +                  throws B2JsonException,
        +                         java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public int[] defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonIntegerHandler.html b/com/backblaze/b2/json/B2JsonIntegerHandler.html new file mode 100644 index 000000000..0fb92996a --- /dev/null +++ b/com/backblaze/b2/json/B2JsonIntegerHandler.html @@ -0,0 +1,453 @@ + + + + + +B2JsonIntegerHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonIntegerHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<java.lang.Integer>
    +
    +
    +
    public class B2JsonIntegerHandler
    +extends java.lang.Object
    +implements B2JsonTypeHandler<java.lang.Integer>
    +
    (De)serializes Integer objects.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2JsonIntegerHandler​(boolean isPrimitive) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.IntegerdefaultValueForOptional() +
      Returns the default value to use when an optional field is not present.
      +
      java.lang.Integerdeserialize​(B2JsonReader in, + B2JsonOptions options) +
      Deserialize one object from a JSON input stream.
      +
      java.lang.IntegerdeserializeUrlParam​(java.lang.String value) +
      When an API is called with GET, this is used to deserialize one of the + values.
      +
      java.lang.reflect.TypegetHandledType() +
      What class does this handle?
      +
      booleanisStringInJson() +
      Does this type look like a string in JSON?
      +
      voidserialize​(java.lang.Integer obj, + B2JsonOptions options, + B2JsonWriter out) +
      Serialize one object of the class to a JSON output stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonIntegerHandler

        +
        public B2JsonIntegerHandler​(boolean isPrimitive)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Specified by:
        +
        getHandledType in interface B2JsonTypeHandler<java.lang.Integer>
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(java.lang.Integer obj,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Specified by:
        +
        serialize in interface B2JsonTypeHandler<java.lang.Integer>
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        defaultValueForOptional

        +
        public java.lang.Integer defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
        +
        Specified by:
        +
        defaultValueForOptional in interface B2JsonTypeHandler<java.lang.Integer>
        +
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
        +
        Specified by:
        +
        isStringInJson in interface B2JsonTypeHandler<java.lang.Integer>
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonLinkedHashSetHandler.html b/com/backblaze/b2/json/B2JsonLinkedHashSetHandler.html new file mode 100644 index 000000000..7917b794b --- /dev/null +++ b/com/backblaze/b2/json/B2JsonLinkedHashSetHandler.html @@ -0,0 +1,436 @@ + + + + + +B2JsonLinkedHashSetHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonLinkedHashSetHandler

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonLinkedHashSetHandler

        +
        public B2JsonLinkedHashSetHandler​(B2JsonTypeHandler itemHandler)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(java.util.LinkedHashSet obj,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public java.util.LinkedHashSet deserialize​(B2JsonReader in,
        +                                           B2JsonOptions options)
        +                                    throws B2JsonException,
        +                                           java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public java.util.LinkedHashSet defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonListHandler.html b/com/backblaze/b2/json/B2JsonListHandler.html new file mode 100644 index 000000000..f79b9cdfa --- /dev/null +++ b/com/backblaze/b2/json/B2JsonListHandler.html @@ -0,0 +1,436 @@ + + + + + +B2JsonListHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonListHandler

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonListHandler

        +
        public B2JsonListHandler​(B2JsonTypeHandler itemHandler)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(java.util.List obj,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public java.util.List deserialize​(B2JsonReader in,
        +                                  B2JsonOptions options)
        +                           throws B2JsonException,
        +                                  java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public java.util.List defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonLocalDateHandler.html b/com/backblaze/b2/json/B2JsonLocalDateHandler.html new file mode 100644 index 000000000..3fffc7d3f --- /dev/null +++ b/com/backblaze/b2/json/B2JsonLocalDateHandler.html @@ -0,0 +1,454 @@ + + + + + +B2JsonLocalDateHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonLocalDateHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<java.time.LocalDate>
    +
    +
    +
    public class B2JsonLocalDateHandler
    +extends java.lang.Object
    +implements B2JsonTypeHandler<java.time.LocalDate>
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.time.LocalDatedefaultValueForOptional() +
      Returns the default value to use when an optional field is not present.
      +
      java.time.LocalDatedeserialize​(B2JsonReader in, + B2JsonOptions options) +
      Deserialize one object from a JSON input stream.
      +
      java.time.LocalDatedeserializeUrlParam​(java.lang.String str) +
      When an API is called with GET, this is used to deserialize one of the + values.
      +
      java.lang.reflect.TypegetHandledType() +
      What class does this handle?
      +
      booleanisStringInJson() +
      Does this type look like a string in JSON?
      +
      voidserialize​(java.time.LocalDate obj, + B2JsonOptions options, + B2JsonWriter out) +
      Serialize one object of the class to a JSON output stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonLocalDateTimeHandler.html b/com/backblaze/b2/json/B2JsonLocalDateTimeHandler.html new file mode 100644 index 000000000..0c470ba3c --- /dev/null +++ b/com/backblaze/b2/json/B2JsonLocalDateTimeHandler.html @@ -0,0 +1,454 @@ + + + + + +B2JsonLocalDateTimeHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonLocalDateTimeHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<java.time.LocalDateTime>
    +
    +
    +
    public class B2JsonLocalDateTimeHandler
    +extends java.lang.Object
    +implements B2JsonTypeHandler<java.time.LocalDateTime>
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.time.LocalDateTimedefaultValueForOptional() +
      Returns the default value to use when an optional field is not present.
      +
      java.time.LocalDateTimedeserialize​(B2JsonReader in, + B2JsonOptions options) +
      Deserialize one object from a JSON input stream.
      +
      java.time.LocalDateTimedeserializeUrlParam​(java.lang.String urlValue) +
      When an API is called with GET, this is used to deserialize one of the + values.
      +
      java.lang.reflect.TypegetHandledType() +
      What class does this handle?
      +
      booleanisStringInJson() +
      Does this type look like a string in JSON?
      +
      voidserialize​(java.time.LocalDateTime obj, + B2JsonOptions options, + B2JsonWriter out) +
      Serialize one object of the class to a JSON output stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonLocalDateTimeHandler

        +
        public B2JsonLocalDateTimeHandler()
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonLongArrayHandler.html b/com/backblaze/b2/json/B2JsonLongArrayHandler.html new file mode 100644 index 000000000..5d98e031a --- /dev/null +++ b/com/backblaze/b2/json/B2JsonLongArrayHandler.html @@ -0,0 +1,436 @@ + + + + + +B2JsonLongArrayHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonLongArrayHandler

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonLongArrayHandler

        +
        public B2JsonLongArrayHandler​(B2JsonTypeHandler itemHandler)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(long[] array,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public long[] deserialize​(B2JsonReader in,
        +                          B2JsonOptions options)
        +                   throws B2JsonException,
        +                          java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public long[] defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonLongHandler.html b/com/backblaze/b2/json/B2JsonLongHandler.html new file mode 100644 index 000000000..071e6a7a4 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonLongHandler.html @@ -0,0 +1,453 @@ + + + + + +B2JsonLongHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonLongHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<java.lang.Long>
    +
    +
    +
    public class B2JsonLongHandler
    +extends java.lang.Object
    +implements B2JsonTypeHandler<java.lang.Long>
    +
    (De)serializes Long objects.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2JsonLongHandler​(boolean isPrimitive) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.LongdefaultValueForOptional() +
      Returns the default value to use when an optional field is not present.
      +
      java.lang.Longdeserialize​(B2JsonReader in, + B2JsonOptions options) +
      Deserialize one object from a JSON input stream.
      +
      java.lang.LongdeserializeUrlParam​(java.lang.String value) +
      When an API is called with GET, this is used to deserialize one of the + values.
      +
      java.lang.reflect.TypegetHandledType() +
      What class does this handle?
      +
      booleanisStringInJson() +
      Does this type look like a string in JSON?
      +
      voidserialize​(java.lang.Long obj, + B2JsonOptions options, + B2JsonWriter out) +
      Serialize one object of the class to a JSON output stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonLongHandler

        +
        public B2JsonLongHandler​(boolean isPrimitive)
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonMapHandler.html b/com/backblaze/b2/json/B2JsonMapHandler.html new file mode 100644 index 000000000..0851bd9c7 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonMapHandler.html @@ -0,0 +1,443 @@ + + + + + +B2JsonMapHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonMapHandler

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(java.util.Map obj,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public java.util.Map deserialize​(B2JsonReader in,
        +                                 B2JsonOptions options)
        +                          throws B2JsonException,
        +                                 java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public java.util.Map defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonNonUrlTypeHandler.html b/com/backblaze/b2/json/B2JsonNonUrlTypeHandler.html new file mode 100644 index 000000000..829085078 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonNonUrlTypeHandler.html @@ -0,0 +1,343 @@ + + + + + +B2JsonNonUrlTypeHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonNonUrlTypeHandler<T>

+
+
+ + +
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonNonUrlTypeHandler

        +
        public B2JsonNonUrlTypeHandler()
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserializeUrlParam

        +
        public T deserializeUrlParam​(java.lang.String urlValue)
        +                      throws B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        When an API is called with GET, this is used to deserialize one of the + values.
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonObjectArrayHandler.html b/com/backblaze/b2/json/B2JsonObjectArrayHandler.html new file mode 100644 index 000000000..03b7fbd90 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonObjectArrayHandler.html @@ -0,0 +1,442 @@ + + + + + +B2JsonObjectArrayHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonObjectArrayHandler<T>

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonObjectArrayHandler

        +
        public B2JsonObjectArrayHandler​(java.lang.Class<T> arrayClazz,
        +                                java.lang.Class eltClazz,
        +                                B2JsonTypeHandler itemHandler)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + + + + + + + +
        +
      • +

        deserialize

        +
        public T deserialize​(B2JsonReader in,
        +                     B2JsonOptions options)
        +              throws B2JsonException,
        +                     java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public T defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonObjectHandler.html b/com/backblaze/b2/json/B2JsonObjectHandler.html new file mode 100644 index 000000000..95f8be5fd --- /dev/null +++ b/com/backblaze/b2/json/B2JsonObjectHandler.html @@ -0,0 +1,548 @@ + + + + + +B2JsonObjectHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonObjectHandler<T>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<T>
    +
    +
    +
    public class B2JsonObjectHandler<T>
    +extends B2JsonTypeHandlerWithDefaults<T>
    +
    (De)serializes Java objects based on field annotations. +

    + See doc comment on B2Json for annotation requirements.

    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + + + +
        +
      • +

        serialize

        +
        public void serialize​(T obj,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Serializes the object, adding all fields to the JSON. +

        + Optional fields are always present, and set to null/0 when not present. +

        + The type name field for a member of a union type is added alphabetically in sequence, if needed.

        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserializeUrlParam

        +
        public T deserializeUrlParam​(java.lang.String urlValue)
        +                      throws B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        When an API is called with GET, this is used to deserialize one of the + values.
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public T deserialize​(B2JsonReader in,
        +                     B2JsonOptions options)
        +              throws B2JsonException,
        +                     java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        deserializeFromFieldNameToValueMap

        +
        public T deserializeFromFieldNameToValueMap​(java.util.Map<java.lang.String,​java.lang.Object> fieldNameToValue,
        +                                            B2JsonOptions options)
        +                                     throws B2JsonException
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserializeFromUrlParameterMap

        +
        public T deserializeFromUrlParameterMap​(java.util.Map<java.lang.String,​java.lang.String> parameterMap,
        +                                        B2JsonOptions options)
        +                                 throws B2JsonException
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public T defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      + + + +
        +
      • +

        isBuiltInZeroableType

        +
        public static boolean isBuiltInZeroableType​(java.lang.Class<?> type)
        +
      • +
      + + + +
        +
      • +

        isZero

        +
        public static boolean isZero​(java.lang.Object value)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonOptions.Builder.html b/com/backblaze/b2/json/B2JsonOptions.Builder.html new file mode 100644 index 000000000..cc175da75 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonOptions.Builder.html @@ -0,0 +1,365 @@ + + + + + +B2JsonOptions.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonOptions.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2JsonOptions
    +
    +
    +
    public static class B2JsonOptions.Builder
    +extends java.lang.Object
    +
    Builder for B2JsonOptions
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonOptions.ExtraFieldOption.html b/com/backblaze/b2/json/B2JsonOptions.ExtraFieldOption.html new file mode 100644 index 000000000..4108288c5 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonOptions.ExtraFieldOption.html @@ -0,0 +1,381 @@ + + + + + +B2JsonOptions.ExtraFieldOption (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Enum B2JsonOptions.ExtraFieldOption

+
+
+ +
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      Enum ConstantDescription
      ERROR 
      IGNORE 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static B2JsonOptions.ExtraFieldOptionvalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static B2JsonOptions.ExtraFieldOption[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static B2JsonOptions.ExtraFieldOption[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (B2JsonOptions.ExtraFieldOption c : B2JsonOptions.ExtraFieldOption.values())
        +    System.out.println(c);
        +
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
      • +
      + + + +
        +
      • +

        valueOf

        +
        public static B2JsonOptions.ExtraFieldOption valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonOptions.SerializationOption.html b/com/backblaze/b2/json/B2JsonOptions.SerializationOption.html new file mode 100644 index 000000000..4051adb38 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonOptions.SerializationOption.html @@ -0,0 +1,384 @@ + + + + + +B2JsonOptions.SerializationOption (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Enum B2JsonOptions.SerializationOption

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<B2JsonOptions.SerializationOption>
    +
    +
    +
    Enclosing class:
    +
    B2JsonOptions
    +
    +
    +
    public static enum B2JsonOptions.SerializationOption
    +extends java.lang.Enum<B2JsonOptions.SerializationOption>
    +
    How to format the serialized string + + PRETTY is the default and produces indented, multi-line JSON + COMPACT produces a single line of text with no optional whitespace
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      Enum ConstantDescription
      COMPACT 
      PRETTY 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static B2JsonOptions.SerializationOptionvalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static B2JsonOptions.SerializationOption[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static B2JsonOptions.SerializationOption[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (B2JsonOptions.SerializationOption c : B2JsonOptions.SerializationOption.values())
        +    System.out.println(c);
        +
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
      • +
      + + + +
        +
      • +

        valueOf

        +
        public static B2JsonOptions.SerializationOption valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonOptions.html b/com/backblaze/b2/json/B2JsonOptions.html new file mode 100644 index 000000000..59c3ee21b --- /dev/null +++ b/com/backblaze/b2/json/B2JsonOptions.html @@ -0,0 +1,437 @@ + + + + + +B2JsonOptions (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonOptions

+
+
+ +
+
    +
  • +
    +
    public class B2JsonOptions
    +extends java.lang.Object
    +
    Options used by JSON serialization and de-serialization.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        DEFAULT

        +
        public static final B2JsonOptions DEFAULT
        +
        The default set of options.
        +
      • +
      + + + +
        +
      • +

        DEFAULT_AND_ALLOW_EXTRA_FIELDS

        +
        public static final B2JsonOptions DEFAULT_AND_ALLOW_EXTRA_FIELDS
        +
        The default set of options, except that extra fields are ignored.
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getVersion

        +
        public int getVersion()
        +
        What version of the (de-)serialized structure to use.
        +
      • +
      + + + +
        +
      • +

        getRedactSensitive

        +
        public boolean getRedactSensitive()
        +
        Redact sensitive fields from output
        +
      • +
      + + + + + + + +
        +
      • +

        builder

        +
        public static B2JsonOptions.Builder builder()
        +
        Returns a new builder for B2JsonOptions.
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonReader.html b/com/backblaze/b2/json/B2JsonReader.html new file mode 100644 index 000000000..9b3bfb56a --- /dev/null +++ b/com/backblaze/b2/json/B2JsonReader.html @@ -0,0 +1,709 @@ + + + + + +B2JsonReader (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonReader

+
+
+ +
+
    +
  • +
    +
    public class B2JsonReader
    +extends java.lang.Object
    +
    Reads a stream of characters and converts them to JSON tokens. +

    + This class is NOT thread safe.

    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2JsonReader​(java.io.Reader in) +
      Initializes a new reader.
      +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonReader

        +
        public B2JsonReader​(java.io.Reader in)
        +             throws java.io.IOException
        +
        Initializes a new reader.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        peekNextNotWhitespaceChar

        +
        public char peekNextNotWhitespaceChar()
        +                               throws java.io.IOException,
        +                                      B2JsonException
        +
        Returns the next char that is not whitespace, but does not consume it.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        skipValue

        +
        public void skipValue()
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Skips over a value of any type.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        readNumberAsString

        +
        public java.lang.String readNumberAsString()
        +                                    throws java.io.IOException,
        +                                           B2JsonException
        +
        Reads the next value, which is expected to be a number, and + returns it as a string. + + Throws JsonError if the next thing is not a number.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        readString

        +
        public java.lang.String readString()
        +                            throws B2JsonException,
        +                                   java.io.IOException
        +
        Reads a string value, returning its contents.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        startObjectAndCheckForContents

        +
        public boolean startObjectAndCheckForContents()
        +                                       throws B2JsonException,
        +                                              java.io.IOException
        +
        Reads the open brace for an object. + + Returns true iff the object has any fields. To read an object, use + this structure: + + if (in.startObjectAndCheckForContents()) { + do { + String fieldName = on.readObjectFieldNameAndColon + } while (in.objectHasMoreFields()); + } + in.finishObject();
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        objectHasMoreFields

        +
        public boolean objectHasMoreFields()
        +                            throws java.io.IOException,
        +                                   B2JsonException
        +
        Does the object have any more fields?
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        nextNonWhitespaceIsEof

        +
        public boolean nextNonWhitespaceIsEof()
        +                               throws java.io.IOException,
        +                                      B2JsonException
        +
        Is the next character the given char?
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        readObjectFieldNameAndColon

        +
        public java.lang.String readObjectFieldNameAndColon()
        +                                             throws B2JsonException,
        +                                                    java.io.IOException
        +
        Reads the name of the next object field. After calling this, you + can read the value using whichever method is right for the value + type.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        skipObjectColon

        +
        public void skipObjectColon()
        +                     throws java.io.IOException,
        +                            B2JsonException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        finishObject

        +
        public void finishObject()
        +                  throws B2JsonException,
        +                         java.io.IOException
        +
        Reads the close brace for an object.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        startArrayAndCheckForContents

        +
        public boolean startArrayAndCheckForContents()
        +                                      throws java.io.IOException,
        +                                             B2JsonException
        +
        Starts reading an array by reading the "[". + + Returns true iff there is anything in the array. + + Use this code to read an array: + + if (in.startArrayAndCheckForContents()) { + do { + // read value + } while (in.arrayHasMoreValues()); + } + finishArray();
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        arrayHasMoreValues

        +
        public boolean arrayHasMoreValues()
        +                           throws java.io.IOException,
        +                                  B2JsonException
        +
        Are there more values in an array?
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        finishArray

        +
        public void finishArray()
        +                 throws B2JsonException,
        +                        java.io.IOException
        +
        Reads the close bracket for an array.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        readNull

        +
        public void readNull()
        +              throws java.io.IOException,
        +                     B2JsonException
        +
        Skips over "null".
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        readFalse

        +
        public void readFalse()
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Skips over "false".
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        readTrue

        +
        public void readTrue()
        +              throws java.io.IOException,
        +                     B2JsonException
        +
        Skips over "true".
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonSetHandler.html b/com/backblaze/b2/json/B2JsonSetHandler.html new file mode 100644 index 000000000..8ec13007f --- /dev/null +++ b/com/backblaze/b2/json/B2JsonSetHandler.html @@ -0,0 +1,437 @@ + + + + + +B2JsonSetHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonSetHandler

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(java.util.Set obj,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public java.util.Set deserialize​(B2JsonReader in,
        +                                 B2JsonOptions options)
        +                          throws B2JsonException,
        +                                 java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public java.util.Set defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonStringHandler.html b/com/backblaze/b2/json/B2JsonStringHandler.html new file mode 100644 index 000000000..c79a553ad --- /dev/null +++ b/com/backblaze/b2/json/B2JsonStringHandler.html @@ -0,0 +1,453 @@ + + + + + +B2JsonStringHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonStringHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<java.lang.String>
    +
    +
    +
    public class B2JsonStringHandler
    +extends java.lang.Object
    +implements B2JsonTypeHandler<java.lang.String>
    +
    (De)serializes String objects.
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.StringdefaultValueForOptional() +
      Returns the default value to use when an optional field is not present.
      +
      java.lang.Stringdeserialize​(B2JsonReader in, + B2JsonOptions options) +
      Deserialize one object from a JSON input stream.
      +
      java.lang.StringdeserializeUrlParam​(java.lang.String urlValue) +
      When an API is called with GET, this is used to deserialize one of the + values.
      +
      java.lang.reflect.TypegetHandledType() +
      What class does this handle?
      +
      booleanisStringInJson() +
      Does this type look like a string in JSON?
      +
      voidserialize​(java.lang.String obj, + B2JsonOptions options, + B2JsonWriter out) +
      Serialize one object of the class to a JSON output stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonStringHandler

        +
        public B2JsonStringHandler()
        +
      • +
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonTreeSetHandler.html b/com/backblaze/b2/json/B2JsonTreeSetHandler.html new file mode 100644 index 000000000..3224bbaa6 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonTreeSetHandler.html @@ -0,0 +1,436 @@ + + + + + +B2JsonTreeSetHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonTreeSetHandler

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonTreeSetHandler

        +
        public B2JsonTreeSetHandler​(B2JsonTypeHandler itemHandler)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        public java.lang.reflect.Type getHandledType()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + +
        +
      • +

        serialize

        +
        public void serialize​(java.util.TreeSet obj,
        +                      B2JsonOptions options,
        +                      B2JsonWriter out)
        +               throws java.io.IOException,
        +                      B2JsonException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        public java.util.TreeSet deserialize​(B2JsonReader in,
        +                                     B2JsonOptions options)
        +                              throws B2JsonException,
        +                                     java.io.IOException
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        public java.util.TreeSet defaultValueForOptional()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        public boolean isStringInJson()
        +
        Description copied from interface: B2JsonTypeHandler
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonTypeHandler.html b/com/backblaze/b2/json/B2JsonTypeHandler.html new file mode 100644 index 000000000..98029ed14 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonTypeHandler.html @@ -0,0 +1,378 @@ + + + + + +B2JsonTypeHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2JsonTypeHandler<T>

+
+
+ +
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandledType

        +
        java.lang.reflect.Type getHandledType()
        +
        What class does this handle?
        +
        +
        Returns:
        +
        +
      • +
      + + + + + +
        +
      • +

        serialize

        +
        void serialize​(T obj,
        +               B2JsonOptions options,
        +               B2JsonWriter out)
        +        throws java.io.IOException,
        +               B2JsonException
        +
        Serialize one object of the class to a JSON output stream. + + The object is guaranteed not to be null.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        deserialize

        +
        T deserialize​(B2JsonReader in,
        +              B2JsonOptions options)
        +       throws B2JsonException,
        +              java.io.IOException
        +
        Deserialize one object from a JSON input stream. + + Will never be called when there is "null" in the input stream, + and will never return null.
        +
        +
        Throws:
        +
        B2JsonException
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        deserializeUrlParam

        +
        T deserializeUrlParam​(java.lang.String urlValue)
        +               throws B2JsonException
        +
        When an API is called with GET, this is used to deserialize one of the + values.
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        defaultValueForOptional

        +
        T defaultValueForOptional()
        +
        Returns the default value to use when an optional field is not present.
        +
      • +
      + + + +
        +
      • +

        isStringInJson

        +
        boolean isStringInJson()
        +
        Does this type look like a string in JSON?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonTypeHandlerWithDefaults.html b/com/backblaze/b2/json/B2JsonTypeHandlerWithDefaults.html new file mode 100644 index 000000000..b8df57532 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonTypeHandlerWithDefaults.html @@ -0,0 +1,362 @@ + + + + + +B2JsonTypeHandlerWithDefaults (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonTypeHandlerWithDefaults<T>

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonTypeHandlerWithDefaults

        +
        public B2JsonTypeHandlerWithDefaults()
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        throwIfBadDefaultValue

        +
        protected void throwIfBadDefaultValue()
        +                               throws B2JsonException
        +
        Before (de)serializing, make sure that the defaults are OK.
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      + + + +
        +
      • +

        checkDefaultValues

        +
        protected abstract void checkDefaultValues()
        +                                    throws B2JsonException
        +
        Checks whether default values are OK, and throws if not.
        +
        +
        Throws:
        +
        B2JsonException
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonUnionBaseHandler.html b/com/backblaze/b2/json/B2JsonUnionBaseHandler.html new file mode 100644 index 000000000..5df2916f9 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonUnionBaseHandler.html @@ -0,0 +1,479 @@ + + + + + +B2JsonUnionBaseHandler (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonUnionBaseHandler<T>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    B2JsonTypeHandler<T>
    +
    +
    +
    public class B2JsonUnionBaseHandler<T>
    +extends B2JsonTypeHandlerWithDefaults<T>
    +
    Handler for the class that is the base class for a union type. +

    + This handler is used only for deserialization, where it finds the + type name in the JSON object, and this dispatches to the subclass + for that type.

    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonUnionTypeMap.Builder.html b/com/backblaze/b2/json/B2JsonUnionTypeMap.Builder.html new file mode 100644 index 000000000..440b251a7 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonUnionTypeMap.Builder.html @@ -0,0 +1,298 @@ + + + + + +B2JsonUnionTypeMap.Builder (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonUnionTypeMap.Builder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    B2JsonUnionTypeMap
    +
    +
    +
    public static class B2JsonUnionTypeMap.Builder
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      B2JsonUnionTypeMapbuild() +
      Builds the B2JsonUnionTypeMap.
      +
      B2JsonUnionTypeMap.Builderput​(java.lang.String typeName, + java.lang.Class<?> typeClass) +
      Adds a new type to the map being built.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        put

        +
        public B2JsonUnionTypeMap.Builder put​(java.lang.String typeName,
        +                                      java.lang.Class<?> typeClass)
        +                               throws B2JsonException
        +
        Adds a new type to the map being built.
        +
        +
        Parameters:
        +
        typeName - The name used for this type in JSON.
        +
        typeClass - The class used in Java.
        +
        Throws:
        +
        B2JsonException - When adding duplicate names or classes to the map.
        +
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonUnionTypeMap.html b/com/backblaze/b2/json/B2JsonUnionTypeMap.html new file mode 100644 index 000000000..7bfcec7a2 --- /dev/null +++ b/com/backblaze/b2/json/B2JsonUnionTypeMap.html @@ -0,0 +1,316 @@ + + + + + +B2JsonUnionTypeMap (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonUnionTypeMap

+
+
+ +
+
    +
  • +
    +
    public class B2JsonUnionTypeMap
    +extends java.lang.Object
    +
    Holds the mapping between type names and the classes used for them in a union type.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTypeNameToClass

        +
        public java.util.Map<java.lang.String,​java.lang.Class<?>> getTypeNameToClass()
        +
      • +
      + + + +
        +
      • +

        getTypeNameOrNullForClass

        +
        public java.lang.String getTypeNameOrNullForClass​(java.lang.Class<?> clazz)
        +
      • +
      + + + + +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonUtil.html b/com/backblaze/b2/json/B2JsonUtil.html new file mode 100644 index 000000000..808d174eb --- /dev/null +++ b/com/backblaze/b2/json/B2JsonUtil.html @@ -0,0 +1,350 @@ + + + + + +B2JsonUtil (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonUtil

+
+
+ +
+
    +
  • +
    +
    public class B2JsonUtil
    +extends java.lang.Object
    +
  • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2JsonWriter.html b/com/backblaze/b2/json/B2JsonWriter.html new file mode 100644 index 000000000..56f7fe0eb --- /dev/null +++ b/com/backblaze/b2/json/B2JsonWriter.html @@ -0,0 +1,497 @@ + + + + + +B2JsonWriter (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2JsonWriter

+
+
+ +
+
    +
  • +
    +
    public class B2JsonWriter
    +extends java.lang.Object
    +
    Writes out JSON tokens, supports pretty and compact style output.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2JsonWriter

        +
        public B2JsonWriter​(java.io.OutputStream out,
        +                    B2JsonOptions options)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        writeText

        +
        public void writeText​(java.lang.String text)
        +               throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        setAllowNewlines

        +
        public void setAllowNewlines​(boolean allowNewlines)
        +
      • +
      + + + +
        +
      • +

        startObject

        +
        public void startObject()
        +                 throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        writeObjectFieldNameAndColon

        +
        public void writeObjectFieldNameAndColon​(java.lang.String name)
        +                                  throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        writeFieldNameValueSeparator

        +
        public void writeFieldNameValueSeparator()
        +                                  throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        startObjectFieldName

        +
        public void startObjectFieldName()
        +                          throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        finishObject

        +
        public void finishObject()
        +                  throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        startArray

        +
        public void startArray()
        +                throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        startArrayValue

        +
        public void startArrayValue()
        +                     throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        finishArray

        +
        public void finishArray()
        +                 throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        writeString

        +
        public void writeString​(java.lang.CharSequence value)
        +                 throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/B2TypeResolver.html b/com/backblaze/b2/json/B2TypeResolver.html new file mode 100644 index 000000000..3bc20da30 --- /dev/null +++ b/com/backblaze/b2/json/B2TypeResolver.html @@ -0,0 +1,376 @@ + + + + + +B2TypeResolver (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2TypeResolver

+
+
+ +
+
    +
  • +
    +
    public class B2TypeResolver
    +extends java.lang.Object
    +
    Class used to resolve generic types of a class when supplied with the actual type arguments used to construct an + instance of the class. + + For example, consider the following classes. + +
    
    + class Item<T> {
    +     T value;
    +     List<T> values;
    + }
    +
    + class Enclosing {
    +     Item<String> stringItem;
    +     Item<Integer> integerItem;
    + }
    + 
    + + When considering just Item.class, we do not have enough information to resolve the type for .value and .values. + However, if we are considering Enclosing.class, then even though it has fields that are Item.class instances, we have + the additional context of the type arguments used along with the Item class. This allows us to resolve the types of + Enclosing.class' fields. + + final B2TypeResolver typeResolver = new B2TypeResolver(Enclosing.class); + // The following returns ResolvedParameterizedType(Item.class, new Type[]{ String.class }); + typeResolver.resolveType(Enclosing.class.getDeclaredFields()[0]);
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2TypeResolver​(java.lang.Class<?> clazz) 
      B2TypeResolver​(java.lang.Class<?> clazz, + java.lang.reflect.Type[] actualTypeArgumentsOrNull) +
      Creates a type resolver for the supplied class.
      +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.reflect.TypegetType() +
      Returns the type this resolver is working over.
      +
      java.lang.reflect.TyperesolveType​(java.lang.reflect.Field field) +
      Resolve the type of the supplied field.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2TypeResolver

        +
        public B2TypeResolver​(java.lang.Class<?> clazz)
        +
      • +
      + + + +
        +
      • +

        B2TypeResolver

        +
        public B2TypeResolver​(java.lang.Class<?> clazz,
        +                      java.lang.reflect.Type[] actualTypeArgumentsOrNull)
        +
        Creates a type resolver for the supplied class. + + If clazz is a parameterized class, then the code will throw if you do not supply the actual type arguments used + with the class, or the actualTypeArguments is the wrong length for the number of type parameters clazz takes. + + If clazz is not parameterized, then the code will throw if you supply anything other than null or a 0-length + array for actualTypeArguments.
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getType

        +
        public java.lang.reflect.Type getType()
        +
        Returns the type this resolver is working over. That is, the class that encloses the fields this object knows + how to resolve.
        +
      • +
      + + + +
        +
      • +

        resolveType

        +
        public java.lang.reflect.Type resolveType​(java.lang.reflect.Field field)
        +
        Resolve the type of the supplied field. + + Will throw if field does not belong to the class this B2TypeResolver is for.
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/FieldInfo.FieldRequirement.html b/com/backblaze/b2/json/FieldInfo.FieldRequirement.html new file mode 100644 index 000000000..9df9da97f --- /dev/null +++ b/com/backblaze/b2/json/FieldInfo.FieldRequirement.html @@ -0,0 +1,393 @@ + + + + + +FieldInfo.FieldRequirement (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Enum FieldInfo.FieldRequirement

+
+
+ +
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum ConstantDescription
      IGNORED 
      OPTIONAL 
      REQUIRED 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static FieldInfo.FieldRequirementvalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static FieldInfo.FieldRequirement[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static FieldInfo.FieldRequirement[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (FieldInfo.FieldRequirement c : FieldInfo.FieldRequirement.values())
        +    System.out.println(c);
        +
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
      • +
      + + + +
        +
      • +

        valueOf

        +
        public static FieldInfo.FieldRequirement valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/FieldInfo.html b/com/backblaze/b2/json/FieldInfo.html new file mode 100644 index 000000000..f4e014555 --- /dev/null +++ b/com/backblaze/b2/json/FieldInfo.html @@ -0,0 +1,563 @@ + + + + + +FieldInfo (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class FieldInfo

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Comparable<FieldInfo>
    +
    +
    +
    public final class FieldInfo
    +extends java.lang.Object
    +implements java.lang.Comparable<FieldInfo>
    +
    Information for one field in an object that is (de)serialized. +

    + Used by B2ObjectHandler and B2JsonObjectHandler.

    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        field

        +
        public final java.lang.reflect.Field field
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        defaultValueJsonOrNull

        +
        public final java.lang.String defaultValueJsonOrNull
        +
      • +
      + + + +
        +
      • +

        versionRange

        +
        public final VersionRange versionRange
        +
      • +
      + + + +
        +
      • +

        constructorArgIndex

        +
        public int constructorArgIndex
        +
      • +
      + + + +
        +
      • +

        isSensitive

        +
        public final boolean isSensitive
        +
      • +
      + + + +
        +
      • +

        omitNull

        +
        public final boolean omitNull
        +
      • +
      + + + +
        +
      • +

        omitZero

        +
        public final boolean omitZero
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        @Deprecated
        +public java.lang.String getName()
        +
        Deprecated. +
        use getJsonMemberName() instead which is clearer.
        +
        +
        Returns the member name that this field is serialized to in Json.
        +
      • +
      + + + +
        +
      • +

        getJsonMemberName

        +
        public java.lang.String getJsonMemberName()
        +
        Returns the member name that this field is serialized to in Json.
        +
      • +
      + + + + + + + +
        +
      • +

        getIsSensitive

        +
        public boolean getIsSensitive()
        +
      • +
      + + + +
        +
      • +

        compareTo

        +
        public int compareTo​(FieldInfo o)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<FieldInfo>
        +
        +
      • +
      + + + +
        +
      • +

        setConstructorArgIndex

        +
        public void setConstructorArgIndex​(int index)
        +
      • +
      + + + +
        +
      • +

        isInVersion

        +
        public boolean isInVersion​(int version)
        +
      • +
      + + + +
        +
      • +

        isRequiredAndInVersion

        +
        public boolean isRequiredAndInVersion​(int version)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/VersionRange.html b/com/backblaze/b2/json/VersionRange.html new file mode 100644 index 000000000..4ab846ec8 --- /dev/null +++ b/com/backblaze/b2/json/VersionRange.html @@ -0,0 +1,358 @@ + + + + + +VersionRange (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class VersionRange

+
+
+ +
+
    +
  • +
    +
    public class VersionRange
    +extends java.lang.Object
    +
    Holds a range of version numbers. + + Used to record which versions a field belongs to. Version numbers start at 1.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static VersionRangeALL_VERSIONS +
      Version range that includes all versions.
      +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static VersionRangeallVersionsFrom​(int firstVersion) +
      Factory for a range with a start version that includes all later + versions.
      +
      booleanincludesVersion​(int version) +
      Does this range include the version?
      +
      static VersionRangerange​(int firstVersion, + int lastVersion) +
      Factory for a range.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        ALL_VERSIONS

        +
        public static final VersionRange ALL_VERSIONS
        +
        Version range that includes all versions.
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        allVersionsFrom

        +
        public static VersionRange allVersionsFrom​(int firstVersion)
        +
        Factory for a range with a start version that includes all later + versions.
        +
      • +
      + + + +
        +
      • +

        includesVersion

        +
        public boolean includesVersion​(int version)
        +
        Does this range include the version?
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/json/package-summary.html b/com/backblaze/b2/json/package-summary.html new file mode 100644 index 000000000..49268bd3e --- /dev/null +++ b/com/backblaze/b2/json/package-summary.html @@ -0,0 +1,592 @@ + + + + + +com.backblaze.b2.json (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.backblaze.b2.json

+
+
+ +
+
+ + + diff --git a/com/backblaze/b2/json/package-tree.html b/com/backblaze/b2/json/package-tree.html new file mode 100644 index 000000000..bc86e86fd --- /dev/null +++ b/com/backblaze/b2/json/package-tree.html @@ -0,0 +1,276 @@ + + + + + +com.backblaze.b2.json Class Hierarchy (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.backblaze.b2.json

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Annotation Type Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+ + + diff --git a/com/backblaze/b2/util/B2ByteProgressListener.html b/com/backblaze/b2/util/B2ByteProgressListener.html new file mode 100644 index 000000000..c77eeb5d6 --- /dev/null +++ b/com/backblaze/b2/util/B2ByteProgressListener.html @@ -0,0 +1,313 @@ + + + + + +B2ByteProgressListener (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2ByteProgressListener

+
+
+
+
    +
  • +
    +
    public interface B2ByteProgressListener
    +
    This listener is called as data is read from an input stream. + It is called synchronously before the caller receives the data from the stream. + + (1) keep in mind that the time you spend listening is directly slowing down + the processing of the stream. + + (2) keep in mind that you're learning about things before the stream's caller. + In particular, if you're using this as a proxy for the amount of data that's + been sent to server, remember that it's not really a measure of that. Many + things can happen before the data is sent (and being sent isn't the same + as being processed by the server!). Higher-level indications (like receiving + the response from the server) are better indications that the server has + processed your data!
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      voidhitException​(java.lang.Exception e, + long nBytesSoFar) +
      Called right before the exception propagates to the caller.
      +
      voidprogress​(long nBytesSoFar) +
      Called right before returning bytes to the caller.
      +
      voidreachedEof​(long nBytesSoFar) +
      Called right before the caller learns that we've hit the end of the stream.
      +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        progress

        +
        void progress​(long nBytesSoFar)
        +
        Called right before returning bytes to the caller.
        +
        +
        Parameters:
        +
        nBytesSoFar - the total number of bytes read from the stream so far.
        +
        +
      • +
      + + + +
        +
      • +

        hitException

        +
        void hitException​(java.lang.Exception e,
        +                  long nBytesSoFar)
        +
        Called right before the exception propagates to the caller.
        +
        +
        Parameters:
        +
        e - the exception that was thrown
        +
        nBytesSoFar - the total number of bytes read from the stream so far.
        +
        +
      • +
      + + + +
        +
      • +

        reachedEof

        +
        void reachedEof​(long nBytesSoFar)
        +
        Called right before the caller learns that we've hit the end of the stream.
        +
        +
        Parameters:
        +
        nBytesSoFar - the total number of bytes read from the stream so far.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2ByteRange.html b/com/backblaze/b2/util/B2ByteRange.html new file mode 100644 index 000000000..ada633b9e --- /dev/null +++ b/com/backblaze/b2/util/B2ByteRange.html @@ -0,0 +1,546 @@ + + + + + +B2ByteRange (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ByteRange

+
+
+ +
+
    +
  • +
    +
    public class B2ByteRange
    +extends java.lang.Object
    +
    Represents a range of bytes in an HTTP entity. + + Used both for the Range header and the Content-Range header. + + In the Range header, we do not support multiple ranges, but do support + all three forms of single ranges: + bytes=10-20 11 bytes, from index 10 to index 20 + bytes=15- All bytes from index 15 to the end of the entity. + bytes=-37 The last 37 bytes of the entity. + + See: + http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.16 + http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      java.lang.Longend +
      The index of the last byte in the range, inclusive.
      +
      java.lang.Longstart +
      The index of the first byte in the range, zero based, + or null if there is no starting index.
      +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2ByteRange​(java.lang.Long start, + java.lang.Long end) +
      Initializes a new B2ByteRange.
      +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static B2ByteRangebetween​(long start, + long end) 
      B2ByteRangeeffectiveRange​(long entitySize) +
      Return an equivalent byte range with both start and end set, and + with both being valid indexes into the entity.
      +
      booleanequals​(java.lang.Object o) 
      longgetNumberOfBytes() +
      Returns the number of bytes that the range specifies.
      +
      inthashCode() 
      booleanisSatisfied​(long entitySize) +
      Can this range be satisfied with a file of the given length.
      +
      static B2ByteRangeparse​(java.lang.String s) +
      Parses a byte range that looks like: + + bytes=100-999 + + Returns null on error.
      +
      static B2ByteRangestartAt​(long start) 
      java.lang.StringtoString() +
      Returns a string like "bytes=200-340"
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        start

        +
        public final java.lang.Long start
        +
        The index of the first byte in the range, zero based, + or null if there is no starting index.
        +
      • +
      + + + +
        +
      • +

        end

        +
        public final java.lang.Long end
        +
        The index of the last byte in the range, inclusive. + The range "bytes=0-0" is a one-byte range that is the + first byte in the content. + Null if there is no ending index.
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ByteRange

        +
        public B2ByteRange​(java.lang.Long start,
        +                   java.lang.Long end)
        +
        Initializes a new B2ByteRange. + + Remember that "end" is the index of the last byte in the range, + inclusive.
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        startAt

        +
        public static B2ByteRange startAt​(long start)
        +
      • +
      + + + +
        +
      • +

        between

        +
        public static B2ByteRange between​(long start,
        +                                  long end)
        +
      • +
      + + + +
        +
      • +

        parse

        +
        public static B2ByteRange parse​(java.lang.String s)
        +
        Parses a byte range that looks like: + + bytes=100-999 + + Returns null on error.
        +
      • +
      + + + +
        +
      • +

        isSatisfied

        +
        public boolean isSatisfied​(long entitySize)
        +
        Can this range be satisfied with a file of the given length.
        +
      • +
      + + + +
        +
      • +

        effectiveRange

        +
        public B2ByteRange effectiveRange​(long entitySize)
        +
        Return an equivalent byte range with both start and end set, and + with both being valid indexes into the entity. + + Caller is responsible for making sure the range is satisfiable with the + given entity size.
        +
      • +
      + + + +
        +
      • +

        getNumberOfBytes

        +
        public long getNumberOfBytes()
        +
        Returns the number of bytes that the range specifies.
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Returns a string like "bytes=200-340"
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2Clock.html b/com/backblaze/b2/util/B2Clock.html new file mode 100644 index 000000000..b8a6b6886 --- /dev/null +++ b/com/backblaze/b2/util/B2Clock.html @@ -0,0 +1,399 @@ + + + + + +B2Clock (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2Clock

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    B2ClockImpl, B2ClockSim
    +
    +
    +
    public abstract class B2Clock
    +extends java.lang.Object
    +
    This class provides access to two different time measurements. + + It also provides access to the global clock object. It's an object + instead of static methods so we can use a different implementation + in tests. + + It is an abstract class instead of an interface so that it can hold the + global instance. (If we had a dependency injection system we would + probably use that instead of a global, but we don't have one.) + + I also keep thinking that maybe there should be two different types + of clock objects -- one for monotonic time and one for wall clock time. + So far, I'm keeping them together because it helps to advance them + both in tests and every call to get a value says what type of time it is.
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2Clock

        +
        public B2Clock()
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        useSimulator

        +
        public static B2ClockSim useSimulator​(java.time.LocalDateTime desiredNow)
        +
        If theClock is null, this will create a B2ClockSim with the desiredNow. + If theClock is a B2ClockSim, this will set it to the specified time. + If theclock is not a B2ClockSim, this will throw.
        +
        +
        Parameters:
        +
        desiredNow - is the wall clock time for the simulator's "now".
        +
        Returns:
        +
        theClock
        +
        +
      • +
      + + + +
        +
      • +

        get

        +
        public static B2Clock get()
        +
        +
        Returns:
        +
        theClock to use.
        +
        +
      • +
      + + + +
        +
      • +

        monotonicMillis

        +
        public abstract long monotonicMillis()
        +
        +
        Returns:
        +
        a monotonically increasing number of milliseconds. note that it has + no relationship to wall clock time and will differ between different + runs of the JVM. + + It is monotonically increasing! + AND it won't wrap during any single run of a JVM. + (unless the JVM runs for hundreds of of years! + (2^63 nanos) / (10^9 nanos/sec) / (86400 secs/day) / (365 days/year) ~= 292 years)
        +
        +
      • +
      + + + +
        +
      • +

        wallClockMillis

        +
        public abstract long wallClockMillis()
        +
        +
        Returns:
        +
        the number of milliseconds since the unix epoch. + may be negative if now is before the epoch. + the values returned by this represent wall clock + time and might not be monotonic if the system clock + is changed. time might sometimes flow at a variable + speed or even backwards if the clock is being adjusted.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2ClockImpl.html b/com/backblaze/b2/util/B2ClockImpl.html new file mode 100644 index 000000000..ffc0de054 --- /dev/null +++ b/com/backblaze/b2/util/B2ClockImpl.html @@ -0,0 +1,356 @@ + + + + + +B2ClockImpl (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ClockImpl

+
+
+ +
+
    +
  • +
    +
    public class B2ClockImpl
    +extends B2Clock
    +
    B2ClockImpl uses values from the System class to provide a "real" + implementation of B2Clock whose clocks are determined by the system.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2ClockImpl() 
      +
    • +
    +
    + +
    + +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ClockImpl

        +
        public B2ClockImpl()
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        monotonicMillis

        +
        public long monotonicMillis()
        +
        +
        Specified by:
        +
        monotonicMillis in class B2Clock
        +
        Returns:
        +
        a monotonically increasing number of milliseconds. note that it has + no relationship to wall clock time and will differ between different + runs of the JVM. + + It is monotonically increasing! + AND it won't wrap during any single run of a JVM. + (unless the JVM runs for hundreds of of years! + (2^63 nanos) / (10^9 nanos/sec) / (86400 secs/day) / (365 days/year) ~= 292 years)
        +
        +
      • +
      + + + +
        +
      • +

        wallClockMillis

        +
        public long wallClockMillis()
        +
        +
        Specified by:
        +
        wallClockMillis in class B2Clock
        +
        Returns:
        +
        the number of milliseconds since the unix epoch. + may be negative if now is before the epoch. + the values returned by this represent wall clock + time and might not be monotonic if the system clock + is changed. time might sometimes flow at a variable + speed or even backwards if the clock is being adjusted.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2ClockSim.html b/com/backblaze/b2/util/B2ClockSim.html new file mode 100644 index 000000000..531d4157f --- /dev/null +++ b/com/backblaze/b2/util/B2ClockSim.html @@ -0,0 +1,385 @@ + + + + + +B2ClockSim (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ClockSim

+
+
+ +
+
    +
  • +
    +
    public class B2ClockSim
    +extends B2Clock
    +
    B2ClockSim provides a simple simulation of a clock, for use in tests.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidadvanceBoth​(java.time.Duration delta) +
      Shifts the current time by the given duration.
      +
      voidadvanceNow​(java.time.Duration delta) +
      Shifts the current wall clock time by the given duration.
      +
      longmonotonicMillis() 
      voidresetBoth​(java.time.LocalDateTime desiredNow) +
      This is intended to be run between tests to reset the clock to an initial + state, as if the simulator has just be constructed.
      +
      longwallClockMillis() 
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        wallClockMillis

        +
        public long wallClockMillis()
        +
        +
        Specified by:
        +
        wallClockMillis in class B2Clock
        +
        Returns:
        +
        the number of milliseconds since the unix epoch. + may be negative if now is before the epoch. + the values returned by this represent wall clock + time and might not be monotonic if the system clock + is changed. time might sometimes flow at a variable + speed or even backwards if the clock is being adjusted.
        +
        +
      • +
      + + + +
        +
      • +

        monotonicMillis

        +
        public long monotonicMillis()
        +
        +
        Specified by:
        +
        monotonicMillis in class B2Clock
        +
        Returns:
        +
        a monotonically increasing number of milliseconds. note that it has + no relationship to wall clock time and will differ between different + runs of the JVM. + + It is monotonically increasing! + AND it won't wrap during any single run of a JVM. + (unless the JVM runs for hundreds of of years! + (2^63 nanos) / (10^9 nanos/sec) / (86400 secs/day) / (365 days/year) ~= 292 years)
        +
        +
      • +
      + + + +
        +
      • +

        advanceBoth

        +
        public void advanceBoth​(java.time.Duration delta)
        +
        Shifts the current time by the given duration. + The wallClock and monotonic times will go forward by the same amount.
        +
        +
        Parameters:
        +
        delta - the amount of time to shift both clocks by. + must be non-negative to avoid making the monotonic clock go backwards!
        +
        +
      • +
      + + + +
        +
      • +

        advanceNow

        +
        public void advanceNow​(java.time.Duration delta)
        +
        Shifts the current wall clock time by the given duration. + Only nowMillis will be adjusted. Use this when you want to + shift time backwards, since you're not allowed to call advanceBoth() + with negative value.
        +
        +
        Parameters:
        +
        delta - the time to advance the wall clock by
        +
        +
      • +
      + + + +
        +
      • +

        resetBoth

        +
        public void resetBoth​(java.time.LocalDateTime desiredNow)
        +
        This is intended to be run between tests to reset the clock to an initial + state, as if the simulator has just be constructed.
        +
        +
        Parameters:
        +
        desiredNow - the desired wall clock time.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2Collections.html b/com/backblaze/b2/util/B2Collections.html new file mode 100644 index 000000000..778463018 --- /dev/null +++ b/com/backblaze/b2/util/B2Collections.html @@ -0,0 +1,417 @@ + + + + + +B2Collections (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2Collections

+
+
+ +
+
    +
  • +
    +
    public class B2Collections
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2Collections() 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static <T> java.util.List<T>listOf​(T... orig) 
      static <K,​V>
      java.util.Map<K,​V>
      mapOf() 
      static <K,​V>
      java.util.Map<K,​V>
      mapOf​(K k1, + V v1) 
      static <K,​V>
      java.util.Map<K,​V>
      mapOf​(K k1, + V v1, + K k2, + V v2) 
      static <K,​V>
      java.util.Map<K,​V>
      mapOf​(K k1, + V v1, + K k2, + V v2, + K k3, + V v3) 
      static <K,​V>
      java.util.Map<K,​V>
      unmodifiableMap​(java.util.Map<K,​V> orig) 
      static <T> java.util.Set<T>unmodifiableSet​(T[] elements) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2Collections

        +
        public B2Collections()
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        unmodifiableSet

        +
        public static <T> java.util.Set<T> unmodifiableSet​(T[] elements)
        +
      • +
      + + + +
        +
      • +

        unmodifiableMap

        +
        public static <K,​V> java.util.Map<K,​V> unmodifiableMap​(java.util.Map<K,​V> orig)
        +
      • +
      + + + +
        +
      • +

        mapOf

        +
        public static <K,​V> java.util.Map<K,​V> mapOf()
        +
      • +
      + + + + + +
        +
      • +

        mapOf

        +
        public static <K,​V> java.util.Map<K,​V> mapOf​(K k1,
        +                                                         V v1)
        +
      • +
      + + + + + +
        +
      • +

        mapOf

        +
        public static <K,​V> java.util.Map<K,​V> mapOf​(K k1,
        +                                                         V v1,
        +                                                         K k2,
        +                                                         V v2)
        +
      • +
      + + + + + +
        +
      • +

        mapOf

        +
        public static <K,​V> java.util.Map<K,​V> mapOf​(K k1,
        +                                                         V v1,
        +                                                         K k2,
        +                                                         V v2,
        +                                                         K k3,
        +                                                         V v3)
        +
      • +
      + + + + + +
        +
      • +

        listOf

        +
        @SafeVarargs
        +public static <T> java.util.List<T> listOf​(T... orig)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2DateTimeUtil.html b/com/backblaze/b2/util/B2DateTimeUtil.html new file mode 100644 index 000000000..3aed8470b --- /dev/null +++ b/com/backblaze/b2/util/B2DateTimeUtil.html @@ -0,0 +1,510 @@ + + + + + +B2DateTimeUtil (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2DateTimeUtil

+
+
+ +
+
    +
  • +
    +
    public class B2DateTimeUtil
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static java.lang.StringdurationString​(long deltaSecs) 
      static java.lang.StringformatFguidDateTime​(java.time.LocalDateTime dateTime) +
      Returns a date-time in FGUID form: "d20150315_m092654"
      +
      static java.lang.StringformatSolidDate​(java.time.LocalDate date) +
      Formats a date in "solid" format, like "20150314"
      +
      static java.time.LocalDateTimeparseDateTime​(java.lang.String str) +
      Parses a date-time string in any one of these formats: + + "20150314092654" - "solid" Backblaze dates + "d20150314_m092654" - FGUID-style Backblaze dates + "2015-03-14 09:26:54" - ISO-8601 with space + "2015-03-14T09:26" - ISO-8601 but no seconds + "2015-03-14T09:26:54" - ISO-8601 + "2015-03-14T09:26:54.547" - ISO-8601
      +
      static java.time.DurationparseDuration​(java.lang.String str) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        formatSolidDate

        +
        public static java.lang.String formatSolidDate​(java.time.LocalDate date)
        +
        Formats a date in "solid" format, like "20150314"
        +
      • +
      + + + +
        +
      • +

        parseDateTime

        +
        public static java.time.LocalDateTime parseDateTime​(java.lang.String str)
        +
        Parses a date-time string in any one of these formats: + + "20150314092654" - "solid" Backblaze dates + "d20150314_m092654" - FGUID-style Backblaze dates + "2015-03-14 09:26:54" - ISO-8601 with space + "2015-03-14T09:26" - ISO-8601 but no seconds + "2015-03-14T09:26:54" - ISO-8601 + "2015-03-14T09:26:54.547" - ISO-8601
        +
      • +
      + + + +
        +
      • +

        formatFguidDateTime

        +
        public static java.lang.String formatFguidDateTime​(java.time.LocalDateTime dateTime)
        +
        Returns a date-time in FGUID form: "d20150315_m092654"
        +
      • +
      + + + +
        +
      • +

        parseDuration

        +
        public static java.time.Duration parseDuration​(java.lang.String str)
        +
        +
        Parameters:
        +
        str - string to parse. it must match: + [-][Dd][Dh][Dm][Ds] + where D is [0-9]+ + and at least one of the numeric parts must be specified.
        +
        Returns:
        +
        the duration described by the given string or null if it doesn't match the pattern.
        +
        +
      • +
      + + + +
        +
      • +

        durationString

        +
        public static java.lang.String durationString​(long deltaSecs)
        +
        +
        Returns:
        +
        a succinct string describing the given number of seconds.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2ExecutorUtils.html b/com/backblaze/b2/util/B2ExecutorUtils.html new file mode 100644 index 000000000..ba93da79b --- /dev/null +++ b/com/backblaze/b2/util/B2ExecutorUtils.html @@ -0,0 +1,328 @@ + + + + + +B2ExecutorUtils (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2ExecutorUtils

+
+
+ +
+
    +
  • +
    +
    public class B2ExecutorUtils
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2ExecutorUtils() 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static java.util.concurrent.ThreadFactorycreateThreadFactory​(java.lang.String nameFormat) 
      static voidshutdownAndAwaitTermination​(java.util.concurrent.ExecutorService executor, + int gracefulSecs, + int otherSecs) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2ExecutorUtils

        +
        public B2ExecutorUtils()
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        shutdownAndAwaitTermination

        +
        public static void shutdownAndAwaitTermination​(java.util.concurrent.ExecutorService executor,
        +                                               int gracefulSecs,
        +                                               int otherSecs)
        +
      • +
      + + + +
        +
      • +

        createThreadFactory

        +
        public static java.util.concurrent.ThreadFactory createThreadFactory​(java.lang.String nameFormat)
        +
        +
        Parameters:
        +
        nameFormat - the format for the thread names, should contain a single %d.
        +
        Returns:
        +
        a new ThreadFactory that takes a string format to help name threads
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2FlushAndSyncFileOnCloseOutputStream.html b/com/backblaze/b2/util/B2FlushAndSyncFileOnCloseOutputStream.html new file mode 100644 index 000000000..1750f7278 --- /dev/null +++ b/com/backblaze/b2/util/B2FlushAndSyncFileOnCloseOutputStream.html @@ -0,0 +1,427 @@ + + + + + +B2FlushAndSyncFileOnCloseOutputStream (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2FlushAndSyncFileOnCloseOutputStream

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
    +
    +
    +
    public class B2FlushAndSyncFileOnCloseOutputStream
    +extends java.io.OutputStream
    +
    Wrap your FileOutputStreams with a B2FlushAndSyncFileOnCloseOutputStream to ensure that + your files are always sync'd before being closed. See + http://www.pointsoftware.ch/en/4-ext4-vs-ext3-filesystem-and-why-delayed-allocation-is-bad/
    +
  • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        write

        +
        public void write​(byte[] b)
        +           throws java.io.IOException
        +
        +
        Overrides:
        +
        write in class java.io.OutputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        write

        +
        public void write​(byte[] b,
        +                  int off,
        +                  int len)
        +           throws java.io.IOException
        +
        +
        Overrides:
        +
        write in class java.io.OutputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        flush

        +
        public void flush()
        +           throws java.io.IOException
        +
        +
        Specified by:
        +
        flush in interface java.io.Flushable
        +
        Overrides:
        +
        flush in class java.io.OutputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +           throws java.io.IOException
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        Overrides:
        +
        close in class java.io.OutputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        write

        +
        public void write​(int b)
        +           throws java.io.IOException
        +
        +
        Specified by:
        +
        write in class java.io.OutputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        create

        +
        public static B2FlushAndSyncFileOnCloseOutputStream create​(java.io.FileOutputStream out)
        +
        +
        Parameters:
        +
        out - the stream to wrap
        +
        Returns:
        +
        a new stream which will carefully finish the file on disk when it's closed.
        +
        +
      • +
      + + + +
        +
      • +

        create

        +
        public static B2FlushAndSyncFileOnCloseOutputStream create​(java.io.File outputFile)
        +                                                    throws java.io.FileNotFoundException
        +
        +
        Parameters:
        +
        outputFile - the file to write to. will be wrapped by a new FileOutputStream.
        +
        Returns:
        +
        a new stream which will carefully finish the file on disk when it's closed.
        +
        Throws:
        +
        java.io.FileNotFoundException
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2InputStreamExcerpt.html b/com/backblaze/b2/util/B2InputStreamExcerpt.html new file mode 100644 index 000000000..eed9e27bf --- /dev/null +++ b/com/backblaze/b2/util/B2InputStreamExcerpt.html @@ -0,0 +1,484 @@ + + + + + +B2InputStreamExcerpt (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2InputStreamExcerpt

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.lang.AutoCloseable
    +
    +
    +
    public class B2InputStreamExcerpt
    +extends java.io.InputStream
    +
    B2InputStreamExcerpt is a stream that provides the contents + of an underlying stream starting from the start'th byte + and continuing up to and including the (start + length - 1)'th + byte. + + It relies on skip() working and working efficiently. + It does NOT support mark/reset. + + If it throws an exception at any point, its state becomes + undefined and you should stop using it. + + THREAD-SAFETY: this class is NOT thread-safe on its own.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2InputStreamExcerpt​(java.io.InputStream inputStream, + long start, + long length) 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      intavailable() 
      voidclose() 
      longgetExcerptLength() 
      longgetExcerptStart() 
      intread() 
      intread​(byte[] b) 
      intread​(byte[] b, + int off, + int len) 
      longskip​(long n) 
      +
        +
      • + + +

        Methods inherited from class java.io.InputStream

        +mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, transferTo
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2InputStreamExcerpt

        +
        public B2InputStreamExcerpt​(java.io.InputStream inputStream,
        +                            long start,
        +                            long length)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        read

        +
        public int read()
        +         throws java.io.IOException
        +
        +
        Specified by:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        read

        +
        public int read​(byte[] b)
        +         throws java.io.IOException
        +
        +
        Overrides:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        read

        +
        public int read​(byte[] b,
        +                int off,
        +                int len)
        +         throws java.io.IOException
        +
        +
        Overrides:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        skip

        +
        public long skip​(long n)
        +          throws java.io.IOException
        +
        +
        Overrides:
        +
        skip in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        available

        +
        public int available()
        +              throws java.io.IOException
        +
        +
        Overrides:
        +
        available in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +           throws java.io.IOException
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        Overrides:
        +
        close in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        getExcerptStart

        +
        public long getExcerptStart()
        +
      • +
      + + + +
        +
      • +

        getExcerptLength

        +
        public long getExcerptLength()
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2InputStreamWithByteProgressListener.html b/com/backblaze/b2/util/B2InputStreamWithByteProgressListener.html new file mode 100644 index 000000000..888ae7294 --- /dev/null +++ b/com/backblaze/b2/util/B2InputStreamWithByteProgressListener.html @@ -0,0 +1,449 @@ + + + + + +B2InputStreamWithByteProgressListener (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2InputStreamWithByteProgressListener

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.lang.AutoCloseable
    +
    +
    +
    public class B2InputStreamWithByteProgressListener
    +extends java.io.InputStream
    +
    B2InputStreamWithByteProgressListener provides progress notifications + to a listener. + + If it throws an exception at any point, its state becomes + undefined and you should stop using it. + + THREAD-SAFETY: this class is NOT thread-safe on its own.
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      intavailable() 
      voidclose() 
      intread() 
      intread​(byte[] b) 
      intread​(byte[] b, + int off, + int len) 
      longskip​(long n) 
      +
        +
      • + + +

        Methods inherited from class java.io.InputStream

        +mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, transferTo
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2InputStreamWithByteProgressListener

        +
        public B2InputStreamWithByteProgressListener​(java.io.InputStream inputStream,
        +                                             B2ByteProgressListener listener)
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        read

        +
        public int read()
        +         throws java.io.IOException
        +
        +
        Specified by:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        read

        +
        public int read​(byte[] b)
        +         throws java.io.IOException
        +
        +
        Overrides:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        read

        +
        public int read​(byte[] b,
        +                int off,
        +                int len)
        +         throws java.io.IOException
        +
        +
        Overrides:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        skip

        +
        public long skip​(long n)
        +          throws java.io.IOException
        +
        +
        Overrides:
        +
        skip in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        available

        +
        public int available()
        +              throws java.io.IOException
        +
        +
        Overrides:
        +
        available in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +           throws java.io.IOException
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        Overrides:
        +
        close in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2IoUtils.html b/com/backblaze/b2/util/B2IoUtils.html new file mode 100644 index 000000000..77547a0bd --- /dev/null +++ b/com/backblaze/b2/util/B2IoUtils.html @@ -0,0 +1,360 @@ + + + + + +B2IoUtils (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2IoUtils

+
+
+ +
+
    +
  • +
    +
    public class B2IoUtils
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2IoUtils() 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static voidcloseQuietly​(java.io.Closeable closeable) +
      If closable isn't null, this will close it, ignoring any IOExceptions + that might happen.
      +
      static longcopy​(java.io.InputStream in, + java.io.OutputStream out) +
      Copies the contents of 'in' to 'out' stopping + when it hits the end of 'in' or when it hit an + exception.
      +
      static voidreadToEnd​(java.io.InputStream in) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2IoUtils

        +
        public B2IoUtils()
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        copy

        +
        public static long copy​(java.io.InputStream in,
        +                        java.io.OutputStream out)
        +                 throws java.io.IOException
        +
        Copies the contents of 'in' to 'out' stopping + when it hits the end of 'in' or when it hit an + exception.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        closeQuietly

        +
        public static void closeQuietly​(java.io.Closeable closeable)
        +
        If closable isn't null, this will close it, ignoring any IOExceptions + that might happen. This is especially useful in finally blocks.
        +
        +
        Parameters:
        +
        closeable - the object to close.
        +
        +
      • +
      + + + +
        +
      • +

        readToEnd

        +
        public static void readToEnd​(java.io.InputStream in)
        +                      throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2Md5.html b/com/backblaze/b2/util/B2Md5.html new file mode 100644 index 000000000..64db25ae4 --- /dev/null +++ b/com/backblaze/b2/util/B2Md5.html @@ -0,0 +1,385 @@ + + + + + +B2Md5 (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2Md5

+
+
+
+
    +
  • +
    +
    public interface B2Md5
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static intHEX_MD5_SIZE 
      static intMD5_SIZE 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Static Methods 
      Modifier and TypeMethodDescription
      static byte[]binaryMd5OfBytes​(byte[] bytes) +
      Returns the binary digest of an array of bytes
      +
      static byte[]binaryMd5OfBytes​(byte[] bytes, + int offset, + int length) +
      Returns the binary digest of a subsequence of an array of bytes
      +
      static java.security.MessageDigestgetMd5MessageDigest() +
      Returns an MD5 MessageDigest, which we expect to always be available.
      +
      static java.lang.StringhexMd5OfBytes​(byte[] bytes) +
      Returns the hex digest of an array of bytes.
      +
      static java.lang.StringhexMd5OfBytes​(byte[] bytes, + int offset, + int length) +
      Returns the hex digest of an array of bytes.
      +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMd5MessageDigest

        +
        static java.security.MessageDigest getMd5MessageDigest()
        +
        Returns an MD5 MessageDigest, which we expect to always be available.
        +
      • +
      + + + +
        +
      • +

        binaryMd5OfBytes

        +
        static byte[] binaryMd5OfBytes​(byte[] bytes)
        +
        Returns the binary digest of an array of bytes
        +
      • +
      + + + +
        +
      • +

        binaryMd5OfBytes

        +
        static byte[] binaryMd5OfBytes​(byte[] bytes,
        +                               int offset,
        +                               int length)
        +
        Returns the binary digest of a subsequence of an array of bytes
        +
      • +
      + + + +
        +
      • +

        hexMd5OfBytes

        +
        static java.lang.String hexMd5OfBytes​(byte[] bytes)
        +
        Returns the hex digest of an array of bytes.
        +
      • +
      + + + +
        +
      • +

        hexMd5OfBytes

        +
        static java.lang.String hexMd5OfBytes​(byte[] bytes,
        +                                      int offset,
        +                                      int length)
        +
        Returns the hex digest of an array of bytes.
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2Preconditions.html b/com/backblaze/b2/util/B2Preconditions.html new file mode 100644 index 000000000..f95b5664f --- /dev/null +++ b/com/backblaze/b2/util/B2Preconditions.html @@ -0,0 +1,304 @@ + + + + + +B2Preconditions (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2Preconditions

+
+
+
+
    +
  • +
    +
    public interface B2Preconditions
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Static Methods 
      Modifier and TypeMethodDescription
      static voidcheckArgument​(boolean expr) 
      static voidcheckArgument​(boolean expr, + java.lang.Object msg) 
      static voidcheckArgumentIsNotNull​(java.lang.Object argument, + java.lang.Object argumentName) 
      static voidcheckState​(boolean expr) 
      static voidcheckState​(boolean expr, + java.lang.Object msg) 
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        checkArgument

        +
        static void checkArgument​(boolean expr)
        +
      • +
      + + + +
        +
      • +

        checkArgument

        +
        static void checkArgument​(boolean expr,
        +                          java.lang.Object msg)
        +
      • +
      + + + +
        +
      • +

        checkState

        +
        static void checkState​(boolean expr)
        +
      • +
      + + + +
        +
      • +

        checkState

        +
        static void checkState​(boolean expr,
        +                       java.lang.Object msg)
        +
      • +
      + + + +
        +
      • +

        checkArgumentIsNotNull

        +
        static void checkArgumentIsNotNull​(java.lang.Object argument,
        +                                   java.lang.Object argumentName)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2Sha1.html b/com/backblaze/b2/util/B2Sha1.html new file mode 100644 index 000000000..37a457eee --- /dev/null +++ b/com/backblaze/b2/util/B2Sha1.html @@ -0,0 +1,413 @@ + + + + + +B2Sha1 (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Interface B2Sha1

+
+
+
+
    +
  • +
    +
    public interface B2Sha1
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static intHEX_SHA1_SIZE 
      static intSHA1_SIZE 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Static Methods 
      Modifier and TypeMethodDescription
      static byte[]binarySha1OfBytes​(byte[] data) +
      Returns the SHA-1 of the given bytes, as binary data.
      +
      static byte[]binarySha1OfInputStream​(java.io.InputStream in) +
      Returns the SHA-1 of the given InputStream, as binary data.
      +
      static java.security.MessageDigestcreateSha1MessageDigest() +
      Returns a SHA-1 MessageDigest, which we expect to always be available.
      +
      static booleanequalHexSha1s​(java.lang.String sha1a, + java.lang.String sha1b) +
      This canonicalizes sha1s before comparing them.
      +
      static java.lang.StringhexSha1OfBytes​(byte[] data) +
      Returns the SHA-1 of the given bytes, as a hex string.
      +
      static java.lang.StringhexSha1OfInputStream​(java.io.InputStream in) +
      Returns the SHA-1 of the given input stream, as a hex string.
      +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createSha1MessageDigest

        +
        static java.security.MessageDigest createSha1MessageDigest()
        +
        Returns a SHA-1 MessageDigest, which we expect to always be available.
        +
      • +
      + + + +
        +
      • +

        binarySha1OfBytes

        +
        static byte[] binarySha1OfBytes​(byte[] data)
        +
        Returns the SHA-1 of the given bytes, as binary data.
        +
      • +
      + + + +
        +
      • +

        hexSha1OfBytes

        +
        static java.lang.String hexSha1OfBytes​(byte[] data)
        +
        Returns the SHA-1 of the given bytes, as a hex string.
        +
      • +
      + + + +
        +
      • +

        hexSha1OfInputStream

        +
        static java.lang.String hexSha1OfInputStream​(java.io.InputStream in)
        +                                      throws java.io.IOException
        +
        Returns the SHA-1 of the given input stream, as a hex string.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        binarySha1OfInputStream

        +
        static byte[] binarySha1OfInputStream​(java.io.InputStream in)
        +                               throws java.io.IOException
        +
        Returns the SHA-1 of the given InputStream, as binary data.
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        equalHexSha1s

        +
        static boolean equalHexSha1s​(java.lang.String sha1a,
        +                             java.lang.String sha1b)
        +
        This canonicalizes sha1s before comparing them.
        +
        +
        Parameters:
        +
        sha1a - the first sha1 to compare. must be non-null.
        +
        sha1b - the second sha1 to compare. must be non-null.
        +
        Returns:
        +
        true iff these represent the same sha1.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2Sha1AppenderInputStream.html b/com/backblaze/b2/util/B2Sha1AppenderInputStream.html new file mode 100644 index 000000000..925ba271d --- /dev/null +++ b/com/backblaze/b2/util/B2Sha1AppenderInputStream.html @@ -0,0 +1,306 @@ + + + + + +B2Sha1AppenderInputStream (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2Sha1AppenderInputStream

+
+
+ +
+
    +
  • +
    +
    public class B2Sha1AppenderInputStream
    +extends java.lang.Object
    +
    Use this to create a stream that contains the contents a wrapped stream + concatenated with the sha1 of that stream.
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static java.io.InputStreamcreate​(java.io.InputStream original) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2Sha1AppenderInputStream

        +
        public B2Sha1AppenderInputStream()
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        create

        +
        public static java.io.InputStream create​(java.io.InputStream original)
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2Sha1InputStream.html b/com/backblaze/b2/util/B2Sha1InputStream.html new file mode 100644 index 000000000..147c0693a --- /dev/null +++ b/com/backblaze/b2/util/B2Sha1InputStream.html @@ -0,0 +1,458 @@ + + + + + +B2Sha1InputStream (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2Sha1InputStream

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.lang.AutoCloseable
    +
    +
    +
    public class B2Sha1InputStream
    +extends java.io.InputStream
    +
    Wrapper for an InputStream that computes the SHA1 of the bytes + going through it.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2Sha1InputStream​(java.io.InputStream in) +
      Initializes a stream that will digest all of the bytes read and skipped.
      +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      intavailable() 
      voidclose() 
      byte[]digest() +
      Returns the SHA1 of the bytes processed so far.
      +
      java.lang.StringhexDigest() +
      Returns the SHA1 if the bytes processed so far, as a hex string.
      +
      intread() 
      intread​(byte[] buffer, + int offset, + int length) 
      longskip​(long bytesToSkip) 
      +
        +
      • + + +

        Methods inherited from class java.io.InputStream

        +mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, transferTo
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2Sha1InputStream

        +
        public B2Sha1InputStream​(java.io.InputStream in)
        +
        Initializes a stream that will digest all of the bytes read and skipped.
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        digest

        +
        public byte[] digest()
        +
        Returns the SHA1 of the bytes processed so far.
        +
      • +
      + + + +
        +
      • +

        hexDigest

        +
        public java.lang.String hexDigest()
        +
        Returns the SHA1 if the bytes processed so far, as a hex string.
        +
      • +
      + + + +
        +
      • +

        available

        +
        public int available()
        +              throws java.io.IOException
        +
        +
        Overrides:
        +
        available in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +           throws java.io.IOException
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        Overrides:
        +
        close in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        read

        +
        public int read()
        +         throws java.io.IOException
        +
        +
        Specified by:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        read

        +
        public int read​(byte[] buffer,
        +                int offset,
        +                int length)
        +         throws java.io.IOException
        +
        +
        Overrides:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      + + + +
        +
      • +

        skip

        +
        public long skip​(long bytesToSkip)
        +          throws java.io.IOException
        +
        +
        Overrides:
        +
        skip in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2StringUtil.html b/com/backblaze/b2/util/B2StringUtil.html new file mode 100644 index 000000000..e869d6490 --- /dev/null +++ b/com/backblaze/b2/util/B2StringUtil.html @@ -0,0 +1,523 @@ + + + + + +B2StringUtil (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2StringUtil

+
+
+ +
+
    +
  • +
    +
    public class B2StringUtil
    +extends java.lang.Object
    +
    String utilities
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringUTF8 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static booleandecimalNumberInRange​(java.lang.String str, + int offset, + int length, + int minInclusive, + int maxInclusive) 
      static intdecimalSubstringToInt​(java.lang.String s, + int startIndex, + int endIndex) 
      static byte[]getUtf8Bytes​(java.lang.String str) +
      Returns the UTF-8 representation of a string.
      +
      static booleanisEmpty​(java.lang.String str) 
      static java.lang.Stringjoin​(java.lang.String delimiter, + java.lang.Object[] objects) 
      static java.lang.StringpercentDecode​(java.lang.String s) 
      static java.lang.StringpercentEncode​(java.lang.String s) 
      static booleanstartsWithIgnoreCase​(java.lang.String all, + java.lang.String possiblePrefix) 
      static java.lang.StringtoHexString​(byte[] b) 
      static java.lang.StringunderscoresToCamelCase​(java.lang.String orig, + boolean capitalizeFirstLetter) +
      This returns a new string with the first letter title-cased, and + first character after each "_" title-cased, and all underscores removed.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isEmpty

        +
        public static boolean isEmpty​(java.lang.String str)
        +
        +
        Parameters:
        +
        str - the string to check
        +
        Returns:
        +
        true if str is null or zero-length.
        +
        +
      • +
      + + + +
        +
      • +

        percentEncode

        +
        public static java.lang.String percentEncode​(java.lang.String s)
        +
        +
        Parameters:
        +
        s - the string to encode.
        +
        Returns:
        +
        a string with the contents of 's' encoded with percents as is done for URLs.
        +
        +
      • +
      + + + +
        +
      • +

        percentDecode

        +
        public static java.lang.String percentDecode​(java.lang.String s)
        +
      • +
      + + + +
        +
      • +

        decimalSubstringToInt

        +
        public static int decimalSubstringToInt​(java.lang.String s,
        +                                        int startIndex,
        +                                        int endIndex)
        +
        +
        Parameters:
        +
        s - the string to examine
        +
        startIndex - the index of the first character to examine
        +
        endIndex - the index just past the last character to examine. must be >= startIndex.
        +
        Returns:
        +
        0 if beginIndex == endIndex, otherwise the specified substring of 's' as an integer.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the substring doesn't represent an integer.
        +
        +
      • +
      + + + +
        +
      • +

        decimalNumberInRange

        +
        public static boolean decimalNumberInRange​(java.lang.String str,
        +                                           int offset,
        +                                           int length,
        +                                           int minInclusive,
        +                                           int maxInclusive)
        +
        +
        Parameters:
        +
        str - the string to examine
        +
        offset - index of the first character to examine. must be >= 0.
        +
        length - the length of the substring to examine. must be >= 0.
        +
        minInclusive - the smallest value allowed
        +
        maxInclusive - the largest value allowed
        +
        Returns:
        +
        true iff the specified substring of 'str' is an integer in the specified range.
        +
        +
      • +
      + + + +
        +
      • +

        join

        +
        public static java.lang.String join​(java.lang.String delimiter,
        +                                    java.lang.Object[] objects)
        +
      • +
      + + + +
        +
      • +

        getUtf8Bytes

        +
        public static byte[] getUtf8Bytes​(java.lang.String str)
        +
        Returns the UTF-8 representation of a string. + + We assume that there's always a UTF-8 charset installed, and + it's a bother to catch the exception everywhere, so this method + catches the exception for you.
        +
      • +
      + + + +
        +
      • +

        toHexString

        +
        public static java.lang.String toHexString​(byte[] b)
        +
        +
        Parameters:
        +
        b - the array of bytes to convert.
        +
        Returns:
        +
        if b is null or empty, "". otherwise, returns a string with + two lowercase hex digits for each byte in the string, representing + the value of that byte.
        +
        +
      • +
      + + + +
        +
      • +

        underscoresToCamelCase

        +
        public static java.lang.String underscoresToCamelCase​(java.lang.String orig,
        +                                                      boolean capitalizeFirstLetter)
        +
        This returns a new string with the first letter title-cased, and + first character after each "_" title-cased, and all underscores removed. + For example, "foo" becomes "Foo" and "foo_bar_baz" becomes "FooBarBaz".
        +
        +
        Parameters:
        +
        orig - an input string with "_"s separating words.
        +
        capitalizeFirstLetter - should the first letter be capitalized?
        +
        Returns:
        +
        new, camel-cased version of orig
        +
        +
      • +
      + + + +
        +
      • +

        startsWithIgnoreCase

        +
        public static boolean startsWithIgnoreCase​(java.lang.String all,
        +                                           java.lang.String possiblePrefix)
        +
        +
        Parameters:
        +
        all - the string whose prefix we're checking
        +
        possiblePrefix - the prefix we're asking about being in all.
        +
        Returns:
        +
        true iff both all and possiblePrefix are non-null and + all starts with possiblePrefix ignoring case.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/B2Utf8Util.html b/com/backblaze/b2/util/B2Utf8Util.html new file mode 100644 index 000000000..347c8552b --- /dev/null +++ b/com/backblaze/b2/util/B2Utf8Util.html @@ -0,0 +1,350 @@ + + + + + +B2Utf8Util (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+ +
+
+ +

Class B2Utf8Util

+
+
+ +
+
    +
  • +
    +
    public class B2Utf8Util
    +extends java.lang.Object
    +
    B2Utf8Util has methods that are useful for processing Utf8.
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      B2Utf8Util() 
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static voidwrite​(java.lang.String str, + java.io.OutputStream out) +
      Writes the characters from str to out encoded as UTF-8.
      +
      static voidwriteJsonString​(java.lang.CharSequence value, + java.io.OutputStream out) +
      Writes the characters from str to out encoded as a quoted + JSON string.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
    +
  • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        B2Utf8Util

        +
        public B2Utf8Util()
        +
      • +
      +
    • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        write

        +
        public static void write​(java.lang.String str,
        +                         java.io.OutputStream out)
        +                  throws java.io.IOException
        +
        Writes the characters from str to out encoded as UTF-8.
        +
        +
        Parameters:
        +
        str - the string to convert and write.
        +
        out - the stream to write to
        +
        Throws:
        +
        java.io.IOException - if there's a problem converting to UTF-8 or writing to out. + if an exception is thrown, out's state is undefined.
        +
        +
      • +
      + + + +
        +
      • +

        writeJsonString

        +
        public static void writeJsonString​(java.lang.CharSequence value,
        +                                   java.io.OutputStream out)
        +                            throws java.io.IOException
        +
        Writes the characters from str to out encoded as a quoted + JSON string. This is just like write(), except that it handles + ASCII control characters, double-quotes, and backslashes specially.
        +
        +
        Parameters:
        +
        value - the string to convert and write.
        +
        out - the stream to write to
        +
        Throws:
        +
        java.io.IOException - if there's a problem converting to UTF-8 or writing to out. + if an exception is thrown, out's state is undefined.
        +
        +
      • +
      +
    • +
    +
    +
  • +
+
+
+
+ + + + diff --git a/com/backblaze/b2/util/package-summary.html b/com/backblaze/b2/util/package-summary.html new file mode 100644 index 000000000..5f16bc798 --- /dev/null +++ b/com/backblaze/b2/util/package-summary.html @@ -0,0 +1,279 @@ + + + + + +com.backblaze.b2.util (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package com.backblaze.b2.util

+
+
+ +
+
+ + + diff --git a/com/backblaze/b2/util/package-tree.html b/com/backblaze/b2/util/package-tree.html new file mode 100644 index 000000000..4c7f27e03 --- /dev/null +++ b/com/backblaze/b2/util/package-tree.html @@ -0,0 +1,195 @@ + + + + + +com.backblaze.b2.util Class Hierarchy (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.backblaze.b2.util

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+ + + diff --git a/constant-values.html b/constant-values.html new file mode 100644 index 000000000..a8d1b6083 --- /dev/null +++ b/constant-values.html @@ -0,0 +1,1328 @@ + + + + + +Constant Field Values (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Constant Field Values

+
+

Contents

+ +
+
+
+ + +
+

com.backblaze.*

+ +
    +
  • + + + + + + + + + + + + + + + + + + + +
    com.backblaze.b2.client.exceptions.B2BadRequestException 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringDEFAULT_CODE"bad_request"
    + +public static final intSTATUS400
    +
  • +
  • + + + + + + + + + + + + + + +
    com.backblaze.b2.client.exceptions.B2Exception 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringDEFAULT_CODE"unknown_code"
    +
  • +
  • + + + + + + + + + + + + + + + + + + + +
    com.backblaze.b2.client.exceptions.B2ForbiddenException 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringDEFAULT_CODE"forbidden"
    + +public static final intSTATUS403
    +
  • +
  • + + + + + + + + + + + + + + + + + + + +
    com.backblaze.b2.client.exceptions.B2InternalErrorException 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringDEFAULT_CODE"internal_error"
    + +public static final intSTATUS500
    +
  • +
  • + + + + + + + + + + + + + + +
    com.backblaze.b2.client.exceptions.B2LocalException 
    Modifier and TypeConstant FieldValue
    + +public static final intSTATUS999
    +
  • +
  • + + + + + + + + + + + + + + + + + + + +
    com.backblaze.b2.client.exceptions.B2NotFoundException 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringDEFAULT_CODE"not_found"
    + +public static final intSTATUS404
    +
  • +
  • + + + + + + + + + + + + + + + + + + + +
    com.backblaze.b2.client.exceptions.B2RequestTimeoutException 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringDEFAULT_CODE"request_timeout"
    + +public static final intSTATUS408
    +
  • +
  • + + + + + + + + + + + + + + + + + + + +
    com.backblaze.b2.client.exceptions.B2ServiceUnavailableException 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringDEFAULT_CODE"service_unavailable"
    + +public static final intSTATUS503
    +
  • +
  • + + + + + + + + + + + + + + + + + + + +
    com.backblaze.b2.client.exceptions.B2SignatureVerificationException 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringDEFAULT_CODE"signature_verification_failed"
    + +public static final intSTATUS0
    +
  • +
  • + + + + + + + + + + + + + + + + + + + +
    com.backblaze.b2.client.exceptions.B2TooManyRequestsException 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringDEFAULT_CODE"too_many_requests"
    + +public static final intSTATUS429
    +
  • +
  • + + + + + + + + + + + + + + + + + + + +
    com.backblaze.b2.client.exceptions.B2UnauthorizedException 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringDEFAULT_CODE"unauthorized"
    + +public static final intSTATUS401
    +
  • +
+ + +
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    com.backblaze.b2.util.B2DateTimeUtil 
    Modifier and TypeConstant FieldValue
    + +public static final intMAX_DAY31
    + +public static final intMAX_MONTH12
    + +public static final intMAX_YEAR2999
    + +public static final intMIN_DAY1
    + +public static final intMIN_MONTH1
    + +public static final intMIN_YEAR1970
    + +public static final longONE_SECOND_IN_MILLIS1000L
    +
  • +
  • + + + + + + + + + + + + + + + + + + + +
    com.backblaze.b2.util.B2Md5 
    Modifier and TypeConstant FieldValue
    + +public static final intHEX_MD5_SIZE32
    + +public static final intMD5_SIZE16
    +
  • +
  • + + + + + + + + + + + + + + + + + + + +
    com.backblaze.b2.util.B2Sha1 
    Modifier and TypeConstant FieldValue
    + +public static final intHEX_SHA1_SIZE40
    + +public static final intSHA1_SIZE20
    +
  • +
  • + + + + + + + + + + + + + + +
    com.backblaze.b2.util.B2StringUtil 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringUTF8"UTF-8"
    +
  • +
+
+
+
+ + + diff --git a/deprecated-list.html b/deprecated-list.html new file mode 100644 index 000000000..52d290e91 --- /dev/null +++ b/deprecated-list.html @@ -0,0 +1,213 @@ + + + + + +Deprecated List (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Deprecated API

+

Contents

+ +
+
+ + + + + + + +
+
+ + + diff --git a/element-list b/element-list new file mode 100644 index 000000000..b7ef03889 --- /dev/null +++ b/element-list @@ -0,0 +1,9 @@ +com.backblaze.b2.client +com.backblaze.b2.client.contentHandlers +com.backblaze.b2.client.contentSources +com.backblaze.b2.client.credentialsSources +com.backblaze.b2.client.exceptions +com.backblaze.b2.client.structures +com.backblaze.b2.client.webApiClients +com.backblaze.b2.json +com.backblaze.b2.util diff --git a/help-doc.html b/help-doc.html new file mode 100644 index 000000000..7071d6361 --- /dev/null +++ b/help-doc.html @@ -0,0 +1,272 @@ + + + + + +API Help (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+ +
+This help file applies to API documentation generated by the standard doclet.
+
+ + + diff --git a/index-all.html b/index-all.html new file mode 100644 index 000000000..65b45e5fc --- /dev/null +++ b/index-all.html @@ -0,0 +1,5648 @@ + + + + + +Index (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
A B C D E F G H I J L M N O P R S T U V W Y 
All Classes All Packages + + +

A

+
+
ACCOUNT_AUTHORIZATION - com.backblaze.b2.client.exceptions.B2UnauthorizedException.RequestCategory
+
 
+
advance() - Method in class com.backblaze.b2.client.B2ListFilesIterableBase.IterBase
+
 
+
advance() - Method in class com.backblaze.b2.client.B2ListPartsIterableBase.IterBase
+
 
+
advanceBoth(Duration) - Method in class com.backblaze.b2.util.B2ClockSim
+
+
Shifts the current time by the given duration.
+
+
advanceNow(Duration) - Method in class com.backblaze.b2.util.B2ClockSim
+
+
Shifts the current wall clock time by the given duration.
+
+
ALL_PRIVATE - Static variable in interface com.backblaze.b2.client.structures.B2BucketTypes
+
 
+
ALL_PUBLIC - Static variable in interface com.backblaze.b2.client.structures.B2BucketTypes
+
 
+
ALL_VERSIONS - Static variable in class com.backblaze.b2.json.VersionRange
+
+
Version range that includes all versions.
+
+
ALLOW_EXTRA_FIELDS - Static variable in class com.backblaze.b2.json.B2Json
+
+
Deprecated.
+
+
allVersionsFrom(int) - Static method in class com.backblaze.b2.json.VersionRange
+
+
Factory for a range with a start version that includes all later + versions.
+
+
APPLICATION_OCTET - Static variable in interface com.backblaze.b2.client.contentSources.B2ContentTypes
+
 
+
applicationKeys() - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like applicationKeys(request), except that it makes a request for all + application keys for the account.
+
+
applicationKeys(B2ListKeysRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Returns an iterable whose iterator yields the application keys that + match the given request.
+
+
applicationKeys(B2ListKeysRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
arrayHasMoreValues() - Method in class com.backblaze.b2.json.B2JsonReader
+
+
Are there more values in an array?
+
+
atEnd() - Method in class com.backblaze.b2.client.structures.B2ListFileNamesResponse
+
 
+
atEnd() - Method in interface com.backblaze.b2.client.structures.B2ListFilesResponse
+
 
+
atEnd() - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsResponse
+
 
+
atEnd() - Method in class com.backblaze.b2.client.structures.B2ListPartsResponse
+
 
+
atEnd() - Method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesResponse
+
 
+
AUTHORIZATION - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
authorize(B2StorageClientWebifier) - Method in interface com.backblaze.b2.client.B2AccountAuthorizer
+
+
This will be called to get a new B2AccountAuthorization instance.
+
+
authorize(B2StorageClientWebifier) - Method in class com.backblaze.b2.client.B2AccountAuthorizerSimpleImpl
+
 
+
authorizeAccount(B2AuthorizeAccountRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
authorizeAccount(B2AuthorizeAccountRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
available() - Method in class com.backblaze.b2.util.B2InputStreamExcerpt
+
 
+
available() - Method in class com.backblaze.b2.util.B2InputStreamWithByteProgressListener
+
 
+
available() - Method in class com.backblaze.b2.util.B2Sha1InputStream
+
 
+
+ + + +

B

+
+
B2_AUTO - Static variable in interface com.backblaze.b2.client.contentSources.B2ContentTypes
+
 
+
B2AccountAuthorization - Class in com.backblaze.b2.client.structures
+
 
+
B2AccountAuthorization(String, String, String, String, long, long, B2Allowed, String) - Constructor for class com.backblaze.b2.client.structures.B2AccountAuthorization
+
 
+
B2AccountAuthorizer - Interface in com.backblaze.b2.client
+
+
B2AccountAuthorizer provides a mechanism to get an accountId and + a corresponding B2AccountAuthorization.
+
+
B2AccountAuthorizerSimpleImpl - Class in com.backblaze.b2.client
+
+
B2AccountAuthorizerSimpleImpl is the usual implementation of authorizing.
+
+
B2AccountAuthorizerSimpleImpl.Builder - Class in com.backblaze.b2.client
+
 
+
B2Allowed - Class in com.backblaze.b2.client.structures
+
 
+
B2Allowed(List<String>, String, String, String) - Constructor for class com.backblaze.b2.client.structures.B2Allowed
+
 
+
B2AlreadyStoredPartStorer - Class in com.backblaze.b2.client
+
+
This implementation "stores" a part that has already been successfully + stored in B2.
+
+
B2AlreadyStoredPartStorer(B2Part) - Constructor for class com.backblaze.b2.client.B2AlreadyStoredPartStorer
+
 
+
B2ApplicationKey - Class in com.backblaze.b2.client.structures
+
+
Response from b2_delete_key, and included in response from b2_list_keys.
+
+
B2ApplicationKey(String, String, String, TreeSet<String>, String, String, Long, Set<String>) - Constructor for class com.backblaze.b2.client.structures.B2ApplicationKey
+
 
+
B2AuthorizationFilteredResponseField<T> - Class in com.backblaze.b2.client.structures
+
+
A generic class to represent response fields that are filtered based on authorization + + Parameter T will represent the different types of response field (e.g.
+
+
B2AuthorizationFilteredResponseField(boolean, T) - Constructor for class com.backblaze.b2.client.structures.B2AuthorizationFilteredResponseField
+
 
+
B2AuthorizeAccountRequest - Class in com.backblaze.b2.client.structures
+
+
This structure holds the information for b2_authorize_account.
+
+
B2AuthorizeAccountRequest(String, String) - Constructor for class com.backblaze.b2.client.structures.B2AuthorizeAccountRequest
+
 
+
B2AuthorizeAccountRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2BadRequestException - Exception in com.backblaze.b2.client.exceptions
+
 
+
B2BadRequestException(String, Integer, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2BadRequestException
+
 
+
B2BadRequestException(String, Integer, String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2BadRequestException
+
 
+
B2Bucket - Class in com.backblaze.b2.client.structures
+
 
+
B2Bucket(String, String, String, String, Map<String, String>, List<B2CorsRule>, List<B2LifecycleRule>, Set<String>, B2AuthorizationFilteredResponseField<B2BucketFileLockConfiguration>, B2AuthorizationFilteredResponseField<B2BucketServerSideEncryption>, B2AuthorizationFilteredResponseField<B2BucketReplicationConfiguration>, int) - Constructor for class com.backblaze.b2.client.structures.B2Bucket
+
 
+
B2BucketDefaultRetention - Class in com.backblaze.b2.client.structures
+
 
+
B2BucketDefaultRetention(String, int, String) - Constructor for class com.backblaze.b2.client.structures.B2BucketDefaultRetention
+
 
+
B2BucketDefaultRetention(String, B2BucketDefaultRetentionPeriod) - Constructor for class com.backblaze.b2.client.structures.B2BucketDefaultRetention
+
 
+
B2BucketDefaultRetentionPeriod - Class in com.backblaze.b2.client.structures
+
 
+
B2BucketDefaultRetentionPeriod(int, String) - Constructor for class com.backblaze.b2.client.structures.B2BucketDefaultRetentionPeriod
+
 
+
B2BucketFileLockConfiguration - Class in com.backblaze.b2.client.structures
+
 
+
B2BucketFileLockConfiguration(boolean) - Constructor for class com.backblaze.b2.client.structures.B2BucketFileLockConfiguration
+
 
+
B2BucketFileLockConfiguration(boolean, B2BucketDefaultRetention) - Constructor for class com.backblaze.b2.client.structures.B2BucketFileLockConfiguration
+
 
+
B2BucketFileLockConfiguration(boolean, String, int, String) - Constructor for class com.backblaze.b2.client.structures.B2BucketFileLockConfiguration
+
 
+
B2BucketReplicationConfiguration - Class in com.backblaze.b2.client.structures
+
+
Replication configuration for a bucket.
+
+
B2BucketServerSideEncryption - Class in com.backblaze.b2.client.structures
+
 
+
B2BucketTypes - Interface in com.backblaze.b2.client.structures
+
+
B2BucketTypes provides constants for well-known bucket types.
+
+
B2ByteArrayContentSource - Class in com.backblaze.b2.client.contentSources
+
+
Use B2ByteArrayContentSource to wrap data in memory for uploading to B2.
+
+
B2ByteArrayContentSource.Builder - Class in com.backblaze.b2.client.contentSources
+
 
+
B2ByteProgressListener - Interface in com.backblaze.b2.util
+
+
This listener is called as data is read from an input stream.
+
+
B2ByteRange - Class in com.backblaze.b2.util
+
+
Represents a range of bytes in an HTTP entity.
+
+
B2ByteRange(Long, Long) - Constructor for class com.backblaze.b2.util.B2ByteRange
+
+
Initializes a new B2ByteRange.
+
+
B2CancellableContentSource - Class in com.backblaze.b2.client
+
+
A ContentSource wrapper that returns an InputStream that will check whether + the cancellation token says to stop.
+
+
B2CancellableContentSource(B2ContentSource, B2CancellationToken) - Constructor for class com.backblaze.b2.client.B2CancellableContentSource
+
 
+
B2CancelLargeFileRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2CancelLargeFileRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2CancelLargeFileResponse - Class in com.backblaze.b2.client.structures
+
 
+
B2CancelLargeFileResponse(String, String, String) - Constructor for class com.backblaze.b2.client.structures.B2CancelLargeFileResponse
+
 
+
B2CancellationToken - Class in com.backblaze.b2.client
+
+
Token to pass around whether the caller has cancelled an operation so that + sub tasks can stop their processing.
+
+
B2CancellationToken() - Constructor for class com.backblaze.b2.client.B2CancellationToken
+
 
+
B2CannotComputeException - Exception in com.backblaze.b2.client.exceptions
+
 
+
B2CannotComputeException(String) - Constructor for exception com.backblaze.b2.client.exceptions.B2CannotComputeException
+
 
+
B2Capabilities - Interface in com.backblaze.b2.client.structures
+
+
B2Capabilities provides constants capabilities in application keys.
+
+
B2ClientConfig - Class in com.backblaze.b2.client
+
+
B2ClientConfig describes the various settings the B2 clients need.
+
+
B2ClientConfig.Builder - Class in com.backblaze.b2.client
+
+
The Builder for building a B2ClientConfig.
+
+
B2Clock - Class in com.backblaze.b2.util
+
+
This class provides access to two different time measurements.
+
+
B2Clock() - Constructor for class com.backblaze.b2.util.B2Clock
+
 
+
B2ClockImpl - Class in com.backblaze.b2.util
+
+
B2ClockImpl uses values from the System class to provide a "real" + implementation of B2Clock whose clocks are determined by the system.
+
+
B2ClockImpl() - Constructor for class com.backblaze.b2.util.B2ClockImpl
+
 
+
B2ClockSim - Class in com.backblaze.b2.util
+
+
B2ClockSim provides a simple simulation of a clock, for use in tests.
+
+
B2Collections - Class in com.backblaze.b2.util
+
 
+
B2Collections() - Constructor for class com.backblaze.b2.util.B2Collections
+
 
+
B2ConnectFailedException - Exception in com.backblaze.b2.client.exceptions
+
+
B2ConnectFailedException represents a failure to connect to the + B2 servers.
+
+
B2ConnectFailedException(String, Integer, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2ConnectFailedException
+
 
+
B2ConnectFailedException(String, Integer, String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2ConnectFailedException
+
 
+
B2ConnectionBrokenException - Exception in com.backblaze.b2.client.exceptions
+
+
B2ConnectionBrokenException represents the network connection to + the B2 servers having been closed unexpectedly.
+
+
B2ConnectionBrokenException(String, Integer, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2ConnectionBrokenException
+
 
+
B2ConnectionBrokenException(String, Integer, String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2ConnectionBrokenException
+
 
+
B2ContentFileWriter - Class in com.backblaze.b2.client.contentHandlers
+
+
This is a B2ContentWriter which records the incoming data into a file on disk.
+
+
B2ContentFileWriter.Builder - Class in com.backblaze.b2.client.contentHandlers
+
 
+
B2ContentMemoryWriter - Class in com.backblaze.b2.client.contentHandlers
+
+
This is a B2ContentWriter which records the incoming data into an + in-memory byte array.
+
+
B2ContentMemoryWriter.Builder - Class in com.backblaze.b2.client.contentHandlers
+
 
+
B2ContentOutputStreamWriter - Class in com.backblaze.b2.client.contentHandlers
+
+
B2ContentOutputStreamWriter is a subclass of B2ContentWriter which uses a Helper to + create the OutputStream to write to, and optionally, the InputStream to use to + reread and verify the SHA1.
+
+
B2ContentOutputStreamWriter.Builder - Class in com.backblaze.b2.client.contentHandlers
+
 
+
B2ContentOutputStreamWriter.Helper - Interface in com.backblaze.b2.client.contentHandlers
+
+
A Helper provides the OutputStream(s) to write to and the InputStream(s) + to use to re-read the content after writing it.
+
+
B2ContentSink - Interface in com.backblaze.b2.client.contentHandlers
+
+
Implement B2ContentSink to process files downloaded from B2.
+
+
B2ContentSource - Interface in com.backblaze.b2.client.contentSources
+
+
Implementations of B2ContentSource provide the length, SHA1, and the + bytes that the B2Client should upload.
+
+
B2ContentTypes - Interface in com.backblaze.b2.client.contentSources
+
+
B2ContentTypes provides constants for well-known mime types, especially + ones that have meaning to B2.
+
+
B2ContentWriter - Class in com.backblaze.b2.client.contentHandlers
+
+
B2ContentWriter is a base class for ContentHandlers which writes the content + to a stream.
+
+
B2CopyFileRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2CopyFileRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2CopyingPartStorer - Class in com.backblaze.b2.client
+
+
This implementation stores a part of a large file by copying + from a file that is already stored in B2.
+
+
B2CopyingPartStorer(int, String) - Constructor for class com.backblaze.b2.client.B2CopyingPartStorer
+
 
+
B2CopyingPartStorer(int, String, B2ByteRange) - Constructor for class com.backblaze.b2.client.B2CopyingPartStorer
+
 
+
B2CopyPartRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2CopyPartRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2CorsRule - Class in com.backblaze.b2.client.structures
+
 
+
B2CorsRule.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2CreateBucketRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2CreateBucketRequest(String, String, Map<String, String>, List<B2CorsRule>, List<B2LifecycleRule>, boolean, B2BucketServerSideEncryption, B2BucketReplicationConfiguration) - Constructor for class com.backblaze.b2.client.structures.B2CreateBucketRequest
+
 
+
B2CreateBucketRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2CreateBucketRequestReal - Class in com.backblaze.b2.client.structures
+
+
NOTE: + B2CreateBucketRequestReal has the attributes needed by the B2 API.
+
+
B2CreateBucketRequestReal(String, B2CreateBucketRequest) - Constructor for class com.backblaze.b2.client.structures.B2CreateBucketRequestReal
+
 
+
B2CreatedApplicationKey - Class in com.backblaze.b2.client.structures
+
+
Information returned from b2_create_key.
+
+
B2CreatedApplicationKey(String, String, String, String, TreeSet<String>, String, String, Long, Set<String>) - Constructor for class com.backblaze.b2.client.structures.B2CreatedApplicationKey
+
 
+
B2CreateKeyRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2CreateKeyRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2CreateKeyRequestReal - Class in com.backblaze.b2.client.structures
+
+
b2_create_key request, as sent to service, including the accountId.
+
+
B2CreateKeyRequestReal(String, B2CreateKeyRequest) - Constructor for class com.backblaze.b2.client.structures.B2CreateKeyRequestReal
+
 
+
B2Credentials - Interface in com.backblaze.b2.client.credentialsSources
+
+
Credentials for accessing B2's APIs.
+
+
B2CredentialsFromEnvironmentSource - Class in com.backblaze.b2.client.credentialsSources
+
+
This B2CredentialsSource reads the credentials from two environment variables: + B2_APPLICATION_KEY_ID + B2_APPLICATION_KEY + + If either is missing or empty, getCredentials() will throw.
+
+
B2CredentialsImpl - Class in com.backblaze.b2.client.credentialsSources
+
+
Simple implementation of B2Credentials.
+
+
B2CredentialsSource - Interface in com.backblaze.b2.client.credentialsSources
+
+
A B2CredentialsSource returns credentials.
+
+
B2DateTimeUtil - Class in com.backblaze.b2.util
+
 
+
B2DefaultRetryPolicy - Class in com.backblaze.b2.client
+
+
B2DefaultRetryPolicy implements the retry policy described in the B2 + documentation.
+
+
B2DefaultRetryPolicy() - Constructor for class com.backblaze.b2.client.B2DefaultRetryPolicy
+
 
+
B2DeleteBucketRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2DeleteBucketRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2DeleteBucketRequestReal - Class in com.backblaze.b2.client.structures
+
 
+
B2DeleteBucketRequestReal(String, String) - Constructor for class com.backblaze.b2.client.structures.B2DeleteBucketRequestReal
+
 
+
B2DeleteFileVersionRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2DeleteFileVersionRequest(String, String, boolean) - Constructor for class com.backblaze.b2.client.structures.B2DeleteFileVersionRequest
+
 
+
B2DeleteFileVersionRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2DeleteFileVersionResponse - Class in com.backblaze.b2.client.structures
+
 
+
B2DeleteFileVersionResponse(String, String) - Constructor for class com.backblaze.b2.client.structures.B2DeleteFileVersionResponse
+
 
+
B2DeleteKeyRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2DeleteKeyRequest(String) - Constructor for class com.backblaze.b2.client.structures.B2DeleteKeyRequest
+
 
+
B2DeleteKeyRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2DownloadAuthorization - Class in com.backblaze.b2.client.structures
+
 
+
B2DownloadAuthorization(String, String, String) - Constructor for class com.backblaze.b2.client.structures.B2DownloadAuthorization
+
 
+
B2DownloadByIdRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2DownloadByIdRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2DownloadByNameRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2DownloadByNameRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2ErrorStructure - Class in com.backblaze.b2.client.structures
+
+
This structure describes the json that's returned by b2 for errors.
+
+
B2ErrorStructure(int, String, String) - Constructor for class com.backblaze.b2.client.structures.B2ErrorStructure
+
 
+
B2EventNotification - Class in com.backblaze.b2.client.structures
+
+
The notification that Backblaze sends when object events occur.
+
+
B2EventNotification(List<B2EventNotificationEvent>) - Constructor for class com.backblaze.b2.client.structures.B2EventNotification
+
 
+
B2EventNotificationEvent - Class in com.backblaze.b2.client.structures
+
+
The individual event notification for an object.
+
+
B2EventNotificationEvent(String, String, String, long, String, String, int, String, String, Long, String) - Constructor for class com.backblaze.b2.client.structures.B2EventNotificationEvent
+
 
+
B2EventNotificationRule - Class in com.backblaze.b2.client.structures
+
+
One rule about under what condition(s) to send notifications for events in a bucket.
+
+
B2EventNotificationRule(String, TreeSet<String>, String, B2EventNotificationTargetConfiguration, boolean) - Constructor for class com.backblaze.b2.client.structures.B2EventNotificationRule
+
 
+
B2EventNotificationRule(String, TreeSet<String>, String, B2EventNotificationTargetConfiguration, boolean, Boolean, String) - Constructor for class com.backblaze.b2.client.structures.B2EventNotificationRule
+
 
+
B2EventNotificationTargetConfiguration - Class in com.backblaze.b2.client.structures
+
+
A destination for an event notification.
+
+
B2EventNotificationTargetConfiguration() - Constructor for class com.backblaze.b2.client.structures.B2EventNotificationTargetConfiguration
+
 
+
B2Exception - Exception in com.backblaze.b2.client.exceptions
+
+
B2Exception is a checked exception class that's the base class for + all B2-specific exceptions thrown by b2-sdk-java.
+
+
B2Exception(String, int, Integer, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2Exception
+
 
+
B2Exception(String, int, Integer, String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2Exception
+
 
+
B2ExecutorUtils - Class in com.backblaze.b2.util
+
 
+
B2ExecutorUtils() - Constructor for class com.backblaze.b2.util.B2ExecutorUtils
+
 
+
B2FileContentSource - Class in com.backblaze.b2.client.contentSources
+
 
+
B2FileContentSource.Builder - Class in com.backblaze.b2.client.contentSources
+
 
+
B2FilePolicy - Interface in com.backblaze.b2.client
+
+
B2FilePolicy answers questions about whether to upload a file as a 'small' + file or as a 'large' file.
+
+
B2FileRetention - Class in com.backblaze.b2.client.structures
+
 
+
B2FileRetention(String, Long) - Constructor for class com.backblaze.b2.client.structures.B2FileRetention
+
 
+
B2FileRetentionMode - Interface in com.backblaze.b2.client.structures
+
+
B2FileRetentionMode provides constants for a bucket's default retention mode
+
+
B2FileRetentionPeriodUnit - Interface in com.backblaze.b2.client.structures
+
+
B2FileRetentionPeriodUnit provides constants for a bucket's default retention period
+
+
B2FileSseForRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2FileSseForResponse - Class in com.backblaze.b2.client.structures
+
 
+
B2FileSseForResponse(String, String, String) - Constructor for class com.backblaze.b2.client.structures.B2FileSseForResponse
+
 
+
B2FileVersion - Class in com.backblaze.b2.client.structures
+
+
Information about a file, as returned by the B2 API.
+
+
B2FileVersion(String, String, long, String, String, String, Map<String, String>, String, long, B2AuthorizationFilteredResponseField<B2FileRetention>, B2AuthorizationFilteredResponseField<String>, B2FileSseForResponse, String) - Constructor for class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
B2FinishLargeFileRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2FinishLargeFileRequest(String, List<String>) - Constructor for class com.backblaze.b2.client.structures.B2FinishLargeFileRequest
+
 
+
B2FinishLargeFileRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2FlushAndSyncFileOnCloseOutputStream - Class in com.backblaze.b2.util
+
+
Wrap your FileOutputStreams with a B2FlushAndSyncFileOnCloseOutputStream to ensure that + your files are always sync'd before being closed.
+
+
B2ForbiddenException - Exception in com.backblaze.b2.client.exceptions
+
+
B2ForbiddenException is thrown when an HTTP response has a 403 status code or when a field for which client + does not have necessary read authorization is accessed (e.g., defaultServerSideEncryption in B2Bucket).
+
+
B2ForbiddenException(String, Integer, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2ForbiddenException
+
 
+
B2ForbiddenException(String, Integer, String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2ForbiddenException
+
 
+
B2GetBucketNotificationRulesRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2GetBucketNotificationRulesRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2GetBucketNotificationRulesResponse - Class in com.backblaze.b2.client.structures
+
 
+
B2GetBucketNotificationRulesResponse(String, List<B2EventNotificationRule>) - Constructor for class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesResponse
+
 
+
B2GetBucketNotificationRulesResponse.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2GetDownloadAuthorizationRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2GetDownloadAuthorizationRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2GetFileInfoByNameRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2GetFileInfoByNameRequest(String, String) - Constructor for class com.backblaze.b2.client.structures.B2GetFileInfoByNameRequest
+
 
+
B2GetFileInfoByNameRequest(String, String, B2FileSseForRequest) - Constructor for class com.backblaze.b2.client.structures.B2GetFileInfoByNameRequest
+
 
+
B2GetFileInfoByNameRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2GetFileInfoRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2GetFileInfoRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2GetUploadPartUrlRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2GetUploadPartUrlRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2GetUploadUrlRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2GetUploadUrlRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2Headers - Interface in com.backblaze.b2.client.contentSources
+
+
B2Headers represents the HTTP headers that come with a response from the server.
+
+
B2HeadersImpl - Class in com.backblaze.b2.client.contentSources
+
+
B2HeadersImpl implements the B2Headers interface.
+
+
B2HeadersImpl.Builder - Class in com.backblaze.b2.client.contentSources
+
 
+
B2HideFileRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2HideFileRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2InputStreamExcerpt - Class in com.backblaze.b2.util
+
+
B2InputStreamExcerpt is a stream that provides the contents + of an underlying stream starting from the start'th byte + and continuing up to and including the (start + length - 1)'th + byte.
+
+
B2InputStreamExcerpt(InputStream, long, long) - Constructor for class com.backblaze.b2.util.B2InputStreamExcerpt
+
 
+
B2InputStreamWithByteProgressListener - Class in com.backblaze.b2.util
+
+
B2InputStreamWithByteProgressListener provides progress notifications + to a listener.
+
+
B2InputStreamWithByteProgressListener(InputStream, B2ByteProgressListener) - Constructor for class com.backblaze.b2.util.B2InputStreamWithByteProgressListener
+
 
+
B2InternalErrorException - Exception in com.backblaze.b2.client.exceptions
+
 
+
B2InternalErrorException(String) - Constructor for exception com.backblaze.b2.client.exceptions.B2InternalErrorException
+
 
+
B2InternalErrorException(String, Integer, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2InternalErrorException
+
 
+
B2InternalErrorException(String, Integer, String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2InternalErrorException
+
 
+
B2InternalErrorException(String, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2InternalErrorException
+
 
+
B2IoUtils - Class in com.backblaze.b2.util
+
 
+
B2IoUtils() - Constructor for class com.backblaze.b2.util.B2IoUtils
+
 
+
B2Json - Class in com.backblaze.b2.json
+
+
JSON (de)serialization of Java objects.
+
+
B2Json.constructor - Annotation Type in com.backblaze.b2.json
+
+
Constructor annotation saying that this is the constructor B2Json + should use.
+
+
B2Json.defaultForInvalidEnumValue - Annotation Type in com.backblaze.b2.json
+
+
Field annotation that designates the enum value to use when the + value in a field isn't one of the known values.
+
+
B2Json.defaultForUnknownType - Annotation Type in com.backblaze.b2.json
+
+
Class annotation that applies to a class that is a @union.
+
+
B2Json.firstVersion - Annotation Type in com.backblaze.b2.json
+
+
Annotation that says that a field exists in all versions at or after this one.
+
+
B2Json.ignored - Annotation Type in com.backblaze.b2.json
+
+
Field annotation that says the field is not included in JSON.
+
+
B2Json.optional - Annotation Type in com.backblaze.b2.json
+
+
Field annotation that says a field is optional.
+
+
B2Json.optionalWithDefault - Annotation Type in com.backblaze.b2.json
+
+
Field annotation that says a field is optional.
+
+
B2Json.required - Annotation Type in com.backblaze.b2.json
+
+
Field annotation that says a field is required to be present.
+
+
B2Json.sensitive - Annotation Type in com.backblaze.b2.json
+
+
Annotation that says this is a sensitive field and should be redacted when outputting + for logging
+
+
B2Json.serializedName - Annotation Type in com.backblaze.b2.json
+
+
Annotation to declare that this member will be serialized to JSON + with the specified name, instead of the field name in the Java class.
+
+
B2Json.type - Annotation Type in com.backblaze.b2.json
+
+
Type annotation used to configure B2Json serialization/deserialization.
+
+
B2Json.union - Annotation Type in com.backblaze.b2.json
+
+
Class annotation that says a class is the base class for a union type.
+
+
B2Json.unionSubtypes - Annotation Type in com.backblaze.b2.json
+
+
Class annotation that applies to an interface that is a @union.
+
+
B2Json.unionSubtypes.type - Annotation Type in com.backblaze.b2.json
+
 
+
B2Json.versionRange - Annotation Type in com.backblaze.b2.json
+
+
Annotation that says that a field exists in all versions in a range (inclusive).
+
+
B2JsonAtomicLongArrayHandler - Class in com.backblaze.b2.json
+
 
+
B2JsonAtomicLongArrayHandler(B2JsonTypeHandler<Long>) - Constructor for class com.backblaze.b2.json.B2JsonAtomicLongArrayHandler
+
 
+
B2JsonBadValueException - Exception in com.backblaze.b2.json
+
+
Exception thrown when a value in a JSON object is bad, even though it + is valid JSON.
+
+
B2JsonBadValueException(String) - Constructor for exception com.backblaze.b2.json.B2JsonBadValueException
+
 
+
B2JsonBadValueException(String, Throwable) - Constructor for exception com.backblaze.b2.json.B2JsonBadValueException
+
 
+
B2JsonBigDecimalHandler - Class in com.backblaze.b2.json
+
+
(De)serializes BigDecimal objects.
+
+
B2JsonBigDecimalHandler() - Constructor for class com.backblaze.b2.json.B2JsonBigDecimalHandler
+
 
+
B2JsonBigIntegerHandler - Class in com.backblaze.b2.json
+
+
(De)serializes BigInteger objects.
+
+
B2JsonBigIntegerHandler() - Constructor for class com.backblaze.b2.json.B2JsonBigIntegerHandler
+
 
+
B2JsonBooleanArrayHandler - Class in com.backblaze.b2.json
+
 
+
B2JsonBooleanArrayHandler(B2JsonTypeHandler) - Constructor for class com.backblaze.b2.json.B2JsonBooleanArrayHandler
+
 
+
B2JsonBooleanHandler - Class in com.backblaze.b2.json
+
+
(De)serializes Boolean objects.
+
+
B2JsonBooleanHandler(boolean) - Constructor for class com.backblaze.b2.json.B2JsonBooleanHandler
+
 
+
B2JsonBoundedByteArrayOutputStream - Class in com.backblaze.b2.json
+
+
A B2Json implementation of OutputStream that + - stores stream content in a byte array + - expands capacity when needed (typically doubles) + - has an upper bound limit on output array size (max capacity) + - throws IOException if the max capacity threshold is crossed.
+
+
B2JsonBoundedByteArrayOutputStream(int) - Constructor for class com.backblaze.b2.json.B2JsonBoundedByteArrayOutputStream
+
 
+
B2JsonByteArrayHandler - Class in com.backblaze.b2.json
+
 
+
B2JsonByteArrayHandler(B2JsonTypeHandler) - Constructor for class com.backblaze.b2.json.B2JsonByteArrayHandler
+
 
+
B2JsonByteHandler - Class in com.backblaze.b2.json
+
+
(De)serializes Byte objects.
+
+
B2JsonByteHandler(boolean) - Constructor for class com.backblaze.b2.json.B2JsonByteHandler
+
 
+
B2JsonCharacterHandler - Class in com.backblaze.b2.json
+
+
(De)serializes Character objects.
+
+
B2JsonCharacterHandler(boolean) - Constructor for class com.backblaze.b2.json.B2JsonCharacterHandler
+
 
+
B2JsonCharArrayHandler - Class in com.backblaze.b2.json
+
 
+
B2JsonCharArrayHandler(B2JsonTypeHandler) - Constructor for class com.backblaze.b2.json.B2JsonCharArrayHandler
+
 
+
B2JsonCharSquenceHandler - Class in com.backblaze.b2.json
+
+
(De)serializes CharSequence objects + + When deserializing, the underlying concrete type is String and thus will allocate even + when the JSON input is a string.
+
+
B2JsonCharSquenceHandler() - Constructor for class com.backblaze.b2.json.B2JsonCharSquenceHandler
+
 
+
B2JsonConcurrentMapHandler - Class in com.backblaze.b2.json
+
 
+
B2JsonConcurrentMapHandler(B2JsonTypeHandler, B2JsonTypeHandler) - Constructor for class com.backblaze.b2.json.B2JsonConcurrentMapHandler
+
 
+
B2JsonDoubleArrayHandler - Class in com.backblaze.b2.json
+
 
+
B2JsonDoubleArrayHandler(B2JsonTypeHandler) - Constructor for class com.backblaze.b2.json.B2JsonDoubleArrayHandler
+
 
+
B2JsonDoubleHandler - Class in com.backblaze.b2.json
+
+
(De)serializes Double objects.
+
+
B2JsonDoubleHandler(boolean) - Constructor for class com.backblaze.b2.json.B2JsonDoubleHandler
+
 
+
B2JsonEnumHandler<T> - Class in com.backblaze.b2.json
+
 
+
B2JsonEnumHandler(Class<T>) - Constructor for class com.backblaze.b2.json.B2JsonEnumHandler
+
 
+
B2JsonEnumSetHandler - Class in com.backblaze.b2.json
+
+
Serialization for enum sets.
+
+
B2JsonEnumSetHandler(B2JsonTypeHandler) - Constructor for class com.backblaze.b2.json.B2JsonEnumSetHandler
+
 
+
B2JsonException - Exception in com.backblaze.b2.json
+
+
Exception thrown when there is a problem reading or writing JSON.
+
+
B2JsonException(String) - Constructor for exception com.backblaze.b2.json.B2JsonException
+
 
+
B2JsonException(String, Throwable) - Constructor for exception com.backblaze.b2.json.B2JsonException
+
 
+
B2JsonFloatArrayHandler - Class in com.backblaze.b2.json
+
 
+
B2JsonFloatArrayHandler(B2JsonTypeHandler) - Constructor for class com.backblaze.b2.json.B2JsonFloatArrayHandler
+
 
+
B2JsonFloatHandler - Class in com.backblaze.b2.json
+
+
(De)serializes Float objects.
+
+
B2JsonFloatHandler(boolean) - Constructor for class com.backblaze.b2.json.B2JsonFloatHandler
+
 
+
B2JsonHandlerMap - Class in com.backblaze.b2.json
+
+
Holds a mapping from Class to B2JsonTypeHandler.
+
+
B2JsonHandlerMap() - Constructor for class com.backblaze.b2.json.B2JsonHandlerMap
+
 
+
B2JsonInitializedTypeHandler<T> - Class in com.backblaze.b2.json
+
+
Base class for all implementations of B2JsonTypeHandler that have an initialize() method.
+
+
B2JsonInitializedTypeHandler() - Constructor for class com.backblaze.b2.json.B2JsonInitializedTypeHandler
+
 
+
B2JsonIntArrayHandler - Class in com.backblaze.b2.json
+
 
+
B2JsonIntArrayHandler(B2JsonTypeHandler) - Constructor for class com.backblaze.b2.json.B2JsonIntArrayHandler
+
 
+
B2JsonIntegerHandler - Class in com.backblaze.b2.json
+
+
(De)serializes Integer objects.
+
+
B2JsonIntegerHandler(boolean) - Constructor for class com.backblaze.b2.json.B2JsonIntegerHandler
+
 
+
B2JsonLinkedHashSetHandler - Class in com.backblaze.b2.json
+
 
+
B2JsonLinkedHashSetHandler(B2JsonTypeHandler) - Constructor for class com.backblaze.b2.json.B2JsonLinkedHashSetHandler
+
 
+
B2JsonListHandler - Class in com.backblaze.b2.json
+
 
+
B2JsonListHandler(B2JsonTypeHandler) - Constructor for class com.backblaze.b2.json.B2JsonListHandler
+
 
+
B2JsonLocalDateHandler - Class in com.backblaze.b2.json
+
 
+
B2JsonLocalDateHandler() - Constructor for class com.backblaze.b2.json.B2JsonLocalDateHandler
+
 
+
B2JsonLocalDateTimeHandler - Class in com.backblaze.b2.json
+
 
+
B2JsonLocalDateTimeHandler() - Constructor for class com.backblaze.b2.json.B2JsonLocalDateTimeHandler
+
 
+
B2JsonLongArrayHandler - Class in com.backblaze.b2.json
+
 
+
B2JsonLongArrayHandler(B2JsonTypeHandler) - Constructor for class com.backblaze.b2.json.B2JsonLongArrayHandler
+
 
+
B2JsonLongHandler - Class in com.backblaze.b2.json
+
+
(De)serializes Long objects.
+
+
B2JsonLongHandler(boolean) - Constructor for class com.backblaze.b2.json.B2JsonLongHandler
+
 
+
B2JsonMapHandler - Class in com.backblaze.b2.json
+
 
+
B2JsonMapHandler(B2JsonTypeHandler, B2JsonTypeHandler) - Constructor for class com.backblaze.b2.json.B2JsonMapHandler
+
 
+
B2JsonNonUrlTypeHandler<T> - Class in com.backblaze.b2.json
+
+
Base class for handlers that don't support reading URL parameters.
+
+
B2JsonNonUrlTypeHandler() - Constructor for class com.backblaze.b2.json.B2JsonNonUrlTypeHandler
+
 
+
B2JsonObjectArrayHandler<T> - Class in com.backblaze.b2.json
+
 
+
B2JsonObjectArrayHandler(Class<T>, Class, B2JsonTypeHandler) - Constructor for class com.backblaze.b2.json.B2JsonObjectArrayHandler
+
 
+
B2JsonObjectHandler<T> - Class in com.backblaze.b2.json
+
+
(De)serializes Java objects based on field annotations.
+
+
B2JsonOptions - Class in com.backblaze.b2.json
+
+
Options used by JSON serialization and de-serialization.
+
+
B2JsonOptions.Builder - Class in com.backblaze.b2.json
+
+
Builder for B2JsonOptions
+
+
B2JsonOptions.ExtraFieldOption - Enum in com.backblaze.b2.json
+
+
What to do with extra fields found when de-serializing.
+
+
B2JsonOptions.SerializationOption - Enum in com.backblaze.b2.json
+
+
How to format the serialized string + + PRETTY is the default and produces indented, multi-line JSON + COMPACT produces a single line of text with no optional whitespace
+
+
B2JsonReader - Class in com.backblaze.b2.json
+
+
Reads a stream of characters and converts them to JSON tokens.
+
+
B2JsonReader(Reader) - Constructor for class com.backblaze.b2.json.B2JsonReader
+
+
Initializes a new reader.
+
+
B2JsonSetHandler - Class in com.backblaze.b2.json
+
+
Serialize and deserialize sets
+
+
B2JsonSetHandler(B2JsonTypeHandler) - Constructor for class com.backblaze.b2.json.B2JsonSetHandler
+
 
+
B2JsonStringHandler - Class in com.backblaze.b2.json
+
+
(De)serializes String objects.
+
+
B2JsonStringHandler() - Constructor for class com.backblaze.b2.json.B2JsonStringHandler
+
 
+
B2JsonTreeSetHandler - Class in com.backblaze.b2.json
+
 
+
B2JsonTreeSetHandler(B2JsonTypeHandler) - Constructor for class com.backblaze.b2.json.B2JsonTreeSetHandler
+
 
+
B2JsonTypeHandler<T> - Interface in com.backblaze.b2.json
+
+
Interface for (de)serializing one class of object.
+
+
B2JsonTypeHandlerWithDefaults<T> - Class in com.backblaze.b2.json
+
+
Base class for all handlers that deal with default values.
+
+
B2JsonTypeHandlerWithDefaults() - Constructor for class com.backblaze.b2.json.B2JsonTypeHandlerWithDefaults
+
 
+
B2JsonUnionBaseHandler<T> - Class in com.backblaze.b2.json
+
+
Handler for the class that is the base class for a union type.
+
+
B2JsonUnionTypeMap - Class in com.backblaze.b2.json
+
+
Holds the mapping between type names and the classes used for them in a union type.
+
+
B2JsonUnionTypeMap.Builder - Class in com.backblaze.b2.json
+
 
+
B2JsonUtil - Class in com.backblaze.b2.json
+
 
+
B2JsonUtil() - Constructor for class com.backblaze.b2.json.B2JsonUtil
+
 
+
B2JsonWriter - Class in com.backblaze.b2.json
+
+
Writes out JSON tokens, supports pretty and compact style output.
+
+
B2JsonWriter(OutputStream, B2JsonOptions) - Constructor for class com.backblaze.b2.json.B2JsonWriter
+
 
+
B2LargeFileStorer - Class in com.backblaze.b2.client
+
+
A class for handling the creation of large files.
+
+
B2LegalHold - Interface in com.backblaze.b2.client.structures
+
+
B2LegalHold provides constants for file lock legal hold
+
+
B2LifecycleRule - Class in com.backblaze.b2.client.structures
+
+
One rule about when to delete files in a bucket.
+
+
B2LifecycleRule.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2ListBucketsRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2ListBucketsRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2ListBucketsResponse - Class in com.backblaze.b2.client.structures
+
 
+
B2ListBucketsResponse(List<B2Bucket>) - Constructor for class com.backblaze.b2.client.structures.B2ListBucketsResponse
+
 
+
B2ListFileNamesIterable - Class in com.backblaze.b2.client
+
 
+
B2ListFileNamesIterable(B2StorageClientImpl, B2ListFileNamesRequest) - Constructor for class com.backblaze.b2.client.B2ListFileNamesIterable
+
 
+
B2ListFileNamesRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2ListFileNamesRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2ListFileNamesResponse - Class in com.backblaze.b2.client.structures
+
 
+
B2ListFileNamesResponse(List<B2FileVersion>, String) - Constructor for class com.backblaze.b2.client.structures.B2ListFileNamesResponse
+
 
+
B2ListFilesIterable - Interface in com.backblaze.b2.client
+
+
This interface collects the APIs we provide on our B2FileVersion iterables.
+
+
B2ListFilesIterableBase - Class in com.backblaze.b2.client
+
 
+
B2ListFilesIterableBase.IterBase - Class in com.backblaze.b2.client
+
 
+
B2ListFilesResponse - Interface in com.backblaze.b2.client.structures
+
 
+
B2ListFileVersionsIterable - Class in com.backblaze.b2.client
+
 
+
B2ListFileVersionsIterable(B2StorageClientImpl, B2ListFileVersionsRequest) - Constructor for class com.backblaze.b2.client.B2ListFileVersionsIterable
+
 
+
B2ListFileVersionsRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2ListFileVersionsRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2ListFileVersionsResponse - Class in com.backblaze.b2.client.structures
+
 
+
B2ListFileVersionsResponse(List<B2FileVersion>, String, String) - Constructor for class com.backblaze.b2.client.structures.B2ListFileVersionsResponse
+
 
+
B2ListKeysIterable - Class in com.backblaze.b2.client
+
+
This interface collects the APIs we provide on our B2ApplicationKey iterables.
+
+
B2ListKeysIterable(B2StorageClientImpl, B2ListKeysRequest) - Constructor for class com.backblaze.b2.client.B2ListKeysIterable
+
 
+
B2ListKeysIterator - Class in com.backblaze.b2.client
+
 
+
B2ListKeysRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2ListKeysRequest(Integer, String) - Constructor for class com.backblaze.b2.client.structures.B2ListKeysRequest
+
 
+
B2ListKeysRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2ListKeysRequestReal - Class in com.backblaze.b2.client.structures
+
+
NOTE: + B2ListKeysRequestReal has the attributes needed by the B2 API.
+
+
B2ListKeysRequestReal(String, Integer, String) - Constructor for class com.backblaze.b2.client.structures.B2ListKeysRequestReal
+
 
+
B2ListKeysResponse - Class in com.backblaze.b2.client.structures
+
 
+
B2ListKeysResponse(List<B2ApplicationKey>, String) - Constructor for class com.backblaze.b2.client.structures.B2ListKeysResponse
+
 
+
B2ListPartsIterable - Interface in com.backblaze.b2.client
+
+
This interface collects the APIs we provide on our B2Part iterables.
+
+
B2ListPartsIterableBase - Class in com.backblaze.b2.client
+
 
+
B2ListPartsIterableBase.IterBase - Class in com.backblaze.b2.client
+
 
+
B2ListPartsIterableImpl - Class in com.backblaze.b2.client
+
 
+
B2ListPartsIterableImpl(B2StorageClientImpl, B2ListPartsRequest) - Constructor for class com.backblaze.b2.client.B2ListPartsIterableImpl
+
 
+
B2ListPartsRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2ListPartsRequest(String, Integer, Integer) - Constructor for class com.backblaze.b2.client.structures.B2ListPartsRequest
+
 
+
B2ListPartsRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2ListPartsResponse - Class in com.backblaze.b2.client.structures
+
 
+
B2ListPartsResponse(List<B2Part>, Integer) - Constructor for class com.backblaze.b2.client.structures.B2ListPartsResponse
+
 
+
B2ListUnfinishedLargeFilesIterable - Class in com.backblaze.b2.client
+
 
+
B2ListUnfinishedLargeFilesIterable(B2StorageClientImpl, B2ListUnfinishedLargeFilesRequest) - Constructor for class com.backblaze.b2.client.B2ListUnfinishedLargeFilesIterable
+
 
+
B2ListUnfinishedLargeFilesRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2ListUnfinishedLargeFilesRequest(String, String, String, Integer) - Constructor for class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesRequest
+
 
+
B2ListUnfinishedLargeFilesRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2ListUnfinishedLargeFilesResponse - Class in com.backblaze.b2.client.structures
+
 
+
B2ListUnfinishedLargeFilesResponse(List<B2FileVersion>, String) - Constructor for class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesResponse
+
 
+
B2LocalException - Exception in com.backblaze.b2.client.exceptions
+
+
Instances of B2LocalException represent issues that are detected by the SDK.
+
+
B2LocalException(String, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2LocalException
+
 
+
B2LocalException(String, String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2LocalException
+
 
+
B2Md5 - Interface in com.backblaze.b2.util
+
 
+
B2NetworkBaseException - Exception in com.backblaze.b2.client.exceptions
+
+
Instances of subclasses of B2NetworkExceptions represent issues that appears + to be related to the network.
+
+
B2NetworkException - Exception in com.backblaze.b2.client.exceptions
+
+
B2NetworkTimeoutException represents the network connection to + a B2 server being closed locally because the server + isn't answering in a timely fashion.
+
+
B2NetworkException(String, Integer, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2NetworkException
+
 
+
B2NetworkException(String, Integer, String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2NetworkException
+
 
+
B2NetworkTimeoutException - Exception in com.backblaze.b2.client.exceptions
+
+
B2NetworkTimeoutException represents the network connection to + a B2 server being closed locally because the server + isn't answering in a timely fashion.
+
+
B2NetworkTimeoutException(String, Integer, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2NetworkTimeoutException
+
 
+
B2NetworkTimeoutException(String, Integer, String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2NetworkTimeoutException
+
 
+
B2NotFoundException - Exception in com.backblaze.b2.client.exceptions
+
 
+
B2NotFoundException(Integer, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2NotFoundException
+
 
+
B2NotFoundException(String, Integer, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2NotFoundException
+
 
+
B2NotFoundException(String, Integer, String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2NotFoundException
+
 
+
B2OverrideableHeaders - Interface in com.backblaze.b2.client.structures
+
+
Interface defining getters for headers that can be overridden on download
+
+
B2Part - Class in com.backblaze.b2.client.structures
+
 
+
B2Part(String, int, long, String, String, long, B2FileSseForResponse) - Constructor for class com.backblaze.b2.client.structures.B2Part
+
 
+
B2PartSpec - Class in com.backblaze.b2.client
+
+
A B2PartSpec represents part of a large file.
+
+
B2PartStorer - Interface in com.backblaze.b2.client
+
+
Implementations of B2PartStorer are responsible for storing a single + part of a large file in B2.
+
+
B2Preconditions - Interface in com.backblaze.b2.util
+
 
+
B2ReplicationRule - Class in com.backblaze.b2.client.structures
+
+
One rule about how files should be replicated + to the destination bucket.
+
+
B2ReplicationRule(String, String, int, String, boolean, boolean) - Constructor for class com.backblaze.b2.client.structures.B2ReplicationRule
+
+
Initializes a new, immutable rule.
+
+
B2ReplicationStatus - Interface in com.backblaze.b2.client.structures
+
+
B2ReplicationStatus provides constants for cloud file replication
+
+
B2RequestTimeoutException - Exception in com.backblaze.b2.client.exceptions
+
 
+
B2RequestTimeoutException(String, Integer, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2RequestTimeoutException
+
 
+
B2RequestTimeoutException(String, Integer, String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2RequestTimeoutException
+
 
+
B2RetryPolicy - Interface in com.backblaze.b2.client
+
+
The B2RetryPolicy is called once after each attempt.
+
+
B2RuntimeException - Exception in com.backblaze.b2.client.exceptions
+
+
B2RuntimeExceptions are thrown instead of B2Exceptions in the places + where an interface prevents the SDK from throwing a B2Exception.
+
+
B2RuntimeException(String) - Constructor for exception com.backblaze.b2.client.exceptions.B2RuntimeException
+
 
+
B2RuntimeException(String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2RuntimeException
+
 
+
B2Sdk - Class in com.backblaze.b2.client
+
 
+
B2Sdk() - Constructor for class com.backblaze.b2.client.B2Sdk
+
 
+
B2ServerSideEncryptionMode - Interface in com.backblaze.b2.client.structures
+
+
B2ServerSideEncryptionMode provides constants for the Server-Side Encryption Modes
+
+
B2ServiceUnavailableException - Exception in com.backblaze.b2.client.exceptions
+
 
+
B2ServiceUnavailableException(String, Integer, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2ServiceUnavailableException
+
 
+
B2ServiceUnavailableException(String, Integer, String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2ServiceUnavailableException
+
 
+
B2SetBucketNotificationRulesRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2SetBucketNotificationRulesRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2SetBucketNotificationRulesResponse - Class in com.backblaze.b2.client.structures
+
 
+
B2SetBucketNotificationRulesResponse(String, List<B2EventNotificationRule>) - Constructor for class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesResponse
+
 
+
B2SetBucketNotificationRulesResponse.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2Sha1 - Interface in com.backblaze.b2.util
+
 
+
B2Sha1AppenderInputStream - Class in com.backblaze.b2.util
+
+
Use this to create a stream that contains the contents a wrapped stream + concatenated with the sha1 of that stream.
+
+
B2Sha1AppenderInputStream() - Constructor for class com.backblaze.b2.util.B2Sha1AppenderInputStream
+
 
+
B2Sha1InputStream - Class in com.backblaze.b2.util
+
+
Wrapper for an InputStream that computes the SHA1 of the bytes + going through it.
+
+
B2Sha1InputStream(InputStream) - Constructor for class com.backblaze.b2.util.B2Sha1InputStream
+
+
Initializes a stream that will digest all of the bytes read and skipped.
+
+
B2SignatureVerificationException - Exception in com.backblaze.b2.client.exceptions
+
+
Instances of this class represents failure to verify content given a signature and secret.
+
+
B2SignatureVerificationException(String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2SignatureVerificationException
+
 
+
B2StartLargeFileRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2StartLargeFileRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2StorageClient - Interface in com.backblaze.b2.client
+
+
B2StorageClient is the interface for performing B2 operations.
+
+
B2StorageClientFactory - Interface in com.backblaze.b2.client
+
+
Implementations of B2StorageClientFactory can create a B2StorageClient from a B2ClientConfig.
+
+
B2StorageClientFactoryPathBasedImpl - Class in com.backblaze.b2.client
+
+
This implementation of B2StorageClientFactory has a list of registered class names + and instantiates the first one of those classes which can be loaded.
+
+
B2StorageClientImpl - Class in com.backblaze.b2.client
+
+
B2StorageClientImpl implements B2StorageClient and it acquires credentials as needed + and implements our retry policies.
+
+
B2StorageClientImpl(B2StorageClientWebifier, B2ClientConfig, Supplier<B2RetryPolicy>) - Constructor for class com.backblaze.b2.client.B2StorageClientImpl
+
+
Creates a client with the given webifier and config and a default B2Sleeper.
+
+
B2StorageClientWebifier - Interface in com.backblaze.b2.client
+
+
A B2StorageClientWebifier is responsible for converting from request objects + to web calls and back again.
+
+
B2StorageClientWebifierImpl - Class in com.backblaze.b2.client
+
 
+
B2StorageClientWebifierImpl(B2WebApiClient, String, String, B2TestMode) - Constructor for class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
B2StoreLargeFileRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2StoreLargeFileRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2StringUtil - Class in com.backblaze.b2.util
+
+
String utilities
+
+
B2TestMode - Enum in com.backblaze.b2.client.structures
+
+
TestModes allow the client to ask the server to cause errors to help + with testing the client.
+
+
B2TooManyRequestsException - Exception in com.backblaze.b2.client.exceptions
+
 
+
B2TooManyRequestsException(String, Integer, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2TooManyRequestsException
+
 
+
B2TooManyRequestsException(String, Integer, String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2TooManyRequestsException
+
 
+
B2TypeResolver - Class in com.backblaze.b2.json
+
+
Class used to resolve generic types of a class when supplied with the actual type arguments used to construct an + instance of the class.
+
+
B2TypeResolver(Class<?>) - Constructor for class com.backblaze.b2.json.B2TypeResolver
+
 
+
B2TypeResolver(Class<?>, Type[]) - Constructor for class com.backblaze.b2.json.B2TypeResolver
+
+
Creates a type resolver for the supplied class.
+
+
B2UnauthorizedException - Exception in com.backblaze.b2.client.exceptions
+
 
+
B2UnauthorizedException(String, Integer, String) - Constructor for exception com.backblaze.b2.client.exceptions.B2UnauthorizedException
+
 
+
B2UnauthorizedException(String, Integer, String, Throwable) - Constructor for exception com.backblaze.b2.client.exceptions.B2UnauthorizedException
+
 
+
B2UnauthorizedException.RequestCategory - Enum in com.backblaze.b2.client.exceptions
+
 
+
B2UpdateBucketRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2UpdateBucketRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2UpdateFileLegalHoldRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2UpdateFileLegalHoldRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2UpdateFileLegalHoldResponse - Class in com.backblaze.b2.client.structures
+
 
+
B2UpdateFileLegalHoldResponse(String, String, String) - Constructor for class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldResponse
+
 
+
B2UpdateFileRetentionRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2UpdateFileRetentionRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2UpdateFileRetentionResponse - Class in com.backblaze.b2.client.structures
+
 
+
B2UpdateFileRetentionResponse(String, String, B2FileRetention) - Constructor for class com.backblaze.b2.client.structures.B2UpdateFileRetentionResponse
+
 
+
B2UploadFileRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2UploadFileRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2UploadingPartStorer - Class in com.backblaze.b2.client
+
+
This implementation stores a part of a large file by uploading + the bytes from a B2ContentSource.
+
+
B2UploadingPartStorer(int, B2ContentSource) - Constructor for class com.backblaze.b2.client.B2UploadingPartStorer
+
 
+
B2UploadListener - Interface in com.backblaze.b2.client.structures
+
+
A B2UploadListener is called by periodically by the upload processes to + provide an indication of progress.
+
+
B2UploadPartRequest - Class in com.backblaze.b2.client.structures
+
 
+
B2UploadPartRequest.Builder - Class in com.backblaze.b2.client.structures
+
 
+
B2UploadPartUrlResponse - Class in com.backblaze.b2.client.structures
+
 
+
B2UploadPartUrlResponse(String, String, String) - Constructor for class com.backblaze.b2.client.structures.B2UploadPartUrlResponse
+
 
+
B2UploadProgress - Class in com.backblaze.b2.client.structures
+
+
The B2UploadProgress summarizes the state of an upload.
+
+
B2UploadProgress(int, int, long, long, long, B2UploadState) - Constructor for class com.backblaze.b2.client.structures.B2UploadProgress
+
 
+
B2UploadState - Enum in com.backblaze.b2.client.structures
+
+
+ Generally, uploads follow this state diagram:
+
+
B2UploadUrlResponse - Class in com.backblaze.b2.client.structures
+
 
+
B2UploadUrlResponse(String, String, String) - Constructor for class com.backblaze.b2.client.structures.B2UploadUrlResponse
+
 
+
B2Utf8Util - Class in com.backblaze.b2.util
+
+
B2Utf8Util has methods that are useful for processing Utf8.
+
+
B2Utf8Util() - Constructor for class com.backblaze.b2.util.B2Utf8Util
+
 
+
B2WebApiClient - Interface in com.backblaze.b2.client.webApiClients
+
 
+
B2WebhookConfiguration - Class in com.backblaze.b2.client.structures
+
+
Webhook destination for B2EventNotificationRule
+
+
B2WebhookConfiguration(String) - Constructor for class com.backblaze.b2.client.structures.B2WebhookConfiguration
+
 
+
B2WebhookConfiguration(String, String) - Constructor for class com.backblaze.b2.client.structures.B2WebhookConfiguration
+
 
+
B2WebhookConfiguration(String, TreeSet<B2WebhookCustomHeader>) - Constructor for class com.backblaze.b2.client.structures.B2WebhookConfiguration
+
 
+
B2WebhookConfiguration(String, TreeSet<B2WebhookCustomHeader>, String) - Constructor for class com.backblaze.b2.client.structures.B2WebhookConfiguration
+
 
+
B2WebhookCustomHeader - Class in com.backblaze.b2.client.structures
+
+
Custom headers for B2WebhookConfiguration
+
+
B2WebhookCustomHeader(String, String) - Constructor for class com.backblaze.b2.client.structures.B2WebhookCustomHeader
+
 
+
between(long, long) - Static method in class com.backblaze.b2.util.B2ByteRange
+
 
+
binaryMd5OfBytes(byte[]) - Static method in interface com.backblaze.b2.util.B2Md5
+
+
Returns the binary digest of an array of bytes
+
+
binaryMd5OfBytes(byte[], int, int) - Static method in interface com.backblaze.b2.util.B2Md5
+
+
Returns the binary digest of a subsequence of an array of bytes
+
+
binarySha1OfBytes(byte[]) - Static method in interface com.backblaze.b2.util.B2Sha1
+
+
Returns the SHA-1 of the given bytes, as binary data.
+
+
binarySha1OfInputStream(InputStream) - Static method in interface com.backblaze.b2.util.B2Sha1
+
+
Returns the SHA-1 of the given InputStream, as binary data.
+
+
bucketId - Variable in class com.backblaze.b2.client.structures.B2Allowed
+
 
+
bucketName - Variable in class com.backblaze.b2.client.structures.B2Allowed
+
 
+
buckets() - Method in interface com.backblaze.b2.client.B2StorageClient
+
 
+
build() - Method in class com.backblaze.b2.client.B2AccountAuthorizerSimpleImpl.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.B2ClientConfig.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentFileWriter.Builder
+
 
+
build() - Static method in class com.backblaze.b2.client.contentHandlers.B2ContentMemoryWriter
+
 
+
build() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentMemoryWriter.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentOutputStreamWriter.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.contentSources.B2ByteArrayContentSource.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.contentSources.B2FileContentSource.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.contentSources.B2HeadersImpl.Builder
+
 
+
build() - Static method in class com.backblaze.b2.client.credentialsSources.B2CredentialsFromEnvironmentSource
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2AuthorizeAccountRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2CancelLargeFileRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2CopyPartRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2CorsRule.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2DeleteBucketRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2DeleteFileVersionRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2DeleteKeyRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2FinishLargeFileRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesResponse.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2GetFileInfoByNameRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2GetFileInfoRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2GetUploadPartUrlRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2GetUploadUrlRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2HideFileRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2LifecycleRule.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2ListBucketsRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2ListFileNamesRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2ListKeysRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2ListPartsRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesResponse.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2StoreLargeFileRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2UpdateFileRetentionRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.client.structures.B2UploadPartRequest.Builder
+
 
+
build() - Method in class com.backblaze.b2.json.B2JsonOptions.Builder
+
 
+
build() - Method in class com.backblaze.b2.json.B2JsonUnionTypeMap.Builder
+
+
Builds the B2JsonUnionTypeMap.
+
+
build(byte[]) - Static method in class com.backblaze.b2.client.contentSources.B2ByteArrayContentSource
+
 
+
build(File) - Static method in class com.backblaze.b2.client.contentSources.B2FileContentSource
+
 
+
builder() - Static method in class com.backblaze.b2.client.contentHandlers.B2ContentMemoryWriter
+
 
+
builder() - Static method in class com.backblaze.b2.client.contentSources.B2HeadersImpl
+
 
+
builder() - Static method in class com.backblaze.b2.client.structures.B2ListKeysRequest
+
 
+
builder() - Static method in class com.backblaze.b2.json.B2JsonOptions
+
+
Returns a new builder for B2JsonOptions.
+
+
builder() - Static method in class com.backblaze.b2.json.B2JsonUnionTypeMap
+
 
+
builder(byte[]) - Static method in class com.backblaze.b2.client.contentSources.B2ByteArrayContentSource
+
 
+
builder(int, B2ContentSource) - Static method in class com.backblaze.b2.client.structures.B2UploadPartRequest
+
 
+
builder(int, String, String) - Static method in class com.backblaze.b2.client.structures.B2CopyPartRequest
+
 
+
builder(B2AccountAuthorizer, String) - Static method in class com.backblaze.b2.client.B2ClientConfig
+
 
+
builder(B2ContentOutputStreamWriter.Helper) - Static method in class com.backblaze.b2.client.contentHandlers.B2ContentOutputStreamWriter
+
 
+
builder(B2Headers) - Static method in class com.backblaze.b2.client.contentSources.B2HeadersImpl
+
 
+
builder(B2Bucket) - Static method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest
+
 
+
builder(B2FileVersion) - Static method in class com.backblaze.b2.client.structures.B2StoreLargeFileRequest
+
+
Deprecated.
+
+
builder(B2ListFileNamesRequest) - Static method in class com.backblaze.b2.client.structures.B2ListFileNamesRequest
+
 
+
builder(B2ListFileVersionsRequest) - Static method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest
+
 
+
builder(B2ListPartsRequest) - Static method in class com.backblaze.b2.client.structures.B2ListPartsRequest
+
 
+
builder(B2ListUnfinishedLargeFilesRequest) - Static method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesRequest
+
 
+
builder(File) - Static method in class com.backblaze.b2.client.contentHandlers.B2ContentFileWriter
+
 
+
builder(File) - Static method in class com.backblaze.b2.client.contentSources.B2FileContentSource
+
 
+
builder(String) - Static method in class com.backblaze.b2.client.structures.B2CancelLargeFileRequest
+
 
+
builder(String) - Static method in class com.backblaze.b2.client.structures.B2DeleteBucketRequest
+
 
+
builder(String) - Static method in class com.backblaze.b2.client.structures.B2DeleteKeyRequest
+
 
+
builder(String) - Static method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest
+
 
+
builder(String) - Static method in class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesRequest
+
 
+
builder(String) - Static method in class com.backblaze.b2.client.structures.B2GetFileInfoRequest
+
 
+
builder(String) - Static method in class com.backblaze.b2.client.structures.B2GetUploadPartUrlRequest
+
 
+
builder(String) - Static method in class com.backblaze.b2.client.structures.B2GetUploadUrlRequest
+
 
+
builder(String) - Static method in class com.backblaze.b2.client.structures.B2LifecycleRule
+
 
+
builder(String) - Static method in class com.backblaze.b2.client.structures.B2ListBucketsRequest
+
 
+
builder(String) - Static method in class com.backblaze.b2.client.structures.B2ListFileNamesRequest
+
 
+
builder(String) - Static method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest
+
 
+
builder(String) - Static method in class com.backblaze.b2.client.structures.B2ListPartsRequest
+
 
+
builder(String) - Static method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesRequest
+
 
+
builder(String) - Static method in class com.backblaze.b2.client.structures.B2StoreLargeFileRequest
+
 
+
builder(String, String) - Static method in class com.backblaze.b2.client.B2AccountAuthorizerSimpleImpl
+
 
+
builder(String, String) - Static method in class com.backblaze.b2.client.structures.B2AuthorizeAccountRequest
+
 
+
builder(String, String) - Static method in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
builder(String, String) - Static method in class com.backblaze.b2.client.structures.B2CreateBucketRequest
+
 
+
builder(String, String) - Static method in class com.backblaze.b2.client.structures.B2DeleteFileVersionRequest
+
 
+
builder(String, String) - Static method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
builder(String, String) - Static method in class com.backblaze.b2.client.structures.B2GetFileInfoByNameRequest
+
 
+
builder(String, String) - Static method in class com.backblaze.b2.client.structures.B2HideFileRequest
+
 
+
builder(String, String, int) - Static method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest
+
 
+
builder(String, String, B2FileRetention) - Static method in class com.backblaze.b2.client.structures.B2UpdateFileRetentionRequest
+
 
+
builder(String, String, String) - Static method in class com.backblaze.b2.client.B2ClientConfig
+
 
+
builder(String, String, String) - Static method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest
+
 
+
builder(String, String, String) - Static method in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldRequest
+
 
+
builder(String, String, String, B2ContentSource) - Static method in class com.backblaze.b2.client.structures.B2UploadFileRequest
+
 
+
builder(String, List<B2EventNotificationRule>) - Static method in class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesResponse
+
 
+
builder(String, List<B2EventNotificationRule>) - Static method in class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesRequest
+
 
+
builder(String, List<B2EventNotificationRule>) - Static method in class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesResponse
+
 
+
builder(String, List<String>) - Static method in class com.backblaze.b2.client.structures.B2FinishLargeFileRequest
+
 
+
builder(String, List<String>, Set<String>, int) - Static method in class com.backblaze.b2.client.structures.B2CorsRule
+
 
+
builder(Set<String>, String) - Static method in class com.backblaze.b2.client.structures.B2CreateKeyRequest
+
 
+
Builder() - Constructor for class com.backblaze.b2.client.contentHandlers.B2ContentMemoryWriter.Builder
+
 
+
Builder() - Constructor for class com.backblaze.b2.client.contentSources.B2HeadersImpl.Builder
+
 
+
Builder() - Constructor for class com.backblaze.b2.client.structures.B2ListKeysRequest.Builder
+
 
+
Builder() - Constructor for class com.backblaze.b2.json.B2JsonOptions.Builder
+
 
+
Builder(byte[]) - Constructor for class com.backblaze.b2.client.contentSources.B2ByteArrayContentSource.Builder
+
 
+
Builder(int, String, String) - Constructor for class com.backblaze.b2.client.structures.B2CopyPartRequest.Builder
+
 
+
Builder(B2AccountAuthorizer, String) - Constructor for class com.backblaze.b2.client.B2ClientConfig.Builder
+
 
+
Builder(B2ListFileNamesRequest) - Constructor for class com.backblaze.b2.client.structures.B2ListFileNamesRequest.Builder
+
 
+
Builder(B2ListFileVersionsRequest) - Constructor for class com.backblaze.b2.client.structures.B2ListFileVersionsRequest.Builder
+
 
+
Builder(B2ListPartsRequest) - Constructor for class com.backblaze.b2.client.structures.B2ListPartsRequest.Builder
+
 
+
Builder(B2ListUnfinishedLargeFilesRequest) - Constructor for class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesRequest.Builder
+
 
+
Builder(String) - Constructor for class com.backblaze.b2.client.structures.B2CancelLargeFileRequest.Builder
+
 
+
Builder(String) - Constructor for class com.backblaze.b2.client.structures.B2DeleteBucketRequest.Builder
+
 
+
Builder(String) - Constructor for class com.backblaze.b2.client.structures.B2DeleteKeyRequest.Builder
+
 
+
Builder(String) - Constructor for class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesRequest.Builder
+
 
+
Builder(String) - Constructor for class com.backblaze.b2.client.structures.B2GetFileInfoRequest.Builder
+
 
+
Builder(String) - Constructor for class com.backblaze.b2.client.structures.B2GetUploadPartUrlRequest.Builder
+
 
+
Builder(String) - Constructor for class com.backblaze.b2.client.structures.B2GetUploadUrlRequest.Builder
+
 
+
Builder(String) - Constructor for class com.backblaze.b2.client.structures.B2LifecycleRule.Builder
+
 
+
Builder(String) - Constructor for class com.backblaze.b2.client.structures.B2ListBucketsRequest.Builder
+
 
+
Builder(String) - Constructor for class com.backblaze.b2.client.structures.B2ListPartsRequest.Builder
+
 
+
Builder(String) - Constructor for class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesRequest.Builder
+
 
+
Builder(String, String) - Constructor for class com.backblaze.b2.client.B2AccountAuthorizerSimpleImpl.Builder
+
 
+
Builder(String, String) - Constructor for class com.backblaze.b2.client.structures.B2AuthorizeAccountRequest.Builder
+
 
+
Builder(String, String) - Constructor for class com.backblaze.b2.client.structures.B2CopyFileRequest.Builder
+
 
+
Builder(String, String) - Constructor for class com.backblaze.b2.client.structures.B2DeleteFileVersionRequest.Builder
+
 
+
Builder(String, String) - Constructor for class com.backblaze.b2.client.structures.B2HideFileRequest.Builder
+
 
+
Builder(String, String, int) - Constructor for class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest.Builder
+
 
+
Builder(String, String, B2FileRetention) - Constructor for class com.backblaze.b2.client.structures.B2UpdateFileRetentionRequest.Builder
+
 
+
Builder(String, String, String) - Constructor for class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldRequest.Builder
+
 
+
Builder(String, List<B2EventNotificationRule>) - Constructor for class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesResponse.Builder
+
 
+
Builder(String, List<B2EventNotificationRule>) - Constructor for class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesRequest.Builder
+
 
+
Builder(String, List<B2EventNotificationRule>) - Constructor for class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesResponse.Builder
+
 
+
Builder(String, List<String>) - Constructor for class com.backblaze.b2.client.structures.B2FinishLargeFileRequest.Builder
+
 
+
buildFrom(B2UploadFileRequest) - Static method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest
+
+
This is only public so it is available from other sdk packages.
+
+
BYPASS_GOVERNANCE - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
bypassGovernance - Variable in class com.backblaze.b2.client.structures.B2UpdateFileRetentionRequest
+
 
+
+ + + +

C

+
+
cancelLargeFile(B2AccountAuthorization, B2CancelLargeFileRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
cancelLargeFile(B2AccountAuthorization, B2CancelLargeFileRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
cancelLargeFile(B2CancelLargeFileRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Cancels an unfinished large file.
+
+
cancelLargeFile(B2CancelLargeFileRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
cancelLargeFile(String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like cancelLargeFile(request), except that you only need to specify + the largeFileId for the unfinished large file you're trying to cancel.
+
+
canGetCredentials() - Method in class com.backblaze.b2.client.credentialsSources.B2CredentialsFromEnvironmentSource
+
 
+
capabilities - Variable in class com.backblaze.b2.client.structures.B2Allowed
+
 
+
checkArgument(boolean) - Static method in interface com.backblaze.b2.util.B2Preconditions
+
 
+
checkArgument(boolean, Object) - Static method in interface com.backblaze.b2.util.B2Preconditions
+
 
+
checkArgumentIsNotNull(Object, Object) - Static method in interface com.backblaze.b2.util.B2Preconditions
+
 
+
checkDefaultValues() - Method in class com.backblaze.b2.json.B2JsonObjectHandler
+
+
Checks the validity of all of the default values for fields with optionalWithDefault.
+
+
checkDefaultValues() - Method in class com.backblaze.b2.json.B2JsonTypeHandlerWithDefaults
+
+
Checks whether default values are OK, and throws if not.
+
+
checkDefaultValues() - Method in class com.backblaze.b2.json.B2JsonUnionBaseHandler
+
+
Check the validity of the default value, if there is one.
+
+
checkState(boolean) - Static method in interface com.backblaze.b2.util.B2Preconditions
+
 
+
checkState(boolean, Object) - Static method in interface com.backblaze.b2.util.B2Preconditions
+
 
+
clazz() - Method in annotation type com.backblaze.b2.json.B2Json.unionSubtypes.type
+
 
+
CLIENT_UNAUTHORIZED_TO_READ - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
close() - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Closes this instance, releasing resources.
+
+
close() - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
+
Closes resources used by this client.
+
+
close() - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
+
Closes this object and its underlying resources.
+
+
close() - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
close() - Method in interface com.backblaze.b2.client.webApiClients.B2WebApiClient
+
+
Closes this object and its underlying resources.
+
+
close() - Method in class com.backblaze.b2.util.B2FlushAndSyncFileOnCloseOutputStream
+
 
+
close() - Method in class com.backblaze.b2.util.B2InputStreamExcerpt
+
 
+
close() - Method in class com.backblaze.b2.util.B2InputStreamWithByteProgressListener
+
 
+
close() - Method in class com.backblaze.b2.util.B2Sha1InputStream
+
 
+
closeQuietly(Closeable) - Static method in class com.backblaze.b2.util.B2IoUtils
+
+
If closable isn't null, this will close it, ignoring any IOExceptions + that might happen.
+
+
code - Variable in class com.backblaze.b2.client.structures.B2ErrorStructure
+
+
A single token that indicates the cause of the error.
+
+
com.backblaze.b2.client - package com.backblaze.b2.client
+
 
+
com.backblaze.b2.client.contentHandlers - package com.backblaze.b2.client.contentHandlers
+
 
+
com.backblaze.b2.client.contentSources - package com.backblaze.b2.client.contentSources
+
 
+
com.backblaze.b2.client.credentialsSources - package com.backblaze.b2.client.credentialsSources
+
 
+
com.backblaze.b2.client.exceptions - package com.backblaze.b2.client.exceptions
+
 
+
com.backblaze.b2.client.structures - package com.backblaze.b2.client.structures
+
 
+
com.backblaze.b2.client.webApiClients - package com.backblaze.b2.client.webApiClients
+
 
+
com.backblaze.b2.json - package com.backblaze.b2.json
+
 
+
com.backblaze.b2.util - package com.backblaze.b2.util
+
 
+
COMPACT - com.backblaze.b2.json.B2JsonOptions.SerializationOption
+
 
+
compareTo(B2PartSpec) - Method in class com.backblaze.b2.client.B2PartSpec
+
 
+
compareTo(B2EventNotificationRule) - Method in class com.backblaze.b2.client.structures.B2EventNotificationRule
+
+
Rules are sorted by name first, and then additional attributes if necessary.
+
+
compareTo(B2WebhookCustomHeader) - Method in class com.backblaze.b2.client.structures.B2WebhookCustomHeader
+
+
B2CustomHeaders are sorted (without case sensitivity) by name first, and then value.
+
+
compareTo(FieldInfo) - Method in class com.backblaze.b2.json.FieldInfo
+
 
+
COMPLETED - Static variable in interface com.backblaze.b2.client.structures.B2ReplicationStatus
+
 
+
COMPLIANCE - Static variable in interface com.backblaze.b2.client.structures.B2FileRetentionMode
+
 
+
constructorArgIndex - Variable in class com.backblaze.b2.json.FieldInfo
+
 
+
CONTENT_LENGTH - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
CONTENT_MD5 - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
CONTENT_RANGE - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
CONTENT_SHA1 - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
CONTENT_TYPE - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
copy(InputStream, OutputStream) - Static method in class com.backblaze.b2.util.B2IoUtils
+
+
Copies the contents of 'in' to 'out' stopping + when it hits the end of 'in' or when it hit an + exception.
+
+
COPY_METADATA_DIRECTIVE - Static variable in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
copyFile(B2AccountAuthorization, B2CopyFileRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
copyFile(B2AccountAuthorization, B2CopyFileRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
copyPart(B2AccountAuthorization, B2CopyPartRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
copyPart(B2AccountAuthorization, B2CopyPartRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
copySmallFile(B2CopyFileRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Makes a copy of a file in the same bucket.
+
+
copySmallFile(B2CopyFileRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
couldBeLargeFile(long) - Method in interface com.backblaze.b2.client.B2FilePolicy
+
 
+
create(B2ClientConfig) - Method in interface com.backblaze.b2.client.B2StorageClientFactory
+
 
+
create(B2ClientConfig) - Method in class com.backblaze.b2.client.B2StorageClientFactoryPathBasedImpl
+
 
+
create(File) - Static method in class com.backblaze.b2.util.B2FlushAndSyncFileOnCloseOutputStream
+
 
+
create(FileOutputStream) - Static method in class com.backblaze.b2.util.B2FlushAndSyncFileOnCloseOutputStream
+
 
+
create(InputStream) - Static method in class com.backblaze.b2.util.B2Sha1AppenderInputStream
+
 
+
create(String) - Method in interface com.backblaze.b2.client.B2StorageClientFactory
+
+
Gets the applicationKeyId and applicationKey from the environment and then
+
+
create(String, int, Integer, String) - Static method in exception com.backblaze.b2.client.exceptions.B2Exception
+
+
Returns a new B2Exception, trying to provide the appropriate subclass to + characterize the it.
+
+
create(String, String, String) - Method in interface com.backblaze.b2.client.B2StorageClientFactory
+
 
+
createBucket(B2AccountAuthorization, B2CreateBucketRequestReal) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
createBucket(B2AccountAuthorization, B2CreateBucketRequestReal) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
createBucket(B2CreateBucketRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Creates a new bucket with the given request.
+
+
createBucket(B2CreateBucketRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
createBucket(String, String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Creates a new bucket with the specified bucketName and bucketType + and default settings for all of the other bucket attributes.
+
+
createContentSourceWithRangeOrNull(long, long) - Method in interface com.backblaze.b2.client.contentSources.B2ContentSource
+
+
If possible, this returns a NEW input stream for just the specified range of the + content.
+
+
createDefaultFactory() - Static method in interface com.backblaze.b2.client.B2StorageClientFactory
+
 
+
createDestinationInputStream() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentFileWriter
+
 
+
createDestinationInputStream() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentMemoryWriter
+
 
+
createDestinationInputStream() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentOutputStreamWriter
+
 
+
createDestinationInputStream() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentWriter
+
 
+
createDestinationOutputStream() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentFileWriter
+
 
+
createDestinationOutputStream() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentMemoryWriter
+
 
+
createDestinationOutputStream() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentOutputStreamWriter
+
 
+
createDestinationOutputStream() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentWriter
+
 
+
createForDestination(Map<String, String>) - Static method in class com.backblaze.b2.client.structures.B2BucketReplicationConfiguration
+
+
Returns a B2BucketReplicationConfiguration for a bucket that will only be a replication destination.
+
+
createForSource(String, List<B2ReplicationRule>) - Static method in class com.backblaze.b2.client.structures.B2BucketReplicationConfiguration
+
+
Returns a B2BucketReplicationConfiguration for a bucket that will only be a replication source.
+
+
createForSourceAndDestination(String, List<B2ReplicationRule>, Map<String, String>) - Static method in class com.backblaze.b2.client.structures.B2BucketReplicationConfiguration
+
+
Returns a ReplicationConfiguration for a bucket that will be a replication source and a replication + destination.
+
+
createInputStream() - Method in class com.backblaze.b2.client.B2CancellableContentSource
+
 
+
createInputStream() - Method in interface com.backblaze.b2.client.contentHandlers.B2ContentOutputStreamWriter.Helper
+
+
This might be called multiple times.
+
+
createInputStream() - Method in class com.backblaze.b2.client.contentSources.B2ByteArrayContentSource
+
 
+
createInputStream() - Method in interface com.backblaze.b2.client.contentSources.B2ContentSource
+
+
NOTE: this may be called multiple times as uploads + are retried, etc.
+
+
createInputStream() - Method in class com.backblaze.b2.client.contentSources.B2FileContentSource
+
 
+
createKey(B2AccountAuthorization, B2CreateKeyRequestReal) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
createKey(B2AccountAuthorization, B2CreateKeyRequestReal) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
createKey(B2CreateKeyRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Creates a new application key.
+
+
createKey(B2CreateKeyRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
createOutputStream() - Method in interface com.backblaze.b2.client.contentHandlers.B2ContentOutputStreamWriter.Helper
+
+
This might be called multiple times.
+
+
createSha1MessageDigest() - Static method in interface com.backblaze.b2.util.B2Sha1
+
+
Returns a SHA-1 MessageDigest, which we expect to always be available.
+
+
createSseB2Aes256() - Static method in class com.backblaze.b2.client.structures.B2BucketServerSideEncryption
+
+
Create default bucket server-side encryption configuration with mode of SSE-B2 and algorithm of AES256
+
+
createSseB2Aes256() - Static method in class com.backblaze.b2.client.structures.B2FileSseForRequest
+
+
Creates and returns a B2FileSseForRequest for SSE-B2 with algorithm set to AES256.
+
+
createSseCAes256(String) - Static method in class com.backblaze.b2.client.structures.B2FileSseForRequest
+
+
Creates and returns a B2FileSseForRequest for SSE-C with algorithm set to AES256 and encryption key as specified.
+
+
createSseCAes256(String, String) - Static method in class com.backblaze.b2.client.structures.B2FileSseForRequest
+
+
Creates and returns a B2FileSseForRequest for SSE-C with algorithm set to AES256 and key/MD5 as specified.
+
+
createSseNone() - Static method in class com.backblaze.b2.client.structures.B2BucketServerSideEncryption
+
+
Create default bucket server-side encryption configuration with default encryption disabled.
+
+
createThreadFactory(String) - Static method in class com.backblaze.b2.util.B2ExecutorUtils
+
 
+
CUSTOM_UPLOAD_TIMESTAMP - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
+ + + +

D

+
+
DAYS - Static variable in interface com.backblaze.b2.client.structures.B2FileRetentionPeriodUnit
+
 
+
decimalNumberInRange(String, int, int, int, int) - Static method in class com.backblaze.b2.util.B2StringUtil
+
 
+
decimalSubstringToInt(String, int, int) - Static method in class com.backblaze.b2.util.B2StringUtil
+
 
+
DEFAULT - Static variable in class com.backblaze.b2.json.B2JsonOptions
+
+
The default set of options.
+
+
DEFAULT_AND_ALLOW_EXTRA_FIELDS - Static variable in class com.backblaze.b2.json.B2JsonOptions
+
+
The default set of options, except that extra fields are ignored.
+
+
DEFAULT_CODE - Static variable in exception com.backblaze.b2.client.exceptions.B2BadRequestException
+
 
+
DEFAULT_CODE - Static variable in exception com.backblaze.b2.client.exceptions.B2Exception
+
 
+
DEFAULT_CODE - Static variable in exception com.backblaze.b2.client.exceptions.B2ForbiddenException
+
 
+
DEFAULT_CODE - Static variable in exception com.backblaze.b2.client.exceptions.B2InternalErrorException
+
 
+
DEFAULT_CODE - Static variable in exception com.backblaze.b2.client.exceptions.B2NotFoundException
+
 
+
DEFAULT_CODE - Static variable in exception com.backblaze.b2.client.exceptions.B2RequestTimeoutException
+
 
+
DEFAULT_CODE - Static variable in exception com.backblaze.b2.client.exceptions.B2ServiceUnavailableException
+
 
+
DEFAULT_CODE - Static variable in exception com.backblaze.b2.client.exceptions.B2SignatureVerificationException
+
 
+
DEFAULT_CODE - Static variable in exception com.backblaze.b2.client.exceptions.B2TooManyRequestsException
+
 
+
DEFAULT_CODE - Static variable in exception com.backblaze.b2.client.exceptions.B2UnauthorizedException
+
 
+
defaultValue() - Method in annotation type com.backblaze.b2.json.B2Json.optionalWithDefault
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonAtomicLongArrayHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonBigDecimalHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonBigIntegerHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonBooleanArrayHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonBooleanHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonByteArrayHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonByteHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonCharacterHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonCharArrayHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonCharSquenceHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonConcurrentMapHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonDoubleArrayHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonDoubleHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonEnumHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonEnumSetHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonFloatArrayHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonFloatHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonIntArrayHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonIntegerHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonLinkedHashSetHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonListHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonLocalDateHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonLocalDateTimeHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonLongArrayHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonLongHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonMapHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonObjectArrayHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonObjectHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonSetHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonStringHandler
+
 
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonTreeSetHandler
+
 
+
defaultValueForOptional() - Method in interface com.backblaze.b2.json.B2JsonTypeHandler
+
+
Returns the default value to use when an optional field is not present.
+
+
defaultValueForOptional() - Method in class com.backblaze.b2.json.B2JsonUnionBaseHandler
+
 
+
defaultValueJsonOrNull - Variable in class com.backblaze.b2.json.FieldInfo
+
 
+
DELETE_BUCKETS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
DELETE_FILES - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
DELETE_KEYS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
deleteAllFilesInBucket(String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Delete all files in bucket.
+
+
deleteBucket(B2AccountAuthorization, B2DeleteBucketRequestReal) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
deleteBucket(B2AccountAuthorization, B2DeleteBucketRequestReal) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
deleteBucket(B2DeleteBucketRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Deletes the specified bucket.
+
+
deleteBucket(B2DeleteBucketRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
deleteBucket(String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like deleteBucket(request) except that the request is created + from the specified bucketId.
+
+
deleteFileVersion(B2AccountAuthorization, B2DeleteFileVersionRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
deleteFileVersion(B2AccountAuthorization, B2DeleteFileVersionRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
deleteFileVersion(B2DeleteFileVersionRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Deletes the specified file version.
+
+
deleteFileVersion(B2DeleteFileVersionRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
deleteFileVersion(B2FileVersion) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like deleteFileVersion(request), except that the request is created from + the specified fileVersion.
+
+
deleteFileVersion(String, String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like deleteFileVersion(request), except that the request is created from + the specified fileName and fileId.
+
+
deleteKey(B2AccountAuthorization, B2DeleteKeyRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
deleteKey(B2AccountAuthorization, B2DeleteKeyRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
deleteKey(B2DeleteKeyRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Deletes the specified application key.
+
+
deleteKey(B2DeleteKeyRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonAtomicLongArrayHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonBigDecimalHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonBigIntegerHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonBooleanArrayHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonBooleanHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonByteArrayHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonByteHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonCharacterHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonCharArrayHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonCharSquenceHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonConcurrentMapHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonDoubleArrayHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonDoubleHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonEnumHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonEnumSetHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonFloatArrayHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonFloatHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonIntArrayHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonIntegerHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonLinkedHashSetHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonListHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonLocalDateHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonLocalDateTimeHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonLongArrayHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonLongHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonMapHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonObjectArrayHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonObjectHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonSetHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonStringHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonTreeSetHandler
+
 
+
deserialize(B2JsonReader, B2JsonOptions) - Method in interface com.backblaze.b2.json.B2JsonTypeHandler
+
+
Deserialize one object from a JSON input stream.
+
+
deserialize(B2JsonReader, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonUnionBaseHandler
+
 
+
deserializeFromFieldNameToValueMap(Map<String, Object>, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonObjectHandler
+
 
+
deserializeFromUrlParameterMap(Map<String, String>, B2JsonOptions) - Method in class com.backblaze.b2.json.B2JsonObjectHandler
+
 
+
deserializeMaybeNull(B2JsonTypeHandler<T>, B2JsonReader, B2JsonOptions) - Static method in class com.backblaze.b2.json.B2JsonUtil
+
+
Deserialize an object that may be null.
+
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonBigDecimalHandler
+
 
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonBigIntegerHandler
+
 
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonBooleanHandler
+
 
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonByteHandler
+
 
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonCharacterHandler
+
 
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonCharSquenceHandler
+
 
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonDoubleHandler
+
 
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonEnumHandler
+
 
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonFloatHandler
+
 
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonIntegerHandler
+
 
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonLocalDateHandler
+
 
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonLocalDateTimeHandler
+
 
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonLongHandler
+
 
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonNonUrlTypeHandler
+
 
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonObjectHandler
+
 
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonStringHandler
+
 
+
deserializeUrlParam(String) - Method in interface com.backblaze.b2.json.B2JsonTypeHandler
+
+
When an API is called with GET, this is used to deserialize one of the + values.
+
+
deserializeUrlParam(String) - Method in class com.backblaze.b2.json.B2JsonUnionBaseHandler
+
 
+
digest() - Method in class com.backblaze.b2.util.B2Sha1InputStream
+
+
Returns the SHA1 of the bytes processed so far.
+
+
discards() - Method in annotation type com.backblaze.b2.json.B2Json.constructor
+
 
+
discards() - Method in annotation type com.backblaze.b2.json.B2Json.type
+
+
When discards is non-empty, is a comma-separated list of field names which are + allowed to be present in the parsed json, + but whose values will be discarded.
+
+
downloadById(B2AccountAuthorization, B2DownloadByIdRequest, B2ContentSink) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
downloadById(B2AccountAuthorization, B2DownloadByIdRequest, B2ContentSink) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
downloadById(B2DownloadByIdRequest, B2ContentSink) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Asks to download the specified file by id.
+
+
downloadById(B2DownloadByIdRequest, B2ContentSink) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
downloadById(String, B2ContentSink) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like downloadById(request), but you only have to specify the fileId + instead of a request object.
+
+
downloadByName(B2AccountAuthorization, B2DownloadByNameRequest, B2ContentSink) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
downloadByName(B2AccountAuthorization, B2DownloadByNameRequest, B2ContentSink) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
downloadByName(B2DownloadByNameRequest, B2ContentSink) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Asks to download the specified file by bucket name and file name.
+
+
downloadByName(B2DownloadByNameRequest, B2ContentSink) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
downloadByName(String, String, B2ContentSink) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like downloadByName(request), but you only have to specify the + bucketName and the fileName instead of a request object.
+
+
durationString(long) - Static method in class com.backblaze.b2.util.B2DateTimeUtil
+
 
+
+ + + +

E

+
+
effectiveRange(long) - Method in class com.backblaze.b2.util.B2ByteRange
+
+
Return an equivalent byte range with both start and end set, and + with both being valid indexes into the entity.
+
+
end - Variable in class com.backblaze.b2.util.B2ByteRange
+
+
The index of the last byte in the range, inclusive.
+
+
equalHexSha1s(String, String) - Static method in interface com.backblaze.b2.util.B2Sha1
+
+
This canonicalizes sha1s before comparing them.
+
+
equals(Object) - Method in class com.backblaze.b2.client.B2AlreadyStoredPartStorer
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.B2ClientConfig
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.B2CopyingPartStorer
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.B2PartSpec
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.B2UploadingPartStorer
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2AccountAuthorization
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2Allowed
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2ApplicationKey
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2AuthorizationFilteredResponseField
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2AuthorizeAccountRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2Bucket
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2BucketDefaultRetention
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2BucketDefaultRetentionPeriod
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2BucketFileLockConfiguration
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2BucketReplicationConfiguration
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2BucketServerSideEncryption
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2CancelLargeFileRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2CancelLargeFileResponse
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2CopyPartRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2CorsRule
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequestReal
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2CreatedApplicationKey
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequestReal
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2DeleteBucketRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2DeleteBucketRequestReal
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2DeleteFileVersionRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2DeleteFileVersionResponse
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2DeleteKeyRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2EventNotification
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2EventNotificationEvent
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2EventNotificationRule
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2FileRetention
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2FileSseForRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2FileSseForResponse
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2FinishLargeFileRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesResponse
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2GetFileInfoByNameRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2GetFileInfoRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2GetUploadPartUrlRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2GetUploadUrlRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2HideFileRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2LifecycleRule
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2ListBucketsRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2ListBucketsResponse
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2ListFileNamesRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2ListFileNamesResponse
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsResponse
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2ListKeysRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2ListKeysRequestReal
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2ListKeysResponse
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2ListPartsRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2ListPartsResponse
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesResponse
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2Part
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2ReplicationRule
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesResponse
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2StoreLargeFileRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldResponse
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2UpdateFileRetentionRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2UpdateFileRetentionResponse
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2UploadPartRequest
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2UploadPartUrlResponse
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2UploadProgress
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2UploadUrlResponse
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2WebhookConfiguration
+
 
+
equals(Object) - Method in class com.backblaze.b2.client.structures.B2WebhookCustomHeader
+
 
+
equals(Object) - Method in class com.backblaze.b2.util.B2ByteRange
+
 
+
ERROR - com.backblaze.b2.json.B2JsonOptions.ExtraFieldOption
+
 
+
EXPECT - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
EXPIRE_SOME_ACCOUNT_AUTHORIZATION_TOKENS - com.backblaze.b2.client.structures.B2TestMode
+
 
+
+ + + +

F

+
+
FAIL_SOME_UPLOADS - com.backblaze.b2.client.structures.B2TestMode
+
 
+
failed() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentOutputStreamWriter
+
 
+
failed() - Method in interface com.backblaze.b2.client.contentHandlers.B2ContentOutputStreamWriter.Helper
+
+
Called after the download fails (if it got as far as calling createOutputStream()).
+
+
failed() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentWriter
+
+
Called after we've created an output stream, but then the download failed for some reason.
+
+
FAILED - com.backblaze.b2.client.structures.B2UploadState
+
 
+
FAILED - Static variable in interface com.backblaze.b2.client.structures.B2ReplicationStatus
+
 
+
field - Variable in class com.backblaze.b2.json.FieldInfo
+
 
+
FieldInfo - Class in com.backblaze.b2.json
+
+
Information for one field in an object that is (de)serialized.
+
+
FieldInfo.FieldRequirement - Enum in com.backblaze.b2.json
+
 
+
FILE_ID - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
FILE_INFO_PREFIX - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
FILE_LEGAL_HOLD - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
FILE_NAME - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
FILE_RETENTION_MODE - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
FILE_RETENTION_RETAIN_UNTIL_TIMESTAMP - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
fileId - Variable in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldRequest
+
 
+
fileId - Variable in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldResponse
+
 
+
fileId - Variable in class com.backblaze.b2.client.structures.B2UpdateFileRetentionRequest
+
 
+
fileId - Variable in class com.backblaze.b2.client.structures.B2UpdateFileRetentionResponse
+
 
+
fileName - Variable in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldRequest
+
 
+
fileName - Variable in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldResponse
+
 
+
fileName - Variable in class com.backblaze.b2.client.structures.B2UpdateFileRetentionRequest
+
 
+
fileName - Variable in class com.backblaze.b2.client.structures.B2UpdateFileRetentionResponse
+
 
+
fileNames(B2ListFileNamesRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Returns an iterable whose iterator yields the fileNames that match the given request.
+
+
fileNames(B2ListFileNamesRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
fileNames(String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like fileNames(request), except that it makes a request for all + fileNames in the specified bucket.
+
+
fileRetention - Variable in class com.backblaze.b2.client.structures.B2UpdateFileRetentionRequest
+
 
+
fileRetention - Variable in class com.backblaze.b2.client.structures.B2UpdateFileRetentionResponse
+
 
+
fileVersions(B2ListFileVersionsRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Returns an iterable whose iterator yields the fileVersions that match the given request.
+
+
fileVersions(B2ListFileVersionsRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
fileVersions(String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like fileVersions(request), except that it makes a request for all + fileVersions in the specified bucket.
+
+
finishArray() - Method in class com.backblaze.b2.json.B2JsonReader
+
+
Reads the close bracket for an array.
+
+
finishArray() - Method in class com.backblaze.b2.json.B2JsonWriter
+
 
+
finishLargeFile(B2AccountAuthorization, B2FinishLargeFileRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
finishLargeFile(B2AccountAuthorization, B2FinishLargeFileRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
finishLargeFile(B2FinishLargeFileRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
This method allows the caller to finish a large file.
+
+
finishLargeFile(B2FinishLargeFileRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
finishObject() - Method in class com.backblaze.b2.json.B2JsonReader
+
+
Reads the close brace for an object.
+
+
finishObject() - Method in class com.backblaze.b2.json.B2JsonWriter
+
 
+
finishUploadingLargeFile(B2FileVersion, B2UploadFileRequest, ExecutorService) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Verifies that the given fileVersion represents an unfinished large file + and that the specified content is compatible-enough with the information + in that B2FileVersion.
+
+
finishUploadingLargeFile(B2FileVersion, B2UploadFileRequest, ExecutorService) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
firstVersion() - Method in annotation type com.backblaze.b2.json.B2Json.firstVersion
+
 
+
firstVersion() - Method in annotation type com.backblaze.b2.json.B2Json.versionRange
+
 
+
flush() - Method in class com.backblaze.b2.util.B2FlushAndSyncFileOnCloseOutputStream
+
 
+
FOLDER_ACTION - Static variable in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
FORCE_CAP_EXCEEDED - com.backblaze.b2.client.structures.B2TestMode
+
 
+
forLocalContent(B2FileVersion, B2ContentSource, B2PartSizes, B2AccountAuthorizationCache, B2StorageClientWebifier, B2Retryer, Supplier<B2RetryPolicy>, ExecutorService) - Static method in class com.backblaze.b2.client.B2LargeFileStorer
+
 
+
forLocalContent(B2StoreLargeFileRequest, B2ContentSource, B2PartSizes, B2AccountAuthorizationCache, B2StorageClientWebifier, B2Retryer, Supplier<B2RetryPolicy>, ExecutorService) - Static method in class com.backblaze.b2.client.B2LargeFileStorer
+
 
+
forLocalContent(B2StoreLargeFileRequest, B2ContentSource, B2PartSizes, B2AccountAuthorizationCache, B2StorageClientWebifier, B2Retryer, Supplier<B2RetryPolicy>, ExecutorService, boolean) - Static method in class com.backblaze.b2.client.B2LargeFileStorer
+
 
+
formatFguidDateTime(LocalDateTime) - Static method in class com.backblaze.b2.util.B2DateTimeUtil
+
+
Returns a date-time in FGUID form: "d20150315_m092654"
+
+
formatSolidDate(LocalDate) - Static method in class com.backblaze.b2.util.B2DateTimeUtil
+
+
Formats a date in "solid" format, like "20150314"
+
+
fromJson(byte[], Class<T>) - Method in class com.backblaze.b2.json.B2Json
+
+
Parse JSON as an object of the given class.
+
+
fromJson(byte[], Class<T>, int) - Method in class com.backblaze.b2.json.B2Json
+
+
Deprecated.
+
+
fromJson(byte[], Class<T>, B2JsonOptions) - Method in class com.backblaze.b2.json.B2Json
+
 
+
fromJson(InputStream, Class<T>) - Method in class com.backblaze.b2.json.B2Json
+
+
Parse JSON as an object of the given class with the given options.
+
+
fromJson(InputStream, Class<T>, int) - Method in class com.backblaze.b2.json.B2Json
+
+
Deprecated.
+
+
fromJson(InputStream, Type, B2JsonOptions) - Method in class com.backblaze.b2.json.B2Json
+
+
Parse the bytes from an InputStream as JSON using the supplied options, returning the parsed object.
+
+
fromJson(Reader, Class<T>) - Method in class com.backblaze.b2.json.B2Json
+
+
Parse JSON as an object of the given class with the given options.
+
+
fromJson(Reader, Type, B2JsonOptions) - Method in class com.backblaze.b2.json.B2Json
+
+
Parse the bytes from a Reader as JSON using the supplied options, returning the parsed object.
+
+
fromJson(String, Class<T>) - Method in class com.backblaze.b2.json.B2Json
+
+
Parse JSON as an object of the given class.
+
+
fromJson(String, Class<T>, int) - Method in class com.backblaze.b2.json.B2Json
+
+
Deprecated.
+
+
fromJson(String, Class<T>, B2JsonOptions) - Method in class com.backblaze.b2.json.B2Json
+
 
+
fromJsonOrThrowRuntime(String, Class<T>) - Static method in class com.backblaze.b2.json.B2Json
+
+
Parse an assumed JSON string into a defined class.
+
+
fromJsonOrThrowRuntime(String, Class<T>, B2JsonOptions) - Static method in class com.backblaze.b2.json.B2Json
+
 
+
fromJsonUntilEof(InputStream, Class<T>) - Method in class com.backblaze.b2.json.B2Json
+
+
Parse JSON as an object of the given class with the given options, + reading from the input stream until reaching EOF.
+
+
fromJsonUntilEof(InputStream, Class<T>, int) - Method in class com.backblaze.b2.json.B2Json
+
+
Deprecated.
+
+
fromJsonUntilEof(InputStream, Class<T>, B2JsonOptions) - Method in class com.backblaze.b2.json.B2Json
+
 
+
fromUrlParameterMap(Map<String, String>, Class<T>) - Method in class com.backblaze.b2.json.B2Json
+
+
Parse a URL parameter map as an object of the given class.
+
+
fromUrlParameterMap(Map<String, String>, Class<T>, int) - Method in class com.backblaze.b2.json.B2Json
+
+
Deprecated.
+
+
fromUrlParameterMap(Map<String, String>, Class<T>, B2JsonOptions) - Method in class com.backblaze.b2.json.B2Json
+
 
+
+ + + +

G

+
+
get() - Static method in class com.backblaze.b2.json.B2Json
+
 
+
get() - Static method in class com.backblaze.b2.util.B2Clock
+
 
+
getAbsoluteMinimumPartSize() - Method in class com.backblaze.b2.client.structures.B2AccountAuthorization
+
 
+
getAccountAuthorization() - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
This method provides access to an account authorization structure.
+
+
getAccountAuthorization() - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
getAccountAuthorizer() - Method in class com.backblaze.b2.client.B2ClientConfig
+
 
+
getAccountId() - Method in interface com.backblaze.b2.client.B2StorageClient
+
 
+
getAccountId() - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
getAccountId() - Method in class com.backblaze.b2.client.structures.B2AccountAuthorization
+
 
+
getAccountId() - Method in class com.backblaze.b2.client.structures.B2ApplicationKey
+
 
+
getAccountId() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
 
+
getAccountId() - Method in class com.backblaze.b2.client.structures.B2CreatedApplicationKey
+
 
+
getAccountId() - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequestReal
+
 
+
getAccountId() - Method in class com.backblaze.b2.client.structures.B2DeleteBucketRequestReal
+
 
+
getAccountId() - Method in class com.backblaze.b2.client.structures.B2EventNotificationEvent
+
+
The ID of the account where the objects reside that corresponds to the event.
+
+
getAccountId() - Method in class com.backblaze.b2.client.structures.B2ListBucketsRequest
+
 
+
getAccountId() - Method in class com.backblaze.b2.client.structures.B2ListKeysRequestReal
+
 
+
getAccountId() - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest
+
 
+
getAction() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
getAlgorithm() - Method in class com.backblaze.b2.client.structures.B2BucketServerSideEncryption
+
 
+
getAlgorithm() - Method in class com.backblaze.b2.client.structures.B2FileSseForRequest
+
 
+
getAlgorithm() - Method in class com.backblaze.b2.client.structures.B2FileSseForResponse
+
 
+
getAllowed() - Method in class com.backblaze.b2.client.structures.B2AccountAuthorization
+
 
+
getAllowedHeaders() - Method in class com.backblaze.b2.client.structures.B2CorsRule
+
 
+
getAllowedOperations() - Method in class com.backblaze.b2.client.structures.B2CorsRule
+
 
+
getAllowedOrigins() - Method in class com.backblaze.b2.client.structures.B2CorsRule
+
 
+
getApiUrl() - Method in class com.backblaze.b2.client.structures.B2AccountAuthorization
+
 
+
getApplicationKey() - Method in interface com.backblaze.b2.client.credentialsSources.B2Credentials
+
 
+
getApplicationKey() - Method in class com.backblaze.b2.client.credentialsSources.B2CredentialsImpl
+
 
+
getApplicationKey() - Method in class com.backblaze.b2.client.structures.B2AuthorizeAccountRequest
+
 
+
getApplicationKey() - Method in class com.backblaze.b2.client.structures.B2CreatedApplicationKey
+
 
+
getApplicationKeyId() - Method in interface com.backblaze.b2.client.credentialsSources.B2Credentials
+
 
+
getApplicationKeyId() - Method in class com.backblaze.b2.client.credentialsSources.B2CredentialsImpl
+
 
+
getApplicationKeyId() - Method in class com.backblaze.b2.client.structures.B2ApplicationKey
+
 
+
getApplicationKeyId() - Method in class com.backblaze.b2.client.structures.B2AuthorizeAccountRequest
+
 
+
getApplicationKeyId() - Method in class com.backblaze.b2.client.structures.B2CreatedApplicationKey
+
 
+
getApplicationKeyId() - Method in class com.backblaze.b2.client.structures.B2DeleteKeyRequest
+
 
+
getAuthorizationToken() - Method in class com.backblaze.b2.client.structures.B2AccountAuthorization
+
 
+
getAuthorizationToken() - Method in class com.backblaze.b2.client.structures.B2DownloadAuthorization
+
 
+
getAuthorizationToken() - Method in class com.backblaze.b2.client.structures.B2UploadPartUrlResponse
+
 
+
getAuthorizationToken() - Method in class com.backblaze.b2.client.structures.B2UploadUrlResponse
+
 
+
getB2CacheControl() - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest
+
 
+
getB2CacheControl() - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
getB2CacheControl() - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest
+
 
+
getB2CacheControl() - Method in interface com.backblaze.b2.client.structures.B2OverrideableHeaders
+
 
+
getB2ContentDisposition() - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest
+
 
+
getB2ContentDisposition() - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
getB2ContentDisposition() - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest
+
 
+
getB2ContentDisposition() - Method in interface com.backblaze.b2.client.structures.B2OverrideableHeaders
+
 
+
getB2ContentEncoding() - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest
+
 
+
getB2ContentEncoding() - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
getB2ContentEncoding() - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest
+
 
+
getB2ContentEncoding() - Method in interface com.backblaze.b2.client.structures.B2OverrideableHeaders
+
 
+
getB2ContentLanguage() - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest
+
 
+
getB2ContentLanguage() - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
getB2ContentLanguage() - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest
+
 
+
getB2ContentLanguage() - Method in interface com.backblaze.b2.client.structures.B2OverrideableHeaders
+
 
+
getB2ContentType() - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest
+
 
+
getB2ContentType() - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
getB2ContentType() - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest
+
 
+
getB2ContentType() - Method in interface com.backblaze.b2.client.structures.B2OverrideableHeaders
+
 
+
getB2Expires() - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest
+
 
+
getB2Expires() - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
getB2Expires() - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest
+
 
+
getB2Expires() - Method in interface com.backblaze.b2.client.structures.B2OverrideableHeaders
+
 
+
getB2FileInfo() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2Allowed
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2ApplicationKey
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2CreatedApplicationKey
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequest
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequestReal
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2DeleteBucketRequest
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2DeleteBucketRequestReal
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2DownloadAuthorization
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2EventNotificationEvent
+
+
The ID of the bucket where the objects reside that corresponds to the event.
+
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesRequest
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesResponse
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2GetUploadUrlRequest
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2HideFileRequest
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2ListBucketsRequest
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2ListFileNamesRequest
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesRequest
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesRequest
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesResponse
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest
+
 
+
getBucketId() - Method in class com.backblaze.b2.client.structures.B2UploadUrlResponse
+
 
+
getBucketInfo() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
 
+
getBucketInfo() - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequest
+
 
+
getBucketInfo() - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest
+
 
+
getBucketName() - Method in class com.backblaze.b2.client.structures.B2Allowed
+
 
+
getBucketName() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
 
+
getBucketName() - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequest
+
 
+
getBucketName() - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
getBucketName() - Method in class com.backblaze.b2.client.structures.B2EventNotificationEvent
+
+
The name of the bucket where the objects reside that corresponds to the event.
+
+
getBucketName() - Method in class com.backblaze.b2.client.structures.B2GetFileInfoByNameRequest
+
 
+
getBucketName() - Method in class com.backblaze.b2.client.structures.B2ListBucketsRequest
+
 
+
getBucketNotificationRules(B2AccountAuthorization, B2GetBucketNotificationRulesRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
getBucketNotificationRules(B2AccountAuthorization, B2GetBucketNotificationRulesRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
getBucketNotificationRules(B2GetBucketNotificationRulesRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Gets the bucket's event notification rules as described by the request.
+
+
getBucketNotificationRules(B2GetBucketNotificationRulesRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
getBucketNotificationRules(String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like getBucketNotificationRules(request), except that the request is created from + the specified bucketId.
+
+
getBucketOrNullByName(String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
 
+
getBuckets() - Method in class com.backblaze.b2.client.structures.B2ListBucketsResponse
+
 
+
getBucketType() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
 
+
getBucketType() - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequest
+
 
+
getBucketType() - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest
+
 
+
getBucketTypes() - Method in class com.backblaze.b2.client.structures.B2ListBucketsRequest
+
 
+
getBytes() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentMemoryWriter
+
 
+
getBytesSoFar() - Method in class com.backblaze.b2.client.structures.B2UploadProgress
+
 
+
getCapabilities() - Method in class com.backblaze.b2.client.structures.B2Allowed
+
 
+
getCapabilities() - Method in class com.backblaze.b2.client.structures.B2ApplicationKey
+
 
+
getCapabilities() - Method in class com.backblaze.b2.client.structures.B2CreatedApplicationKey
+
 
+
getCapabilities() - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequest
+
 
+
getCapabilities() - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequestReal
+
 
+
getClient() - Method in class com.backblaze.b2.client.B2ListFilesIterableBase
+
 
+
getClient() - Method in class com.backblaze.b2.client.B2ListPartsIterableBase
+
 
+
getClientUnauthorizedToReadHeaderList() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getCode() - Method in exception com.backblaze.b2.client.exceptions.B2Exception
+
 
+
getContent(String, B2Headers, B2ContentSink) - Method in interface com.backblaze.b2.client.webApiClients.B2WebApiClient
+
+
GETs from a web service that returns content.
+
+
getContentLength() - Method in class com.backblaze.b2.client.B2CancellableContentSource
+
 
+
getContentLength() - Method in class com.backblaze.b2.client.contentSources.B2ByteArrayContentSource
+
 
+
getContentLength() - Method in interface com.backblaze.b2.client.contentSources.B2ContentSource
+
 
+
getContentLength() - Method in class com.backblaze.b2.client.contentSources.B2FileContentSource
+
 
+
getContentLength() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getContentLength() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
getContentLength() - Method in class com.backblaze.b2.client.structures.B2Part
+
 
+
getContentMd5() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
getContentMd5() - Method in class com.backblaze.b2.client.structures.B2Part
+
 
+
getContentMd5OrNull() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getContentSha1() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
getContentSha1() - Method in class com.backblaze.b2.client.structures.B2Part
+
 
+
getContentSha1EvenIfUnverifiedOrNull() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getContentSha1OrNull() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getContentSource() - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest
+
 
+
getContentSource() - Method in class com.backblaze.b2.client.structures.B2UploadPartRequest
+
 
+
getContentType() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getContentType() - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
getContentType() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
getContentType() - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest
+
 
+
getContentType() - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest
+
 
+
getCorsRuleName() - Method in class com.backblaze.b2.client.structures.B2CorsRule
+
 
+
getCorsRules() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
 
+
getCorsRules() - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequest
+
 
+
getCorsRules() - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest
+
 
+
getCredentials() - Method in class com.backblaze.b2.client.credentialsSources.B2CredentialsFromEnvironmentSource
+
 
+
getCredentials() - Method in interface com.backblaze.b2.client.credentialsSources.B2CredentialsSource
+
 
+
getCurrentResponseOrNull() - Method in class com.backblaze.b2.client.B2ListFilesIterableBase.IterBase
+
 
+
getCurrentResponseOrNull() - Method in class com.backblaze.b2.client.B2ListPartsIterableBase.IterBase
+
 
+
getCustomerAlgorithm() - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
getCustomerKey() - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
getCustomerKey() - Method in class com.backblaze.b2.client.structures.B2FileSseForRequest
+
 
+
getCustomerKeyMd5() - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
getCustomerKeyMd5() - Method in class com.backblaze.b2.client.structures.B2FileSseForRequest
+
 
+
getCustomerKeyMd5() - Method in class com.backblaze.b2.client.structures.B2FileSseForResponse
+
 
+
getCustomHeaders() - Method in class com.backblaze.b2.client.structures.B2WebhookConfiguration
+
 
+
getCustomUploadTimestamp() - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest
+
 
+
getCustomUploadTimestamp() - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest
+
 
+
getDaysFromHidingToDeleting() - Method in class com.backblaze.b2.client.structures.B2LifecycleRule
+
 
+
getDaysFromStartingToCancelingUnfinishedLargeFiles() - Method in class com.backblaze.b2.client.structures.B2LifecycleRule
+
 
+
getDaysFromUploadingToHiding() - Method in class com.backblaze.b2.client.structures.B2LifecycleRule
+
 
+
getDefaultRetention() - Method in class com.backblaze.b2.client.structures.B2BucketFileLockConfiguration
+
 
+
getDefaultRetention() - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest
+
 
+
getDefaultRetentionMode() - Method in class com.backblaze.b2.client.structures.B2BucketFileLockConfiguration
+
 
+
getDefaultRetentionPeriod() - Method in class com.backblaze.b2.client.structures.B2BucketFileLockConfiguration
+
 
+
getDefaultServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
+
Returns settings for default bucket encryption (i.e., mode and algorithm) or null if there are none.
+
+
getDefaultServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequest
+
 
+
getDefaultServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest
+
 
+
getDelimiter() - Method in class com.backblaze.b2.client.structures.B2ListFileNamesRequest
+
 
+
getDelimiter() - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest
+
 
+
getDestinationBucketId() - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
getDestinationBucketId() - Method in class com.backblaze.b2.client.structures.B2ReplicationRule
+
 
+
getDestinationServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
getDestinationServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2CopyPartRequest
+
 
+
getDownloadAuthorization(B2AccountAuthorization, B2GetDownloadAuthorizationRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
getDownloadAuthorization(B2AccountAuthorization, B2GetDownloadAuthorizationRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
getDownloadAuthorization(B2GetDownloadAuthorizationRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
 
+
getDownloadAuthorization(B2GetDownloadAuthorizationRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
getDownloadByIdUrl(B2AccountAuthorization, B2DownloadByIdRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
getDownloadByIdUrl(B2AccountAuthorization, B2DownloadByIdRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
getDownloadByIdUrl(B2DownloadByIdRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Returns the URL for downloading the file specified by the request.
+
+
getDownloadByIdUrl(B2DownloadByIdRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
getDownloadByIdUrl(String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like getDownloadByIdUrl(request) except that the request is created + from the given fileId.
+
+
getDownloadByNameUrl(B2AccountAuthorization, B2DownloadByNameRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
getDownloadByNameUrl(B2AccountAuthorization, B2DownloadByNameRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
getDownloadByNameUrl(B2DownloadByNameRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Returns the URL for downloading the file specified by the request.
+
+
getDownloadByNameUrl(B2DownloadByNameRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
getDownloadByNameUrl(String, String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like getDownloadByIdUrl(request) except that the request is created + from the given bucketName and fileName.
+
+
getDownloadUrl() - Method in class com.backblaze.b2.client.structures.B2AccountAuthorization
+
 
+
getDuration() - Method in class com.backblaze.b2.client.structures.B2BucketDefaultRetentionPeriod
+
 
+
getEncryptionFromHeadersOrNull(B2Headers) - Static method in class com.backblaze.b2.client.structures.B2FileSseForResponse
+
+
Construct a B2FileSseForResponse from B2Headers, or null if the required headers are not present
+
+
getEventId() - Method in class com.backblaze.b2.client.structures.B2EventNotificationEvent
+
+
The unique ID of the event.
+
+
getEventNotificationRules() - Method in class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesResponse
+
 
+
getEventNotificationRules() - Method in class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesRequest
+
 
+
getEventNotificationRules() - Method in class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesResponse
+
 
+
getEvents() - Method in class com.backblaze.b2.client.structures.B2EventNotification
+
+
A list of object events.
+
+
getEventTimestamp() - Method in class com.backblaze.b2.client.structures.B2EventNotificationEvent
+
+
The UTC time when this event was generated.
+
+
getEventType() - Method in class com.backblaze.b2.client.structures.B2EventNotificationEvent
+
+
The event type of the event notification rule that corresponds to the event.
+
+
getEventTypes() - Method in class com.backblaze.b2.client.structures.B2EventNotificationRule
+
 
+
getEventVersion() - Method in class com.backblaze.b2.client.structures.B2EventNotificationEvent
+
+
The version of the event notification payload.
+
+
getExcerptLength() - Method in class com.backblaze.b2.util.B2InputStreamExcerpt
+
 
+
getExcerptStart() - Method in class com.backblaze.b2.util.B2InputStreamExcerpt
+
 
+
getExpirationTimestamp() - Method in class com.backblaze.b2.client.structures.B2ApplicationKey
+
 
+
getExpirationTimestamp() - Method in class com.backblaze.b2.client.structures.B2CreatedApplicationKey
+
 
+
getExposeHeaders() - Method in class com.backblaze.b2.client.structures.B2CorsRule
+
 
+
getExtraFieldOption() - Method in class com.backblaze.b2.json.B2JsonOptions
+
+
What to do with extra fields found when de-serializing.
+
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2CancelLargeFileRequest
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2CancelLargeFileResponse
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2DeleteFileVersionRequest
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2DeleteFileVersionResponse
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2FinishLargeFileRequest
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2GetFileInfoRequest
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2GetUploadPartUrlRequest
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2ListPartsRequest
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2Part
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2StoreLargeFileRequest
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldRequest
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldResponse
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2UpdateFileRetentionRequest
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2UpdateFileRetentionResponse
+
 
+
getFileId() - Method in class com.backblaze.b2.client.structures.B2UploadPartUrlResponse
+
 
+
getFileInfo() - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
getFileInfo() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
getFileInfo() - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest
+
 
+
getFileInfo() - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest
+
 
+
getFileInfo(B2AccountAuthorization, B2GetFileInfoRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
getFileInfo(B2AccountAuthorization, B2GetFileInfoRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
getFileInfo(B2GetFileInfoRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
 
+
getFileInfo(B2GetFileInfoRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
getFileInfo(String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like getFileInfo(request) except that the request is created + from the given fileId.
+
+
getFileInfoByName(B2AccountAuthorization, B2GetFileInfoByNameRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
getFileInfoByName(B2AccountAuthorization, B2GetFileInfoByNameRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
getFileInfoByName(B2GetFileInfoByNameRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
 
+
getFileInfoByName(B2GetFileInfoByNameRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
getFileInfoByName(String, String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like getFileInfoByName(request), but for the most recent version of file + with the specified fileName in the specified bucket.
+
+
getFileLegalHoldOrNull() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getFileLockConfiguration() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
+
Returns bucket file lock configuration.
+
+
getFileLockEnabled() - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest
+
 
+
getFileName() - Method in class com.backblaze.b2.client.structures.B2CancelLargeFileResponse
+
 
+
getFileName() - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
getFileName() - Method in class com.backblaze.b2.client.structures.B2DeleteFileVersionRequest
+
 
+
getFileName() - Method in class com.backblaze.b2.client.structures.B2DeleteFileVersionResponse
+
 
+
getFileName() - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
getFileName() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
getFileName() - Method in class com.backblaze.b2.client.structures.B2GetFileInfoByNameRequest
+
 
+
getFileName() - Method in class com.backblaze.b2.client.structures.B2HideFileRequest
+
 
+
getFileName() - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest
+
 
+
getFileName() - Method in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldRequest
+
 
+
getFileName() - Method in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldResponse
+
 
+
getFileName() - Method in class com.backblaze.b2.client.structures.B2UpdateFileRetentionRequest
+
 
+
getFileName() - Method in class com.backblaze.b2.client.structures.B2UpdateFileRetentionResponse
+
 
+
getFileName() - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest
+
 
+
getFileNameOrNull() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getFileNamePrefix() - Method in class com.backblaze.b2.client.structures.B2DownloadAuthorization
+
 
+
getFileNamePrefix() - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest
+
 
+
getFileNamePrefix() - Method in class com.backblaze.b2.client.structures.B2LifecycleRule
+
 
+
getFileNamePrefix() - Method in class com.backblaze.b2.client.structures.B2ReplicationRule
+
 
+
getFilePolicy() - Method in interface com.backblaze.b2.client.B2StorageClient
+
 
+
getFilePolicy() - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
getFileRetention() - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
getFileRetention() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
+
Returns the file retention setting on the file version
+
+
getFileRetention() - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest
+
 
+
getFileRetention() - Method in class com.backblaze.b2.client.structures.B2UpdateFileRetentionRequest
+
 
+
getFileRetention() - Method in class com.backblaze.b2.client.structures.B2UpdateFileRetentionResponse
+
 
+
getFileRetention() - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest
+
 
+
getFileRetentionFromHeadersOrNull(B2Headers) - Static method in class com.backblaze.b2.client.structures.B2FileRetention
+
+
Construct a B2FileRetention from B2Headers, or null if the required headers are not present
+
+
getFileRetentionModeOrNull() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getFileRetentionRetainUntilTimestampOrNull() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getFiles() - Method in class com.backblaze.b2.client.structures.B2ListFileNamesResponse
+
 
+
getFiles() - Method in interface com.backblaze.b2.client.structures.B2ListFilesResponse
+
 
+
getFiles() - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsResponse
+
 
+
getFiles() - Method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesResponse
+
 
+
getFileVersion() - Method in class com.backblaze.b2.client.structures.B2StoreLargeFileRequest
+
+
Deprecated.
+
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonAtomicLongArrayHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonBigDecimalHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonBigIntegerHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonBooleanArrayHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonBooleanHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonByteArrayHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonByteHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonCharacterHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonCharArrayHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonCharSquenceHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonConcurrentMapHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonDoubleArrayHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonDoubleHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonEnumHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonEnumSetHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonFloatArrayHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonFloatHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonIntArrayHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonIntegerHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonLinkedHashSetHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonListHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonLocalDateHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonLocalDateTimeHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonLongArrayHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonLongHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonMapHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonObjectArrayHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonObjectHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonSetHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonStringHandler
+
 
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonTreeSetHandler
+
 
+
getHandledType() - Method in interface com.backblaze.b2.json.B2JsonTypeHandler
+
+
What class does this handle?
+
+
getHandledType() - Method in class com.backblaze.b2.json.B2JsonUnionBaseHandler
+
 
+
getHandler() - Method in class com.backblaze.b2.json.FieldInfo
+
 
+
getHandler(Type) - Method in class com.backblaze.b2.json.B2JsonHandlerMap
+
+
Gets the handler for a given class at the top level.
+
+
getHeadersOrNull() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentWriter
+
 
+
getHmacSha256SigningSecret() - Method in class com.backblaze.b2.client.structures.B2WebhookConfiguration
+
 
+
getIfRevisionIs() - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest
+
 
+
getIsSensitive() - Method in class com.backblaze.b2.json.FieldInfo
+
 
+
getJsonMemberName() - Method in class com.backblaze.b2.json.FieldInfo
+
+
Returns the member name that this field is serialized to in Json.
+
+
getKeyName() - Method in class com.backblaze.b2.client.structures.B2ApplicationKey
+
 
+
getKeyName() - Method in class com.backblaze.b2.client.structures.B2CreatedApplicationKey
+
 
+
getKeyName() - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequest
+
 
+
getKeyName() - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequestReal
+
 
+
getKeys() - Method in class com.backblaze.b2.client.structures.B2ListKeysResponse
+
 
+
getLargeFileId() - Method in class com.backblaze.b2.client.structures.B2CopyPartRequest
+
 
+
getLargeFileSha1OrNull() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getLargeFileSha1OrNull() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
getLegalHold() - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
getLegalHold() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
+
Returns the legal hold status on the file version
+
+
getLegalHold() - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest
+
 
+
getLegalHold() - Method in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldRequest
+
 
+
getLegalHold() - Method in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldResponse
+
 
+
getLegalHold() - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest
+
 
+
getLength() - Method in class com.backblaze.b2.client.B2PartSpec
+
 
+
getLength() - Method in class com.backblaze.b2.client.structures.B2UploadProgress
+
 
+
getLifecycleRules() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
 
+
getLifecycleRules() - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequest
+
 
+
getLifecycleRules() - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest
+
 
+
getListener() - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest
+
 
+
getMasterUrl() - Method in class com.backblaze.b2.client.B2ClientConfig
+
 
+
getMatchedRuleName() - Method in class com.backblaze.b2.client.structures.B2EventNotificationEvent
+
+
The name of the event notification rule the corresponds to the event.
+
+
getMaxAgeSeconds() - Method in class com.backblaze.b2.client.structures.B2CorsRule
+
 
+
getMaxCapacity() - Method in class com.backblaze.b2.json.B2JsonBoundedByteArrayOutputStream
+
+
returns the max capacity of output array
+
+
getMaxFileCount() - Method in class com.backblaze.b2.client.structures.B2ListFileNamesRequest
+
 
+
getMaxFileCount() - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest
+
 
+
getMaxFileCount() - Method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesRequest
+
 
+
getMaxKeyCount() - Method in class com.backblaze.b2.client.structures.B2ListKeysRequest
+
 
+
getMaxKeyCount() - Method in class com.backblaze.b2.client.structures.B2ListKeysRequestReal
+
 
+
getMaxPartCount() - Method in class com.backblaze.b2.client.structures.B2ListPartsRequest
+
 
+
getMd5MessageDigest() - Static method in interface com.backblaze.b2.util.B2Md5
+
+
Returns an MD5 MessageDigest, which we expect to always be available.
+
+
getMetadataDirective() - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
getMode() - Method in class com.backblaze.b2.client.structures.B2BucketDefaultRetention
+
 
+
getMode() - Method in class com.backblaze.b2.client.structures.B2BucketServerSideEncryption
+
 
+
getMode() - Method in class com.backblaze.b2.client.structures.B2FileRetention
+
 
+
getMode() - Method in class com.backblaze.b2.client.structures.B2FileSseForRequest
+
 
+
getMode() - Method in class com.backblaze.b2.client.structures.B2FileSseForResponse
+
 
+
getName() - Static method in class com.backblaze.b2.client.B2Sdk
+
 
+
getName() - Method in class com.backblaze.b2.client.structures.B2EventNotificationRule
+
 
+
getName() - Method in class com.backblaze.b2.client.structures.B2WebhookCustomHeader
+
 
+
getName() - Method in class com.backblaze.b2.json.FieldInfo
+
+
Deprecated. +
use FieldInfo.getJsonMemberName() instead which is clearer.
+
+
+
getNamePrefix() - Method in class com.backblaze.b2.client.structures.B2Allowed
+
 
+
getNamePrefix() - Method in class com.backblaze.b2.client.structures.B2ApplicationKey
+
 
+
getNamePrefix() - Method in class com.backblaze.b2.client.structures.B2CreatedApplicationKey
+
 
+
getNamePrefix() - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequest
+
 
+
getNamePrefix() - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequestReal
+
 
+
getNamePrefix() - Method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesRequest
+
 
+
getNames() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getNames() - Method in class com.backblaze.b2.client.contentSources.B2HeadersImpl
+
 
+
getNextApplicationKeyId() - Method in class com.backblaze.b2.client.structures.B2ListKeysResponse
+
 
+
getNextFileId() - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsResponse
+
 
+
getNextFileId() - Method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesResponse
+
 
+
getNextFileName() - Method in class com.backblaze.b2.client.structures.B2ListFileNamesResponse
+
 
+
getNextFileName() - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsResponse
+
 
+
getNextPartNumber() - Method in class com.backblaze.b2.client.structures.B2ListPartsResponse
+
 
+
getNumberOfBytes() - Method in class com.backblaze.b2.util.B2ByteRange
+
+
Returns the number of bytes that the range specifies.
+
+
getObjectName() - Method in class com.backblaze.b2.client.structures.B2EventNotificationEvent
+
+
The name of the object that corresponds to the event.
+
+
getObjectNamePrefix() - Method in class com.backblaze.b2.client.structures.B2EventNotificationRule
+
 
+
getObjectSize() - Method in class com.backblaze.b2.client.structures.B2EventNotificationEvent
+
+
The size of bytes of the object that corresponds to the event.
+
+
getObjectVersionId() - Method in class com.backblaze.b2.client.structures.B2EventNotificationEvent
+
+
The unique identifier for the version of the object that corresponds to the event.
+
+
getOptions() - Method in class com.backblaze.b2.client.structures.B2ApplicationKey
+
 
+
getOptions() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
 
+
getOptions() - Method in class com.backblaze.b2.client.structures.B2CreatedApplicationKey
+
 
+
getPartCount() - Method in class com.backblaze.b2.client.structures.B2UploadProgress
+
 
+
getPartIndex() - Method in class com.backblaze.b2.client.structures.B2UploadProgress
+
 
+
getPartNumber() - Method in class com.backblaze.b2.client.B2AlreadyStoredPartStorer
+
 
+
getPartNumber() - Method in class com.backblaze.b2.client.B2CopyingPartStorer
+
 
+
getPartNumber() - Method in class com.backblaze.b2.client.B2PartSpec
+
 
+
getPartNumber() - Method in interface com.backblaze.b2.client.B2PartStorer
+
 
+
getPartNumber() - Method in class com.backblaze.b2.client.B2UploadingPartStorer
+
 
+
getPartNumber() - Method in class com.backblaze.b2.client.structures.B2CopyPartRequest
+
 
+
getPartNumber() - Method in class com.backblaze.b2.client.structures.B2Part
+
 
+
getPartNumber() - Method in class com.backblaze.b2.client.structures.B2UploadPartRequest
+
 
+
getParts() - Method in class com.backblaze.b2.client.structures.B2ListPartsResponse
+
 
+
getPartSha1Array() - Method in class com.backblaze.b2.client.structures.B2FinishLargeFileRequest
+
 
+
getPartSizeOrThrow() - Method in class com.backblaze.b2.client.B2AlreadyStoredPartStorer
+
 
+
getPartSizeOrThrow() - Method in class com.backblaze.b2.client.B2CopyingPartStorer
+
 
+
getPartSizeOrThrow() - Method in interface com.backblaze.b2.client.B2PartStorer
+
 
+
getPartSizeOrThrow() - Method in class com.backblaze.b2.client.B2UploadingPartStorer
+
 
+
getPeriod() - Method in class com.backblaze.b2.client.structures.B2BucketDefaultRetention
+
 
+
getPrefix() - Method in class com.backblaze.b2.client.structures.B2ListFileNamesRequest
+
 
+
getPrefix() - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest
+
 
+
getPriority() - Method in class com.backblaze.b2.client.structures.B2ReplicationRule
+
 
+
getRange() - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
getRange() - Method in class com.backblaze.b2.client.structures.B2CopyPartRequest
+
 
+
getRange() - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest
+
 
+
getRange() - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
getRecommendedPartSize() - Method in class com.backblaze.b2.client.structures.B2AccountAuthorization
+
 
+
getRedactSensitive() - Method in class com.backblaze.b2.json.B2JsonOptions
+
+
Redact sensitive fields from output
+
+
getReplicationConfiguration() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
+
Returns settings for bucket replication configuration or null if there are none.
+
+
getReplicationConfiguration() - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequest
+
 
+
getReplicationConfiguration() - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest
+
 
+
getReplicationRuleName() - Method in class com.backblaze.b2.client.structures.B2ReplicationRule
+
 
+
getReplicationRulesOrNull() - Method in class com.backblaze.b2.client.structures.B2BucketReplicationConfiguration
+
 
+
getReplicationStatus() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
getReplicationStatusOrNull() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getRequestCategory() - Method in exception com.backblaze.b2.client.exceptions.B2UnauthorizedException
+
 
+
getRetainUntilTimestamp() - Method in class com.backblaze.b2.client.structures.B2FileRetention
+
 
+
getRetryAfterSecondsOrNull() - Method in exception com.backblaze.b2.client.exceptions.B2Exception
+
 
+
getRevision() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
 
+
getS3ApiUrl() - Method in class com.backblaze.b2.client.structures.B2AccountAuthorization
+
 
+
getSerializationOption() - Method in class com.backblaze.b2.json.B2JsonOptions
+
 
+
getServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest
+
 
+
getServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
getServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
getServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2GetFileInfoByNameRequest
+
 
+
getServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2Part
+
 
+
getServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest
+
 
+
getServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2StoreLargeFileRequest
+
 
+
getServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest
+
 
+
getServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2UploadPartRequest
+
 
+
getServerSideEncryptionOrNull() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getSha1OrNull() - Method in class com.backblaze.b2.client.B2CancellableContentSource
+
 
+
getSha1OrNull() - Method in class com.backblaze.b2.client.contentSources.B2ByteArrayContentSource
+
 
+
getSha1OrNull() - Method in interface com.backblaze.b2.client.contentSources.B2ContentSource
+
+
You are encouraged to implement this.
+
+
getSha1OrNull() - Method in class com.backblaze.b2.client.contentSources.B2FileContentSource
+
 
+
getSize() - Method in class com.backblaze.b2.json.B2JsonBoundedByteArrayOutputStream
+
+
returns the current output array size
+
+
getSourceApplicationKeyIdOrNull() - Method in class com.backblaze.b2.client.structures.B2BucketReplicationConfiguration
+
 
+
getSourceFileId() - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
getSourceFileId() - Method in class com.backblaze.b2.client.structures.B2CopyPartRequest
+
 
+
getSourceServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
getSourceServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2CopyPartRequest
+
 
+
getSourceToDestinationKeyMappingOrNull() - Method in class com.backblaze.b2.client.structures.B2BucketReplicationConfiguration
+
 
+
getSrcLastModifiedMillis() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getSrcLastModifiedMillisOrNull() - Method in class com.backblaze.b2.client.B2CancellableContentSource
+
 
+
getSrcLastModifiedMillisOrNull() - Method in class com.backblaze.b2.client.contentSources.B2ByteArrayContentSource
+
 
+
getSrcLastModifiedMillisOrNull() - Method in interface com.backblaze.b2.client.contentSources.B2ContentSource
+
 
+
getSrcLastModifiedMillisOrNull() - Method in class com.backblaze.b2.client.contentSources.B2FileContentSource
+
 
+
getSseCustomerAlgorithmOrNull() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getSseCustomerKeyMd5OrNull() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getStart() - Method in class com.backblaze.b2.client.B2PartSpec
+
 
+
getStartApplicationKeyId() - Method in class com.backblaze.b2.client.structures.B2ListKeysRequest
+
 
+
getStartApplicationKeyId() - Method in class com.backblaze.b2.client.structures.B2ListKeysRequestReal
+
 
+
getStartByte() - Method in class com.backblaze.b2.client.structures.B2UploadProgress
+
 
+
getStartFileId() - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest
+
 
+
getStartFileId() - Method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesRequest
+
 
+
getStartFileName() - Method in class com.backblaze.b2.client.structures.B2ListFileNamesRequest
+
 
+
getStartFileName() - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest
+
 
+
getStartPartNumber() - Method in class com.backblaze.b2.client.structures.B2ListPartsRequest
+
 
+
getState() - Method in class com.backblaze.b2.client.structures.B2UploadProgress
+
 
+
getStatus() - Method in exception com.backblaze.b2.client.exceptions.B2Exception
+
 
+
getSuspensionReason() - Method in class com.backblaze.b2.client.structures.B2EventNotificationRule
+
 
+
getTargetConfiguration() - Method in class com.backblaze.b2.client.structures.B2EventNotificationRule
+
 
+
getTestModeOrNull() - Method in class com.backblaze.b2.client.B2ClientConfig
+
 
+
getType() - Method in class com.backblaze.b2.json.B2TypeResolver
+
+
Returns the type this resolver is working over.
+
+
getTypeNameOrNullForClass(Class<?>) - Method in class com.backblaze.b2.json.B2JsonUnionTypeMap
+
 
+
getTypeNameToClass() - Method in class com.backblaze.b2.json.B2JsonUnionTypeMap
+
 
+
getUnionTypeMap() - Static method in class com.backblaze.b2.client.structures.B2EventNotificationTargetConfiguration
+
 
+
getUnit() - Method in class com.backblaze.b2.client.structures.B2BucketDefaultRetentionPeriod
+
 
+
getUploadPartUrl(B2AccountAuthorization, B2GetUploadPartUrlRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
getUploadPartUrl(B2AccountAuthorization, B2GetUploadPartUrlRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
getUploadPartUrl(B2GetUploadPartUrlRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
This method allows the caller to get an upload url and authorization + token directly for uploading a large file part.
+
+
getUploadPartUrl(B2GetUploadPartUrlRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
getUploadTimestamp() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
getUploadTimestamp() - Method in class com.backblaze.b2.client.structures.B2Part
+
 
+
getUploadTimestampOrNull() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getUploadUrl() - Method in class com.backblaze.b2.client.structures.B2UploadPartUrlResponse
+
 
+
getUploadUrl() - Method in class com.backblaze.b2.client.structures.B2UploadUrlResponse
+
 
+
getUploadUrl(B2AccountAuthorization, B2GetUploadUrlRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
getUploadUrl(B2AccountAuthorization, B2GetUploadUrlRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
getUploadUrl(B2GetUploadUrlRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
This method allows the caller to get an upload url and authorization + token directly.
+
+
getUploadUrl(B2GetUploadUrlRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
getUrl() - Method in class com.backblaze.b2.client.structures.B2WebhookConfiguration
+
 
+
getUserAgent() - Method in class com.backblaze.b2.client.B2ClientConfig
+
 
+
getUtf8Bytes(String) - Static method in class com.backblaze.b2.util.B2StringUtil
+
+
Returns the UTF-8 representation of a string.
+
+
getValidDurationInSeconds() - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequest
+
 
+
getValidDurationInSeconds() - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequestReal
+
 
+
getValidDurationInSeconds() - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest
+
 
+
getValue() - Method in class com.backblaze.b2.client.structures.B2WebhookCustomHeader
+
 
+
getValueForHeader() - Method in enum com.backblaze.b2.client.structures.B2TestMode
+
 
+
getValueOrNull(String) - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
getValueOrNull(String) - Method in class com.backblaze.b2.client.contentSources.B2HeadersImpl
+
 
+
getVersion() - Static method in class com.backblaze.b2.client.B2Sdk
+
 
+
getVersion() - Method in class com.backblaze.b2.json.B2JsonOptions
+
+
What version of the (de-)serialized structure to use.
+
+
getWebifier() - Method in interface com.backblaze.b2.client.B2StorageClient
+
 
+
getWebifier() - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
gotRetryableAfterDelay(String, int, long, B2Exception) - Method in class com.backblaze.b2.client.B2DefaultRetryPolicy
+
 
+
gotRetryableAfterDelay(String, int, long, B2Exception) - Method in interface com.backblaze.b2.client.B2RetryPolicy
+
+
Callable.call() threw a retryable B2Exception but we have to wait a + while before retrying.
+
+
gotRetryableImmediately(String, int, long, B2Exception) - Method in class com.backblaze.b2.client.B2DefaultRetryPolicy
+
 
+
gotRetryableImmediately(String, int, long, B2Exception) - Method in interface com.backblaze.b2.client.B2RetryPolicy
+
+
Callable.call() threw a retryable B2Exception.
+
+
gotUnexpectedUnretryable(String, int, long, Exception) - Method in interface com.backblaze.b2.client.B2RetryPolicy
+
+
Callable.call() threw an Exception that wasn't a B2Exception.
+
+
gotUnretryable(String, int, long, B2Exception) - Method in interface com.backblaze.b2.client.B2RetryPolicy
+
+
Callable.call() threw an unretryable B2Exception.
+
+
GOVERNANCE - Static variable in interface com.backblaze.b2.client.structures.B2FileRetentionMode
+
 
+
+ + + +

H

+
+
handler - Variable in class com.backblaze.b2.json.FieldInfo
+
 
+
hasContentRange() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
hashCode() - Method in class com.backblaze.b2.client.B2AlreadyStoredPartStorer
+
 
+
hashCode() - Method in class com.backblaze.b2.client.B2ClientConfig
+
 
+
hashCode() - Method in class com.backblaze.b2.client.B2CopyingPartStorer
+
 
+
hashCode() - Method in class com.backblaze.b2.client.B2PartSpec
+
 
+
hashCode() - Method in class com.backblaze.b2.client.B2UploadingPartStorer
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2AccountAuthorization
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2ApplicationKey
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2AuthorizationFilteredResponseField
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2AuthorizeAccountRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2BucketDefaultRetention
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2BucketDefaultRetentionPeriod
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2BucketFileLockConfiguration
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2BucketReplicationConfiguration
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2BucketServerSideEncryption
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2CancelLargeFileRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2CancelLargeFileResponse
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2CopyPartRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2CorsRule
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequestReal
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2CreatedApplicationKey
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequestReal
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2DeleteBucketRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2DeleteBucketRequestReal
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2DeleteFileVersionRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2DeleteFileVersionResponse
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2DeleteKeyRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2EventNotification
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2EventNotificationEvent
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2EventNotificationRule
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2FileRetention
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2FileSseForRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2FileSseForResponse
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2FinishLargeFileRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesResponse
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2GetFileInfoByNameRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2GetFileInfoRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2GetUploadPartUrlRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2GetUploadUrlRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2HideFileRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2LifecycleRule
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2ListBucketsRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2ListBucketsResponse
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2ListFileNamesRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2ListFileNamesResponse
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsResponse
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2ListKeysRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2ListKeysRequestReal
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2ListKeysResponse
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2ListPartsRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2ListPartsResponse
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesResponse
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2Part
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2ReplicationRule
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesResponse
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2StoreLargeFileRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldResponse
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2UpdateFileRetentionRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2UpdateFileRetentionResponse
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2UploadPartRequest
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2UploadPartUrlResponse
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2UploadProgress
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2UploadUrlResponse
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2WebhookConfiguration
+
 
+
hashCode() - Method in class com.backblaze.b2.client.structures.B2WebhookCustomHeader
+
 
+
hashCode() - Method in class com.backblaze.b2.util.B2ByteRange
+
 
+
hasNext() - Method in class com.backblaze.b2.client.B2ListFilesIterableBase.IterBase
+
 
+
hasNext() - Method in class com.backblaze.b2.client.B2ListKeysIterator
+
 
+
hasNext() - Method in class com.backblaze.b2.client.B2ListPartsIterableBase.IterBase
+
 
+
head(String, B2Headers) - Method in interface com.backblaze.b2.client.webApiClients.B2WebApiClient
+
+
HEADSs to a web service that returns content, and returns the headers.
+
+
HEX_DIGITS_AT_END - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
HEX_MD5_SIZE - Static variable in interface com.backblaze.b2.util.B2Md5
+
 
+
HEX_SHA1_SIZE - Static variable in interface com.backblaze.b2.util.B2Sha1
+
 
+
hexDigest() - Method in class com.backblaze.b2.util.B2Sha1InputStream
+
+
Returns the SHA1 if the bytes processed so far, as a hex string.
+
+
hexMd5OfBytes(byte[]) - Static method in interface com.backblaze.b2.util.B2Md5
+
+
Returns the hex digest of an array of bytes.
+
+
hexMd5OfBytes(byte[], int, int) - Static method in interface com.backblaze.b2.util.B2Md5
+
+
Returns the hex digest of an array of bytes.
+
+
hexSha1OfBytes(byte[]) - Static method in interface com.backblaze.b2.util.B2Sha1
+
+
Returns the SHA-1 of the given bytes, as a hex string.
+
+
hexSha1OfInputStream(InputStream) - Static method in interface com.backblaze.b2.util.B2Sha1
+
+
Returns the SHA-1 of the given input stream, as a hex string.
+
+
HIDE_ACTION - Static variable in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
hideFile(B2AccountAuthorization, B2HideFileRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
hideFile(B2AccountAuthorization, B2HideFileRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
hideFile(B2HideFileRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Hides the specified file.
+
+
hideFile(B2HideFileRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
hideFile(String, String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like hideFile(request) except the request is created from the + given bucketId and fileName.
+
+
hitException(Exception, long) - Method in interface com.backblaze.b2.util.B2ByteProgressListener
+
+
Called right before the exception propagates to the caller.
+
+
+ + + +

I

+
+
IGNORE - com.backblaze.b2.json.B2JsonOptions.ExtraFieldOption
+
 
+
IGNORED - com.backblaze.b2.json.FieldInfo.FieldRequirement
+
 
+
includeExistingFiles() - Method in class com.backblaze.b2.client.structures.B2ReplicationRule
+
 
+
includesVersion(int) - Method in class com.backblaze.b2.json.VersionRange
+
+
Does this range include the version?
+
+
initializeImplementation(B2JsonHandlerMap) - Method in class com.backblaze.b2.json.B2JsonInitializedTypeHandler
+
+
Does any initialization specific to the concrete class.
+
+
initializeImplementation(B2JsonHandlerMap) - Method in class com.backblaze.b2.json.B2JsonObjectHandler
+
 
+
initializeImplementation(B2JsonHandlerMap) - Method in class com.backblaze.b2.json.B2JsonUnionBaseHandler
+
 
+
invalidateAccountAuthorization() - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
If there's a cached account authorization, this will flush the cache + so that the authorization will need to be reacquired the next time + it is needed.
+
+
invalidateAccountAuthorization() - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
isBuiltInZeroableType(Class<?>) - Static method in class com.backblaze.b2.json.B2JsonObjectHandler
+
 
+
isBypassGovernance() - Method in class com.backblaze.b2.client.structures.B2DeleteFileVersionRequest
+
 
+
isBypassGovernance() - Method in class com.backblaze.b2.client.structures.B2UpdateFileRetentionRequest
+
 
+
isClientAuthorizedToReadDefaultServerSideEncryption() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
+
Indicates whether client is authorized to read default bucket encryption settings for bucket
+
+
isClientAuthorizedToReadFileLockConfiguration() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
+
Indicates whether client is authorized to read file lock configuration settings for bucket
+
+
isClientAuthorizedToReadFileRetention() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
+
Indicates whether or not the client is authorized to read the file retention + from this file version.
+
+
isClientAuthorizedToReadLegalHold() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
+
Indicates whether or not the client is authorized to read the legal hold + status from this file version.
+
+
isClientAuthorizedToReadReplicationConfiguration() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
+
Indicates whether client is authorized to read replication configuration settings for bucket
+
+
isClientUnauthorizedToReadFileRetention() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
isClientUnauthorizedToReadLegalHold() - Method in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
isEmpty(String) - Static method in class com.backblaze.b2.util.B2StringUtil
+
 
+
isEnabled() - Method in class com.backblaze.b2.client.structures.B2EventNotificationRule
+
 
+
isEnabled() - Method in class com.backblaze.b2.client.structures.B2ReplicationRule
+
 
+
isFileLockEnabled() - Method in class com.backblaze.b2.client.structures.B2BucketFileLockConfiguration
+
 
+
isFileLockEnabled() - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequest
+
 
+
isFolder() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
isHide() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
isInitialized() - Method in class com.backblaze.b2.json.B2JsonInitializedTypeHandler
+
+
Has the initialize method run?
+
+
isInVersion(int) - Method in class com.backblaze.b2.json.FieldInfo
+
 
+
isPartNumberGapsAllowed() - Method in class com.backblaze.b2.client.B2ClientConfig
+
 
+
isRequiredAndInVersion(int) - Method in class com.backblaze.b2.json.FieldInfo
+
 
+
isSatisfied(long) - Method in class com.backblaze.b2.util.B2ByteRange
+
+
Can this range be satisfied with a file of the given length.
+
+
isSensitive - Variable in class com.backblaze.b2.json.FieldInfo
+
 
+
isStart() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
isStartByteKnown() - Method in class com.backblaze.b2.client.structures.B2UploadProgress
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonAtomicLongArrayHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonBigDecimalHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonBigIntegerHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonBooleanArrayHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonBooleanHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonByteArrayHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonByteHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonCharacterHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonCharArrayHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonCharSquenceHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonConcurrentMapHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonDoubleArrayHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonDoubleHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonEnumHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonEnumSetHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonFloatArrayHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonFloatHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonIntArrayHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonIntegerHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonLinkedHashSetHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonListHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonLocalDateHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonLocalDateTimeHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonLongArrayHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonLongHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonMapHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonObjectArrayHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonObjectHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonSetHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonStringHandler
+
 
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonTreeSetHandler
+
 
+
isStringInJson() - Method in interface com.backblaze.b2.json.B2JsonTypeHandler
+
+
Does this type look like a string in JSON?
+
+
isStringInJson() - Method in class com.backblaze.b2.json.B2JsonUnionBaseHandler
+
 
+
isSuspended() - Method in class com.backblaze.b2.client.structures.B2EventNotificationRule
+
 
+
isUpload() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
isZero(Object) - Static method in class com.backblaze.b2.json.B2JsonObjectHandler
+
 
+
iterator() - Method in class com.backblaze.b2.client.B2ListFilesIterableBase
+
 
+
iterator() - Method in class com.backblaze.b2.client.B2ListKeysIterable
+
 
+
iterator() - Method in class com.backblaze.b2.client.B2ListPartsIterableBase
+
 
+
+ + + +

J

+
+
join(String, Object[]) - Static method in class com.backblaze.b2.util.B2StringUtil
+
 
+
+ + + +

L

+
+
LARGE_FILE_SHA1 - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
LARGE_FILE_SHA1_INFO_NAME - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
lastVersion() - Method in annotation type com.backblaze.b2.json.B2Json.versionRange
+
 
+
legalHold - Variable in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldRequest
+
 
+
legalHold - Variable in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldResponse
+
 
+
LIST_ALL_BUCKET_NAMES - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
LIST_BUCKETS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
LIST_FILES - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
LIST_KEYS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
listBuckets() - Method in interface com.backblaze.b2.client.B2StorageClient
+
 
+
listBuckets(B2AccountAuthorization, B2ListBucketsRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
listBuckets(B2AccountAuthorization, B2ListBucketsRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
listBuckets(B2ListBucketsRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
 
+
listBuckets(B2ListBucketsRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
listFileNames(B2AccountAuthorization, B2ListFileNamesRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
listFileNames(B2AccountAuthorization, B2ListFileNamesRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
listFileVersions(B2AccountAuthorization, B2ListFileVersionsRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
listFileVersions(B2AccountAuthorization, B2ListFileVersionsRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
listFromJson(String, Class<V>) - Method in class com.backblaze.b2.json.B2Json
+
+
Parses a JSON object into a map.
+
+
listFromJson(String, Class<V>, B2JsonOptions) - Method in class com.backblaze.b2.json.B2Json
+
 
+
listKeys(B2AccountAuthorization, B2ListKeysRequestReal) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
listKeys(B2AccountAuthorization, B2ListKeysRequestReal) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
listOf(T...) - Static method in class com.backblaze.b2.util.B2Collections
+
 
+
listParts(B2AccountAuthorization, B2ListPartsRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
listParts(B2AccountAuthorization, B2ListPartsRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
listToJson(List<?>, Class<?>) - Method in class com.backblaze.b2.json.B2Json
+
+
Turn a map into JSON, returning the result as a string.
+
+
listToJson(List<?>, Class<?>, B2JsonOptions) - Method in class com.backblaze.b2.json.B2Json
+
 
+
listUnfinishedLargeFiles(B2AccountAuthorization, B2ListUnfinishedLargeFilesRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
listUnfinishedLargeFiles(B2AccountAuthorization, B2ListUnfinishedLargeFilesRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
+ + + +

M

+
+
mapFromJson(String, Class<K>, Class<V>) - Method in class com.backblaze.b2.json.B2Json
+
+
Parses a JSON object into a map.
+
+
mapFromJson(String, Class<K>, Class<V>, B2JsonOptions) - Method in class com.backblaze.b2.json.B2Json
+
 
+
mapOf() - Static method in class com.backblaze.b2.util.B2Collections
+
 
+
mapOf(K, V) - Static method in class com.backblaze.b2.util.B2Collections
+
 
+
mapOf(K, V, K, V) - Static method in class com.backblaze.b2.util.B2Collections
+
 
+
mapOf(K, V, K, V, K, V) - Static method in class com.backblaze.b2.util.B2Collections
+
 
+
mapToJson(Map<?, ?>, Class<?>, Class<?>) - Method in class com.backblaze.b2.json.B2Json
+
+
Turn a map into JSON, returning the result as a string.
+
+
mapToJson(Map<?, ?>, Class<?>, Class<?>, B2JsonOptions) - Method in class com.backblaze.b2.json.B2Json
+
 
+
MAX_DAY - Static variable in class com.backblaze.b2.util.B2DateTimeUtil
+
 
+
MAX_MONTH - Static variable in class com.backblaze.b2.util.B2DateTimeUtil
+
 
+
MAX_YEAR - Static variable in class com.backblaze.b2.util.B2DateTimeUtil
+
 
+
MD5_SIZE - Static variable in interface com.backblaze.b2.util.B2Md5
+
 
+
message - Variable in class com.backblaze.b2.client.structures.B2ErrorStructure
+
+
A human-readable string giving details (if available) about what + went wrong.
+
+
MIN_DAY - Static variable in class com.backblaze.b2.util.B2DateTimeUtil
+
 
+
MIN_MONTH - Static variable in class com.backblaze.b2.util.B2DateTimeUtil
+
 
+
MIN_YEAR - Static variable in class com.backblaze.b2.util.B2DateTimeUtil
+
 
+
monotonicMillis() - Method in class com.backblaze.b2.util.B2Clock
+
 
+
monotonicMillis() - Method in class com.backblaze.b2.util.B2ClockImpl
+
 
+
monotonicMillis() - Method in class com.backblaze.b2.util.B2ClockSim
+
 
+
mustBeLargeFile(long) - Method in interface com.backblaze.b2.client.B2FilePolicy
+
 
+
+ + + +

N

+
+
name() - Method in annotation type com.backblaze.b2.json.B2Json.unionSubtypes.type
+
 
+
namePrefix - Variable in class com.backblaze.b2.client.structures.B2Allowed
+
 
+
next() - Method in class com.backblaze.b2.client.B2ListFilesIterableBase.IterBase
+
 
+
next() - Method in class com.backblaze.b2.client.B2ListKeysIterator
+
 
+
next() - Method in class com.backblaze.b2.client.B2ListPartsIterableBase.IterBase
+
 
+
nextNonWhitespaceIsEof() - Method in class com.backblaze.b2.json.B2JsonReader
+
+
Is the next character the given char?
+
+
NONE - Static variable in class com.backblaze.b2.client.structures.B2BucketReplicationConfiguration
+
+
Static field for convenience to use with updateBucket() to remove bucket replication configuration
+
+
NONE - Static variable in class com.backblaze.b2.client.structures.B2FileRetention
+
+
static field for convenience to use with updateFileRetention() to turn off retention
+
+
noopListener() - Static method in interface com.backblaze.b2.client.structures.B2UploadListener
+
 
+
+ + + +

O

+
+
objectHasMoreFields() - Method in class com.backblaze.b2.json.B2JsonReader
+
+
Does the object have any more fields?
+
+
OFF - Static variable in interface com.backblaze.b2.client.structures.B2LegalHold
+
+
Legal hold is off (disabled)
+
+
omitNull - Variable in class com.backblaze.b2.json.FieldInfo
+
 
+
omitNull() - Method in annotation type com.backblaze.b2.json.B2Json.optional
+
 
+
omitNull() - Method in annotation type com.backblaze.b2.json.B2Json.optionalWithDefault
+
 
+
omitZero - Variable in class com.backblaze.b2.json.FieldInfo
+
 
+
omitZero() - Method in annotation type com.backblaze.b2.json.B2Json.optional
+
 
+
omitZero() - Method in annotation type com.backblaze.b2.json.B2Json.optionalWithDefault
+
 
+
ON - Static variable in interface com.backblaze.b2.client.structures.B2LegalHold
+
+
Legal hold is on (enabled)
+
+
ONE_SECOND_IN_MILLIS - Static variable in class com.backblaze.b2.util.B2DateTimeUtil
+
 
+
OPTIONAL - com.backblaze.b2.json.FieldInfo.FieldRequirement
+
 
+
OTHER - com.backblaze.b2.client.exceptions.B2UnauthorizedException.RequestCategory
+
 
+
+ + + +

P

+
+
params() - Method in annotation type com.backblaze.b2.json.B2Json.constructor
+
+
This is optional for classes compiled with the '-parameters' javac argument
+
+
parse(byte[]) - Static method in class com.backblaze.b2.client.structures.B2EventNotification
+
+
Create a new EventNotification from JSON content with signature check.
+
+
parse(byte[], String, String) - Static method in class com.backblaze.b2.client.structures.B2EventNotification
+
+
Create a new EventNotification from JSON content with signature check.
+
+
parse(String) - Static method in class com.backblaze.b2.client.structures.B2EventNotification
+
+
Create a new EventNotification from JSON content with signature check.
+
+
parse(String) - Static method in class com.backblaze.b2.util.B2ByteRange
+
+
Parses a byte range that looks like: + + bytes=100-999 + + Returns null on error.
+
+
parse(String, String, String) - Static method in class com.backblaze.b2.client.structures.B2EventNotification
+
+
Create a new EventNotification from JSON content with signature check.
+
+
parseDateTime(String) - Static method in class com.backblaze.b2.util.B2DateTimeUtil
+
+
Parses a date-time string in any one of these formats: + + "20150314092654" - "solid" Backblaze dates + "d20150314_m092654" - FGUID-style Backblaze dates + "2015-03-14 09:26:54" - ISO-8601 with space + "2015-03-14T09:26" - ISO-8601 but no seconds + "2015-03-14T09:26:54" - ISO-8601 + "2015-03-14T09:26:54.547" - ISO-8601
+
+
parseDuration(String) - Static method in class com.backblaze.b2.util.B2DateTimeUtil
+
 
+
PART_NUMBER - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
parts(B2ListPartsRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Returns an iterable whose iterator yields the parts of large, + unfinished files that match the given request.
+
+
parts(B2ListPartsRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
parts(String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like parts(request), except that it makes a request for the parts + of the specified largeFileId.
+
+
peekNextNotWhitespaceChar() - Method in class com.backblaze.b2.json.B2JsonReader
+
+
Returns the next char that is not whitespace, but does not consume it.
+
+
PENDING - Static variable in interface com.backblaze.b2.client.structures.B2ReplicationStatus
+
 
+
percentDecode(String) - Static method in class com.backblaze.b2.util.B2StringUtil
+
 
+
percentEncode(String) - Static method in class com.backblaze.b2.util.B2StringUtil
+
 
+
postDataReturnJson(String, B2Headers, InputStream, long, Class<ResponseType>) - Method in interface com.backblaze.b2.client.webApiClients.B2WebApiClient
+
+
POSTs to a web service that takes content and returns JSON.
+
+
postJsonReturnJson(String, B2Headers, Object, Class<ResponseType>) - Method in interface com.backblaze.b2.client.webApiClients.B2WebApiClient
+
+
POSTs to a web service that takes JSON and returns JSON.
+
+
PRETTY - com.backblaze.b2.json.B2JsonOptions.SerializationOption
+
 
+
progress(long) - Method in interface com.backblaze.b2.util.B2ByteProgressListener
+
+
Called right before returning bytes to the caller.
+
+
progress(B2UploadProgress) - Method in interface com.backblaze.b2.client.structures.B2UploadListener
+
+
Called with progress about an upload.
+
+
put(String, Class<?>) - Method in class com.backblaze.b2.json.B2JsonUnionTypeMap.Builder
+
+
Adds a new type to the map being built.
+
+
+ + + +

R

+
+
range(int, int) - Static method in class com.backblaze.b2.json.VersionRange
+
+
Factory for a range.
+
+
RANGE - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
reachedEof(long) - Method in interface com.backblaze.b2.util.B2ByteProgressListener
+
+
Called right before the caller learns that we've hit the end of the stream.
+
+
read() - Method in class com.backblaze.b2.util.B2InputStreamExcerpt
+
 
+
read() - Method in class com.backblaze.b2.util.B2InputStreamWithByteProgressListener
+
 
+
read() - Method in class com.backblaze.b2.util.B2Sha1InputStream
+
 
+
read(byte[]) - Method in class com.backblaze.b2.util.B2InputStreamExcerpt
+
 
+
read(byte[]) - Method in class com.backblaze.b2.util.B2InputStreamWithByteProgressListener
+
 
+
read(byte[], int, int) - Method in class com.backblaze.b2.util.B2InputStreamExcerpt
+
 
+
read(byte[], int, int) - Method in class com.backblaze.b2.util.B2InputStreamWithByteProgressListener
+
 
+
read(byte[], int, int) - Method in class com.backblaze.b2.util.B2Sha1InputStream
+
 
+
READ_BUCKET_ENCRYPTION - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
READ_BUCKET_NOTIFICATIONS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
READ_BUCKET_REPLICATIONS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
READ_BUCKET_RETENTIONS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
READ_BUCKETS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
READ_FILE_LEGAL_HOLDS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
READ_FILE_RETENTIONS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
READ_FILES - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
readContent(B2Headers, InputStream) - Method in class com.backblaze.b2.client.contentHandlers.B2ContentMemoryWriter
+
 
+
readContent(B2Headers, InputStream) - Method in interface com.backblaze.b2.client.contentHandlers.B2ContentSink
+
+
Reads the data from the input stream.
+
+
readContent(B2Headers, InputStream) - Method in class com.backblaze.b2.client.contentHandlers.B2ContentWriter
+
 
+
readFalse() - Method in class com.backblaze.b2.json.B2JsonReader
+
+
Skips over "false".
+
+
readNull() - Method in class com.backblaze.b2.json.B2JsonReader
+
+
Skips over "null".
+
+
readNumberAsString() - Method in class com.backblaze.b2.json.B2JsonReader
+
+
Reads the next value, which is expected to be a number, and + returns it as a string.
+
+
readObjectFieldNameAndColon() - Method in class com.backblaze.b2.json.B2JsonReader
+
+
Reads the name of the next object field.
+
+
readString() - Method in class com.backblaze.b2.json.B2JsonReader
+
+
Reads a string value, returning its contents.
+
+
readToEnd(InputStream) - Static method in class com.backblaze.b2.util.B2IoUtils
+
 
+
readTrue() - Method in class com.backblaze.b2.json.B2JsonReader
+
+
Skips over "true".
+
+
REPLACE_METADATA_DIRECTIVE - Static variable in class com.backblaze.b2.client.structures.B2CopyFileRequest
+
 
+
REPLICA - Static variable in interface com.backblaze.b2.client.structures.B2ReplicationStatus
+
 
+
REPLICATION_STATUS - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
REQUIRED - com.backblaze.b2.json.FieldInfo.FieldRequirement
+
 
+
requirement - Variable in class com.backblaze.b2.json.FieldInfo
+
 
+
resetBoth(LocalDateTime) - Method in class com.backblaze.b2.util.B2ClockSim
+
+
This is intended to be run between tests to reset the clock to an initial + state, as if the simulator has just be constructed.
+
+
resolveType(Field) - Method in class com.backblaze.b2.json.B2TypeResolver
+
+
Resolve the type of the supplied field.
+
+
RETRY_AFTER - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
+ + + +

S

+
+
serialize(boolean[], B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonBooleanArrayHandler
+
 
+
serialize(byte[], B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonByteArrayHandler
+
 
+
serialize(char[], B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonCharArrayHandler
+
 
+
serialize(double[], B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonDoubleArrayHandler
+
 
+
serialize(float[], B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonFloatArrayHandler
+
 
+
serialize(int[], B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonIntArrayHandler
+
 
+
serialize(long[], B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonLongArrayHandler
+
 
+
serialize(Boolean, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonBooleanHandler
+
 
+
serialize(Byte, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonByteHandler
+
 
+
serialize(Character, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonCharacterHandler
+
 
+
serialize(CharSequence, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonCharSquenceHandler
+
 
+
serialize(Double, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonDoubleHandler
+
 
+
serialize(Float, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonFloatHandler
+
 
+
serialize(Integer, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonIntegerHandler
+
 
+
serialize(Long, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonLongHandler
+
 
+
serialize(String, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonStringHandler
+
 
+
serialize(BigDecimal, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonBigDecimalHandler
+
 
+
serialize(BigInteger, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonBigIntegerHandler
+
 
+
serialize(LocalDate, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonLocalDateHandler
+
 
+
serialize(LocalDateTime, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonLocalDateTimeHandler
+
 
+
serialize(AtomicLongArray, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonAtomicLongArrayHandler
+
 
+
serialize(ConcurrentMap, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonConcurrentMapHandler
+
 
+
serialize(EnumSet, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonEnumSetHandler
+
 
+
serialize(LinkedHashSet, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonLinkedHashSetHandler
+
 
+
serialize(List, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonListHandler
+
 
+
serialize(Map, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonMapHandler
+
 
+
serialize(Set, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonSetHandler
+
 
+
serialize(TreeSet, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonTreeSetHandler
+
 
+
serialize(T, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonEnumHandler
+
 
+
serialize(T, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonObjectArrayHandler
+
 
+
serialize(T, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonObjectHandler
+
+
Serializes the object, adding all fields to the JSON.
+
+
serialize(T, B2JsonOptions, B2JsonWriter) - Method in interface com.backblaze.b2.json.B2JsonTypeHandler
+
+
Serialize one object of the class to a JSON output stream.
+
+
serialize(T, B2JsonOptions, B2JsonWriter) - Method in class com.backblaze.b2.json.B2JsonUnionBaseHandler
+
 
+
serializeMaybeNull(B2JsonTypeHandler<T>, T, B2JsonWriter, B2JsonOptions) - Static method in class com.backblaze.b2.json.B2JsonUtil
+
+
Serialize an object that may be null.
+
+
SERVER_SIDE_ENCRYPTION - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
SERVER_SIDE_ENCRYPTION_CUSTOMER_ALGORITHM - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
SERVER_SIDE_ENCRYPTION_CUSTOMER_KEY - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
SERVER_SIDE_ENCRYPTION_CUSTOMER_KEY_MD5 - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
set(String, String) - Method in class com.backblaze.b2.client.contentSources.B2HeadersImpl.Builder
+
 
+
setAllowedHeaders(List<String>) - Method in class com.backblaze.b2.client.structures.B2CorsRule.Builder
+
 
+
setAllowNewlines(boolean) - Method in class com.backblaze.b2.json.B2JsonWriter
+
 
+
setB2CacheControl(String) - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest.Builder
+
 
+
setB2CacheControl(String) - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest.Builder
+
 
+
setB2CacheControl(String) - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest.Builder
+
 
+
setB2ContentDisposition(String) - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest.Builder
+
 
+
setB2ContentDisposition(String) - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest.Builder
+
 
+
setB2ContentDisposition(String) - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest.Builder
+
 
+
setB2ContentEncoding(String) - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest.Builder
+
 
+
setB2ContentEncoding(String) - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest.Builder
+
 
+
setB2ContentEncoding(String) - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest.Builder
+
 
+
setB2ContentLanguage(String) - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest.Builder
+
 
+
setB2ContentLanguage(String) - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest.Builder
+
 
+
setB2ContentLanguage(String) - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest.Builder
+
 
+
setB2ContentType(String) - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest.Builder
+
 
+
setB2ContentType(String) - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest.Builder
+
 
+
setB2ContentType(String) - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest.Builder
+
 
+
setB2Expires(String) - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest.Builder
+
 
+
setB2Expires(String) - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest.Builder
+
 
+
setB2Expires(String) - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest.Builder
+
 
+
setB2Expires(LocalDateTime) - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest.Builder
+
 
+
setB2Expires(LocalDateTime) - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest.Builder
+
 
+
setB2Expires(LocalDateTime) - Method in class com.backblaze.b2.client.structures.B2GetDownloadAuthorizationRequest.Builder
+
 
+
setBucketId(String) - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequest.Builder
+
 
+
setBucketId(String) - Method in class com.backblaze.b2.client.structures.B2ListBucketsRequest.Builder
+
 
+
setBucketInfo(Map<String, String>) - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequest.Builder
+
 
+
setBucketInfo(Map<String, String>) - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest.Builder
+
 
+
setBucketName(String) - Method in class com.backblaze.b2.client.structures.B2ListBucketsRequest.Builder
+
 
+
setBucketNotificationRules(B2AccountAuthorization, B2SetBucketNotificationRulesRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
setBucketNotificationRules(B2AccountAuthorization, B2SetBucketNotificationRulesRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
setBucketNotificationRules(B2SetBucketNotificationRulesRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Sets the bucket's event notification rules as described by the request.
+
+
setBucketNotificationRules(B2SetBucketNotificationRulesRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
setBucketNotificationRules(String, List<B2EventNotificationRule>) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like setBucketNotificationRules(request), except that the request is created from + the specified bucketId and eventNotificationRules.
+
+
setBucketType(String) - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest.Builder
+
 
+
setBucketTypes(Set<String>) - Method in class com.backblaze.b2.client.structures.B2ListBucketsRequest.Builder
+
 
+
setBypassGovernance(boolean) - Method in class com.backblaze.b2.client.structures.B2DeleteFileVersionRequest.Builder
+
 
+
setBypassGovernance(boolean) - Method in class com.backblaze.b2.client.structures.B2UpdateFileRetentionRequest.Builder
+
 
+
setConstructorArgIndex(int) - Method in class com.backblaze.b2.json.FieldInfo
+
 
+
setContentType(String) - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest.Builder
+
 
+
setCorsRules(List<B2CorsRule>) - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequest.Builder
+
 
+
setCorsRules(List<B2CorsRule>) - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest.Builder
+
 
+
setCustomField(String, String) - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest.Builder
+
 
+
setCustomField(String, String) - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest.Builder
+
 
+
setCustomFields(Map<String, String>) - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest.Builder
+
 
+
setCustomFields(Map<String, String>) - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest.Builder
+
 
+
setCustomUploadTimestamp(Long) - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest.Builder
+
 
+
setCustomUploadTimestamp(Long) - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest.Builder
+
 
+
setDaysFromHidingToDeleting(Integer) - Method in class com.backblaze.b2.client.structures.B2LifecycleRule.Builder
+
 
+
setDaysFromStartingToCancelingUnfinishedLargeFiles(Integer) - Method in class com.backblaze.b2.client.structures.B2LifecycleRule.Builder
+
 
+
setDaysFromUploadingToHiding(Integer) - Method in class com.backblaze.b2.client.structures.B2LifecycleRule.Builder
+
 
+
setDefaultRetention(B2BucketDefaultRetention) - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest.Builder
+
 
+
setDefaultServerSideEncryption(B2BucketServerSideEncryption) - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequest.Builder
+
 
+
setDefaultServerSideEncryption(B2BucketServerSideEncryption) - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest.Builder
+
 
+
setDelimiter(String) - Method in class com.backblaze.b2.client.structures.B2ListFileNamesRequest.Builder
+
 
+
setDelimiter(String) - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest.Builder
+
 
+
setDestinationBucketId(String) - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest.Builder
+
 
+
setDestinationServerSideEncryption(B2FileSseForRequest) - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest.Builder
+
 
+
setDestinationServerSideEncryption(B2FileSseForRequest) - Method in class com.backblaze.b2.client.structures.B2CopyPartRequest.Builder
+
 
+
setExposeHeaders(List<String>) - Method in class com.backblaze.b2.client.structures.B2CorsRule.Builder
+
 
+
setExtraFieldOption(B2JsonOptions.ExtraFieldOption) - Method in class com.backblaze.b2.json.B2JsonOptions.Builder
+
 
+
setFileInfo(Map<String, String>) - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest.Builder
+
 
+
setFileLockEnabled(boolean) - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequest.Builder
+
 
+
setFileLockEnabled(Boolean) - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest.Builder
+
 
+
setFileRetention(B2FileRetention) - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest.Builder
+
 
+
setFileRetention(B2FileRetention) - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest.Builder
+
 
+
setFileRetention(B2FileRetention) - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest.Builder
+
 
+
setLargeFileSha1(String) - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest.Builder
+
 
+
setLegalHold(String) - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest.Builder
+
 
+
setLegalHold(String) - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest.Builder
+
 
+
setLegalHold(String) - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest.Builder
+
 
+
setLifecycleRules(List<B2LifecycleRule>) - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequest.Builder
+
 
+
setLifecycleRules(List<B2LifecycleRule>) - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest.Builder
+
 
+
setListener(B2UploadListener) - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest.Builder
+
 
+
setMasterUrl(String) - Method in class com.backblaze.b2.client.B2ClientConfig.Builder
+
 
+
setMaxFileCount(Integer) - Method in class com.backblaze.b2.client.structures.B2ListFileNamesRequest.Builder
+
 
+
setMaxFileCount(Integer) - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest.Builder
+
 
+
setMaxFileCount(Integer) - Method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesRequest.Builder
+
 
+
setMaxKeyCount(Integer) - Method in class com.backblaze.b2.client.structures.B2ListKeysRequest.Builder
+
 
+
setMaxPartCount(Integer) - Method in class com.backblaze.b2.client.structures.B2ListPartsRequest.Builder
+
 
+
setMetadataDirective(String) - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest.Builder
+
 
+
setNamePrefix(String) - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequest.Builder
+
 
+
setNamePrefix(String) - Method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesRequest.Builder
+
 
+
setPartNumberGapsAllowed(boolean) - Method in class com.backblaze.b2.client.B2ClientConfig.Builder
+
 
+
setPrefix(String) - Method in class com.backblaze.b2.client.structures.B2ListFileNamesRequest.Builder
+
 
+
setPrefix(String) - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest.Builder
+
 
+
setRange(B2ByteRange) - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest.Builder
+
 
+
setRange(B2ByteRange) - Method in class com.backblaze.b2.client.structures.B2CopyPartRequest.Builder
+
 
+
setRange(B2ByteRange) - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest.Builder
+
 
+
setRange(B2ByteRange) - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest.Builder
+
 
+
setRedactSensitive(boolean) - Method in class com.backblaze.b2.json.B2JsonOptions.Builder
+
 
+
setReplicationConfiguration(B2BucketReplicationConfiguration) - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequest.Builder
+
 
+
setReplicationConfiguration(B2BucketReplicationConfiguration) - Method in class com.backblaze.b2.client.structures.B2UpdateBucketRequest.Builder
+
 
+
setRequestCategory(B2UnauthorizedException.RequestCategory) - Method in exception com.backblaze.b2.client.exceptions.B2UnauthorizedException
+
 
+
setSerializationOption(B2JsonOptions.SerializationOption) - Method in class com.backblaze.b2.json.B2JsonOptions.Builder
+
 
+
setServerSideEncryption(B2FileSseForRequest) - Method in class com.backblaze.b2.client.structures.B2DownloadByIdRequest.Builder
+
 
+
setServerSideEncryption(B2FileSseForRequest) - Method in class com.backblaze.b2.client.structures.B2DownloadByNameRequest.Builder
+
 
+
setServerSideEncryption(B2FileSseForRequest) - Method in class com.backblaze.b2.client.structures.B2GetFileInfoByNameRequest.Builder
+
 
+
setServerSideEncryption(B2FileSseForRequest) - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest.Builder
+
 
+
setServerSideEncryption(B2FileSseForRequest) - Method in class com.backblaze.b2.client.structures.B2StoreLargeFileRequest.Builder
+
 
+
setServerSideEncryption(B2FileSseForRequest) - Method in class com.backblaze.b2.client.structures.B2UploadFileRequest.Builder
+
 
+
setServerSideEncryption(B2FileSseForRequest) - Method in class com.backblaze.b2.client.structures.B2UploadPartRequest.Builder
+
 
+
setSha1(String) - Method in class com.backblaze.b2.client.contentSources.B2FileContentSource.Builder
+
 
+
setSha1OrNull(String) - Method in class com.backblaze.b2.client.contentSources.B2ByteArrayContentSource.Builder
+
 
+
setSourceServerSideEncryption(B2FileSseForRequest) - Method in class com.backblaze.b2.client.structures.B2CopyFileRequest.Builder
+
 
+
setSourceServerSideEncryption(B2FileSseForRequest) - Method in class com.backblaze.b2.client.structures.B2CopyPartRequest.Builder
+
 
+
setSrcLastModifiedMillisOrNull(long) - Method in class com.backblaze.b2.client.structures.B2StartLargeFileRequest.Builder
+
+
Sets one of your custom fields to be this well-known field.
+
+
setSrcLastModifiedMillisOrNull(Long) - Method in class com.backblaze.b2.client.contentSources.B2ByteArrayContentSource.Builder
+
 
+
setStart(String, String) - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest.Builder
+
 
+
setStartApplicationKeyId(String) - Method in class com.backblaze.b2.client.structures.B2ListKeysRequest.Builder
+
 
+
setStartFileId(String) - Method in class com.backblaze.b2.client.structures.B2ListUnfinishedLargeFilesRequest.Builder
+
 
+
setStartFileName(String) - Method in class com.backblaze.b2.client.structures.B2ListFileNamesRequest.Builder
+
 
+
setStartFileName(String) - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest.Builder
+
 
+
setStartPartNumber(Integer) - Method in class com.backblaze.b2.client.structures.B2ListPartsRequest.Builder
+
 
+
setTestModeOrNull(B2TestMode) - Method in class com.backblaze.b2.client.B2ClientConfig.Builder
+
 
+
setValidDurationInSeconds(Long) - Method in class com.backblaze.b2.client.structures.B2CreateKeyRequest.Builder
+
 
+
setVerifySha1ByRereadingFromDestination(boolean) - Method in class com.backblaze.b2.client.contentHandlers.B2ContentFileWriter.Builder
+
 
+
setVerifySha1ByRereadingFromDestination(boolean) - Method in class com.backblaze.b2.client.contentHandlers.B2ContentMemoryWriter.Builder
+
 
+
setVersion(int) - Method in class com.backblaze.b2.json.B2JsonOptions.Builder
+
 
+
setWithinFolder(String) - Method in class com.backblaze.b2.client.structures.B2ListFileNamesRequest.Builder
+
 
+
setWithinFolder(String) - Method in class com.backblaze.b2.client.structures.B2ListFileVersionsRequest.Builder
+
 
+
SHA1_SIZE - Static variable in interface com.backblaze.b2.util.B2Sha1
+
 
+
SHARE_FILES - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
shouldBeLargeFile(long) - Method in interface com.backblaze.b2.client.B2FilePolicy
+
 
+
shouldVerifySha1ByRereadingFromDestination() - Method in interface com.backblaze.b2.client.contentHandlers.B2ContentOutputStreamWriter.Helper
+
+
This might be called multiple times.
+
+
shutdownAndAwaitTermination(ExecutorService, int, int) - Static method in class com.backblaze.b2.util.B2ExecutorUtils
+
 
+
skip(long) - Method in class com.backblaze.b2.util.B2InputStreamExcerpt
+
 
+
skip(long) - Method in class com.backblaze.b2.util.B2InputStreamWithByteProgressListener
+
 
+
skip(long) - Method in class com.backblaze.b2.util.B2Sha1InputStream
+
 
+
skipObjectColon() - Method in class com.backblaze.b2.json.B2JsonReader
+
 
+
skipValue() - Method in class com.backblaze.b2.json.B2JsonReader
+
+
Skips over a value of any type.
+
+
SRC_LAST_MODIFIED_MILLIS - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
SRC_LAST_MODIFIED_MILLIS_INFO_NAME - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
SSE_B2 - Static variable in interface com.backblaze.b2.client.structures.B2ServerSideEncryptionMode
+
 
+
SSE_C - Static variable in interface com.backblaze.b2.client.structures.B2ServerSideEncryptionMode
+
 
+
start - Variable in class com.backblaze.b2.util.B2ByteRange
+
+
The index of the first byte in the range, zero based, + or null if there is no starting index.
+
+
START_ACTION - Static variable in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
startArray() - Method in class com.backblaze.b2.json.B2JsonWriter
+
 
+
startArrayAndCheckForContents() - Method in class com.backblaze.b2.json.B2JsonReader
+
+
Starts reading an array by reading the "[".
+
+
startArrayValue() - Method in class com.backblaze.b2.json.B2JsonWriter
+
 
+
startAt(long) - Static method in class com.backblaze.b2.util.B2ByteRange
+
 
+
STARTING - com.backblaze.b2.client.structures.B2UploadState
+
 
+
startLargeFile(B2AccountAuthorization, B2StartLargeFileRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
startLargeFile(B2AccountAuthorization, B2StartLargeFileRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
startLargeFile(B2StartLargeFileRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
This method allows the caller to start a large file.
+
+
startLargeFile(B2StartLargeFileRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
startObject() - Method in class com.backblaze.b2.json.B2JsonWriter
+
 
+
startObjectAndCheckForContents() - Method in class com.backblaze.b2.json.B2JsonReader
+
+
Reads the open brace for an object.
+
+
startObjectFieldName() - Method in class com.backblaze.b2.json.B2JsonWriter
+
 
+
startsWithIgnoreCase(String, String) - Static method in class com.backblaze.b2.util.B2StringUtil
+
 
+
status - Variable in class com.backblaze.b2.client.structures.B2ErrorStructure
+
+
The HTTP status code being returned.
+
+
STATUS - Static variable in exception com.backblaze.b2.client.exceptions.B2BadRequestException
+
 
+
STATUS - Static variable in exception com.backblaze.b2.client.exceptions.B2ForbiddenException
+
 
+
STATUS - Static variable in exception com.backblaze.b2.client.exceptions.B2InternalErrorException
+
 
+
STATUS - Static variable in exception com.backblaze.b2.client.exceptions.B2LocalException
+
 
+
STATUS - Static variable in exception com.backblaze.b2.client.exceptions.B2NotFoundException
+
 
+
STATUS - Static variable in exception com.backblaze.b2.client.exceptions.B2RequestTimeoutException
+
 
+
STATUS - Static variable in exception com.backblaze.b2.client.exceptions.B2ServiceUnavailableException
+
 
+
STATUS - Static variable in exception com.backblaze.b2.client.exceptions.B2SignatureVerificationException
+
 
+
STATUS - Static variable in exception com.backblaze.b2.client.exceptions.B2TooManyRequestsException
+
 
+
STATUS - Static variable in exception com.backblaze.b2.client.exceptions.B2UnauthorizedException
+
 
+
storeLargeFile(B2FileVersion, List<B2PartStorer>, B2UploadListener, ExecutorService) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Stores a large file, where storing each part may involve different behavior + or byte sources.
+
+
storeLargeFile(B2FileVersion, List<B2PartStorer>, B2UploadListener, ExecutorService) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
storeLargeFile(B2StoreLargeFileRequest, List<B2PartStorer>, B2UploadListener, ExecutorService) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Stores a large file, where storing each part may involve different behavior + or byte sources, optionally allowing caller to pass SSE-C parameters to match + those given to startLargeFile().
+
+
storeLargeFile(B2StoreLargeFileRequest, List<B2PartStorer>, B2UploadListener, ExecutorService) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
storeLargeFileFromLocalContent(B2FileVersion, B2ContentSource, B2UploadListener, ExecutorService) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Uploads the specified content source as separate parts to form a B2 large file.
+
+
storeLargeFileFromLocalContent(B2FileVersion, B2ContentSource, B2UploadListener, ExecutorService) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
storeLargeFileFromLocalContent(B2StoreLargeFileRequest, B2ContentSource, B2UploadListener, ExecutorService) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Uploads the specified content source as separate parts to form a B2 large file, + optionally allowing caller to pass SSE-C parameters to match those given to + startLargeFile().
+
+
storeLargeFileFromLocalContent(B2StoreLargeFileRequest, B2ContentSource, B2UploadListener, ExecutorService) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
storeLargeFileFromLocalContentAsync(B2FileVersion, B2ContentSource, B2UploadListener, ExecutorService) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Initiates uploading the specified content source as separate parts to form a + B2 large file.
+
+
storeLargeFileFromLocalContentAsync(B2FileVersion, B2ContentSource, B2UploadListener, ExecutorService) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
storeLargeFileFromLocalContentAsync(B2StoreLargeFileRequest, B2ContentSource, B2UploadListener, ExecutorService) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Initiates uploading the specified content source as separate parts to form a + B2 large file.
+
+
storeLargeFileFromLocalContentAsync(B2StoreLargeFileRequest, B2ContentSource, B2UploadListener, ExecutorService) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
storePart(B2LargeFileStorer, B2UploadListener, B2CancellationToken) - Method in class com.backblaze.b2.client.B2AlreadyStoredPartStorer
+
 
+
storePart(B2LargeFileStorer, B2UploadListener, B2CancellationToken) - Method in class com.backblaze.b2.client.B2CopyingPartStorer
+
 
+
storePart(B2LargeFileStorer, B2UploadListener, B2CancellationToken) - Method in interface com.backblaze.b2.client.B2PartStorer
+
+
Store the part this B2PartStorer is responsible for.
+
+
storePart(B2LargeFileStorer, B2UploadListener, B2CancellationToken) - Method in class com.backblaze.b2.client.B2UploadingPartStorer
+
 
+
storePartsForLargeFile(B2FileVersion, List<B2PartStorer>, B2UploadListener, ExecutorService) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Stores large file parts, where storing each part may involve different behavior + or byte sources.
+
+
storePartsForLargeFile(B2FileVersion, List<B2PartStorer>, B2UploadListener, ExecutorService) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
storePartsForLargeFile(B2StoreLargeFileRequest, List<B2PartStorer>, B2UploadListener, ExecutorService) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Stores large file parts, where storing each part may involve different behavior + or byte sources, optionally allowing caller to pass SSE-C parameters to match + those given to startLargeFile().
+
+
storePartsForLargeFile(B2StoreLargeFileRequest, List<B2PartStorer>, B2UploadListener, ExecutorService) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
succeeded() - Method in interface com.backblaze.b2.client.contentHandlers.B2ContentOutputStreamWriter.Helper
+
+
Called after the download succeeds.
+
+
succeeded() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentOutputStreamWriter
+
 
+
succeeded() - Method in class com.backblaze.b2.client.contentHandlers.B2ContentWriter
+
+
Called when the download succeeded and, to the extent we're able to verify it, the SHA1 matched.
+
+
succeeded(String, int, long) - Method in interface com.backblaze.b2.client.B2RetryPolicy
+
+
Called when callable.call() returns without an exception.
+
+
SUCCEEDED - com.backblaze.b2.client.structures.B2UploadState
+
 
+
supplier() - Static method in class com.backblaze.b2.client.B2DefaultRetryPolicy
+
 
+
SYSTEM_MAX_CAPACITY - Static variable in class com.backblaze.b2.json.B2JsonBoundedByteArrayOutputStream
+
 
+
+ + + +

T

+
+
TEST_MODE - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
TEXT_PLAIN - Static variable in interface com.backblaze.b2.client.contentSources.B2ContentTypes
+
 
+
throwIfBadDefaultValue() - Method in class com.backblaze.b2.json.B2JsonTypeHandlerWithDefaults
+
+
Before (de)serializing, make sure that the defaults are OK.
+
+
toApplicationKey() - Method in class com.backblaze.b2.client.structures.B2CreatedApplicationKey
+
+
Converts to the B2ApplicationKey structure, as returned from b2_list_keys, + which does not contain the secret key.
+
+
toByteArray() - Method in class com.backblaze.b2.json.B2JsonBoundedByteArrayOutputStream
+
+
returns a copy of the output byte array
+
+
toHexString(byte[]) - Static method in class com.backblaze.b2.util.B2StringUtil
+
 
+
toJson(Object) - Method in class com.backblaze.b2.json.B2Json
+
+
Turn an object into JSON, returning the result as a string.
+
+
toJson(Object, B2JsonOptions) - Method in class com.backblaze.b2.json.B2Json
+
 
+
toJson(Object, B2JsonOptions, OutputStream) - Method in class com.backblaze.b2.json.B2Json
+
+
Turn an object into JSON, writing the results to given output stream and + using the supplied options.
+
+
toJson(Object, B2JsonOptions, OutputStream, Type) - Method in class com.backblaze.b2.json.B2Json
+
+
Turn an object into JSON, writing the results to given + output stream.
+
+
toJson(Object, OutputStream) - Method in class com.backblaze.b2.json.B2Json
+
+
Turn an object into JSON, writing the results to given output stream.
+
+
toJsonOrThrowRuntime(Object) - Static method in class com.backblaze.b2.json.B2Json
+
+
Turn an object into JSON, returning the result as a string.
+
+
toJsonOrThrowRuntime(Object, B2JsonOptions) - Static method in class com.backblaze.b2.json.B2Json
+
 
+
toJsonUtf8Bytes(Object) - Method in class com.backblaze.b2.json.B2Json
+
+
Turn an object into JSON, returning the result as an array of UTF-8 + bytes.
+
+
toJsonUtf8Bytes(Object, B2JsonOptions) - Method in class com.backblaze.b2.json.B2Json
+
 
+
toJsonUtf8BytesWithNewline(Object) - Method in class com.backblaze.b2.json.B2Json
+
+
Turn an object into JSON, returning the result as an array of UTF-8 + bytes.
+
+
toJsonUtf8BytesWithNewline(Object, B2JsonOptions) - Method in class com.backblaze.b2.json.B2Json
+
 
+
toString() - Method in class com.backblaze.b2.client.B2PartSpec
+
 
+
toString() - Method in class com.backblaze.b2.client.contentSources.B2HeadersImpl
+
 
+
toString() - Method in exception com.backblaze.b2.client.exceptions.B2Exception
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2AccountAuthorization
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2Allowed
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2AuthorizationFilteredResponseField
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2Bucket
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2BucketDefaultRetention
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2BucketDefaultRetentionPeriod
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2BucketFileLockConfiguration
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2BucketReplicationConfiguration
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2BucketServerSideEncryption
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2CancelLargeFileResponse
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2CorsRule
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2CreateBucketRequestReal
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2DeleteFileVersionResponse
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2EventNotification
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2EventNotificationEvent
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2EventNotificationRule
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2FileRetention
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2FileSseForRequest
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2FileSseForResponse
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesRequest
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2GetBucketNotificationRulesResponse
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2LifecycleRule
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2Part
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2ReplicationRule
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesRequest
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2SetBucketNotificationRulesResponse
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2UpdateFileLegalHoldResponse
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2UpdateFileRetentionResponse
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2UploadProgress
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2WebhookConfiguration
+
 
+
toString() - Method in class com.backblaze.b2.client.structures.B2WebhookCustomHeader
+
 
+
toString() - Method in class com.backblaze.b2.util.B2ByteRange
+
+
Returns a string like "bytes=200-340"
+
+
toString(String) - Method in class com.backblaze.b2.json.B2JsonBoundedByteArrayOutputStream
+
+
makes a new String by decoding the bytes in output array + using the specified charset.
+
+
typeField() - Method in annotation type com.backblaze.b2.json.B2Json.union
+
 
+
+ + + +

U

+
+
underscoresToCamelCase(String, boolean) - Static method in class com.backblaze.b2.util.B2StringUtil
+
+
This returns a new string with the first letter title-cased, and + first character after each "_" title-cased, and all underscores removed.
+
+
unfinishedLargeFiles(B2ListUnfinishedLargeFilesRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Returns an iterable whose iterator yields the fileVersions of large, + unfinished files that match the given request.
+
+
unfinishedLargeFiles(B2ListUnfinishedLargeFilesRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
unfinishedLargeFiles(String) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Just like unfinishedLargeFiles(request), except that it makes a request for all + unfinished large files in the specified bucket.
+
+
UNKNOWN_PART_SIZE_PLACEHOLDER - Static variable in class com.backblaze.b2.client.structures.B2UploadProgress
+
+
Placeholder value for part sizes that will not be known until the + part is stored in B2.
+
+
UNKNOWN_PART_START_BYTE - Static variable in class com.backblaze.b2.client.structures.B2UploadProgress
+
+
Constant value used to indicate that the starting byte position of + the part is unknown.
+
+
unmodifiableMap(Map<K, V>) - Static method in class com.backblaze.b2.util.B2Collections
+
 
+
unmodifiableSet(T[]) - Static method in class com.backblaze.b2.util.B2Collections
+
 
+
updateBucket(B2AccountAuthorization, B2UpdateBucketRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
updateBucket(B2AccountAuthorization, B2UpdateBucketRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
updateBucket(B2UpdateBucketRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Updates the specified bucket as described by the request.
+
+
updateBucket(B2UpdateBucketRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
updateFileLegalHold(B2AccountAuthorization, B2UpdateFileLegalHoldRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
updateFileLegalHold(B2AccountAuthorization, B2UpdateFileLegalHoldRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
updateFileLegalHold(B2UpdateFileLegalHoldRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Updates the legal hold configuration of the specified file as described by the request.
+
+
updateFileLegalHold(B2UpdateFileLegalHoldRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
updateFileRetention(B2AccountAuthorization, B2UpdateFileRetentionRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
updateFileRetention(B2AccountAuthorization, B2UpdateFileRetentionRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
updateFileRetention(B2UpdateFileRetentionRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Updates the file retention configuration of the specified file as described by the request.
+
+
updateFileRetention(B2UpdateFileRetentionRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
UPLOAD_ACTION - Static variable in class com.backblaze.b2.client.structures.B2FileVersion
+
 
+
UPLOAD_TIMESTAMP - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
uploadFile(B2UploadUrlResponse, B2UploadFileRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
uploadFile(B2UploadUrlResponse, B2UploadFileRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
UPLOADING - com.backblaze.b2.client.exceptions.B2UnauthorizedException.RequestCategory
+
 
+
UPLOADING - com.backblaze.b2.client.structures.B2UploadState
+
 
+
uploadLargeFile(B2UploadFileRequest, ExecutorService) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Uploads the specified content as separate parts to form a B2 large file.
+
+
uploadLargeFile(B2UploadFileRequest, ExecutorService) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
uploadPart(int, B2ContentSource, B2UploadListener) - Method in class com.backblaze.b2.client.B2LargeFileStorer
+
+
Stores a part by uploading the bytes from a content source.
+
+
uploadPart(B2UploadPartUrlResponse, B2UploadPartRequest) - Method in interface com.backblaze.b2.client.B2StorageClientWebifier
+
 
+
uploadPart(B2UploadPartUrlResponse, B2UploadPartRequest) - Method in class com.backblaze.b2.client.B2StorageClientWebifierImpl
+
 
+
uploadSmallFile(B2UploadFileRequest) - Method in interface com.backblaze.b2.client.B2StorageClient
+
+
Uploads the specified content as a normal B2 file.
+
+
uploadSmallFile(B2UploadFileRequest) - Method in class com.backblaze.b2.client.B2StorageClientImpl
+
 
+
USER_AGENT - Static variable in interface com.backblaze.b2.client.contentSources.B2Headers
+
 
+
useSimulator(LocalDateTime) - Static method in class com.backblaze.b2.util.B2Clock
+
+
If theClock is null, this will create a B2ClockSim with the desiredNow.
+
+
UTF8 - Static variable in class com.backblaze.b2.util.B2StringUtil
+
 
+
+ + + +

V

+
+
value() - Method in annotation type com.backblaze.b2.json.B2Json.defaultForUnknownType
+
 
+
value() - Method in annotation type com.backblaze.b2.json.B2Json.serializedName
+
 
+
value() - Method in annotation type com.backblaze.b2.json.B2Json.unionSubtypes
+
 
+
valueOf(String) - Static method in enum com.backblaze.b2.client.exceptions.B2UnauthorizedException.RequestCategory
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.backblaze.b2.client.structures.B2TestMode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.backblaze.b2.client.structures.B2UploadState
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.backblaze.b2.json.B2JsonOptions.ExtraFieldOption
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.backblaze.b2.json.B2JsonOptions.SerializationOption
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.backblaze.b2.json.FieldInfo.FieldRequirement
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum com.backblaze.b2.client.exceptions.B2UnauthorizedException.RequestCategory
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.backblaze.b2.client.structures.B2TestMode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.backblaze.b2.client.structures.B2UploadState
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.backblaze.b2.json.B2JsonOptions.ExtraFieldOption
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.backblaze.b2.json.B2JsonOptions.SerializationOption
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.backblaze.b2.json.FieldInfo.FieldRequirement
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
versionParam() - Method in annotation type com.backblaze.b2.json.B2Json.constructor
+
 
+
versionParam() - Method in annotation type com.backblaze.b2.json.B2Json.type
+
+
When versionParam is non-empty, it is the name of a parameter that + is not a field name, and will take the version number being constructed.
+
+
versionRange - Variable in class com.backblaze.b2.json.FieldInfo
+
 
+
VersionRange - Class in com.backblaze.b2.json
+
+
Holds a range of version numbers.
+
+
+ + + +

W

+
+
WAITING_TO_START - com.backblaze.b2.client.structures.B2UploadState
+
 
+
wallClockMillis() - Method in class com.backblaze.b2.util.B2Clock
+
 
+
wallClockMillis() - Method in class com.backblaze.b2.util.B2ClockImpl
+
 
+
wallClockMillis() - Method in class com.backblaze.b2.util.B2ClockSim
+
 
+
withAuthToken(String) - Method in class com.backblaze.b2.client.structures.B2AccountAuthorization
+
 
+
write(byte[]) - Method in class com.backblaze.b2.util.B2FlushAndSyncFileOnCloseOutputStream
+
 
+
write(byte[], int, int) - Method in class com.backblaze.b2.json.B2JsonBoundedByteArrayOutputStream
+
+
writes an array of bytes into the output array
+
+
write(byte[], int, int) - Method in class com.backblaze.b2.util.B2FlushAndSyncFileOnCloseOutputStream
+
 
+
write(int) - Method in class com.backblaze.b2.json.B2JsonBoundedByteArrayOutputStream
+
+
writes one byte into the output array
+
+
write(int) - Method in class com.backblaze.b2.util.B2FlushAndSyncFileOnCloseOutputStream
+
 
+
write(String, OutputStream) - Static method in class com.backblaze.b2.util.B2Utf8Util
+
+
Writes the characters from str to out encoded as UTF-8.
+
+
WRITE_BUCKET_ENCRYPTION - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
WRITE_BUCKET_NOTIFICATIONS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
WRITE_BUCKET_REPLICATIONS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
WRITE_BUCKET_RETENTIONS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
WRITE_BUCKETS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
WRITE_FILE_LEGAL_HOLDS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
WRITE_FILE_RETENTIONS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
WRITE_FILES - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
WRITE_KEYS - Static variable in interface com.backblaze.b2.client.structures.B2Capabilities
+
 
+
writeFieldNameValueSeparator() - Method in class com.backblaze.b2.json.B2JsonWriter
+
 
+
writeJsonString(CharSequence, OutputStream) - Static method in class com.backblaze.b2.util.B2Utf8Util
+
+
Writes the characters from str to out encoded as a quoted + JSON string.
+
+
writeObjectFieldNameAndColon(String) - Method in class com.backblaze.b2.json.B2JsonWriter
+
 
+
writeString(CharSequence) - Method in class com.backblaze.b2.json.B2JsonWriter
+
 
+
writeText(String) - Method in class com.backblaze.b2.json.B2JsonWriter
+
 
+
+ + + +

Y

+
+
YEARS - Static variable in interface com.backblaze.b2.client.structures.B2FileRetentionPeriodUnit
+
 
+
+A B C D E F G H I J L M N O P R S T U V W Y 
All Classes All Packages
+
+ + + diff --git a/index.html b/index.html new file mode 100644 index 000000000..67b2055d7 --- /dev/null +++ b/index.html @@ -0,0 +1,192 @@ + + + + + +Overview (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

b2-sdk-core 6.3.0-SNAPSHOT API

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
com.backblaze.b2.client 
com.backblaze.b2.client.contentHandlers 
com.backblaze.b2.client.contentSources 
com.backblaze.b2.client.credentialsSources 
com.backblaze.b2.client.exceptions 
com.backblaze.b2.client.structures 
com.backblaze.b2.client.webApiClients 
com.backblaze.b2.json 
com.backblaze.b2.util 
+
+
+ + + diff --git a/jquery-ui.overrides.css b/jquery-ui.overrides.css new file mode 100644 index 000000000..facf852c2 --- /dev/null +++ b/jquery-ui.overrides.css @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +.ui-state-active, +.ui-widget-content .ui-state-active, +.ui-widget-header .ui-state-active, +a.ui-button:active, +.ui-button:active, +.ui-button.ui-state-active:hover { + /* Overrides the color of selection used in jQuery UI */ + background: #F8981D; + border: 1px solid #F8981D; +} diff --git a/jquery/external/jquery/jquery.js b/jquery/external/jquery/jquery.js new file mode 100644 index 000000000..50937333b --- /dev/null +++ b/jquery/external/jquery/jquery.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( "\r\n"; + +// inject VBScript +document.write(IEBinaryToArray_ByteStr_Script); + +global.JSZipUtils._getBinaryFromXHR = function (xhr) { + var binary = xhr.responseBody; + var byteMapping = {}; + for ( var i = 0; i < 256; i++ ) { + for ( var j = 0; j < 256; j++ ) { + byteMapping[ String.fromCharCode( i + (j << 8) ) ] = + String.fromCharCode(i) + String.fromCharCode(j); + } + } + var rawBytes = IEBinaryToArray_ByteStr(binary); + var lastChr = IEBinaryToArray_ByteStr_Last(binary); + return rawBytes.replace(/[\s\S]/g, function( match ) { + return byteMapping[match]; + }) + lastChr; +}; + +// enforcing Stuk's coding style +// vim: set shiftwidth=4 softtabstop=4: + +},{}]},{},[1]) +; diff --git a/jquery/jszip-utils/dist/jszip-utils-ie.min.js b/jquery/jszip-utils/dist/jszip-utils-ie.min.js new file mode 100644 index 000000000..93d8bc8ef --- /dev/null +++ b/jquery/jszip-utils/dist/jszip-utils-ie.min.js @@ -0,0 +1,10 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g\r\n";document.write(b),a.JSZipUtils._getBinaryFromXHR=function(a){for(var b=a.responseBody,c={},d=0;256>d;d++)for(var e=0;256>e;e++)c[String.fromCharCode(d+(e<<8))]=String.fromCharCode(d)+String.fromCharCode(e);var f=IEBinaryToArray_ByteStr(b),g=IEBinaryToArray_ByteStr_Last(b);return f.replace(/[\s\S]/g,function(a){return c[a]})+g}},{}]},{},[1]); diff --git a/jquery/jszip-utils/dist/jszip-utils.js b/jquery/jszip-utils/dist/jszip-utils.js new file mode 100644 index 000000000..775895ec9 --- /dev/null +++ b/jquery/jszip-utils/dist/jszip-utils.js @@ -0,0 +1,118 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(e){"object"==typeof exports?module.exports=e():"function"==typeof define&&define.amd?define(e):"undefined"!=typeof window?window.JSZipUtils=e():"undefined"!=typeof global?global.JSZipUtils=e():"undefined"!=typeof self&&(self.JSZipUtils=e())}(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(a){"object"==typeof exports?module.exports=a():"function"==typeof define&&define.amd?define(a):"undefined"!=typeof window?window.JSZipUtils=a():"undefined"!=typeof global?global.JSZipUtils=a():"undefined"!=typeof self&&(self.JSZipUtils=a())}(function(){return function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g + +(c) 2009-2016 Stuart Knightley +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip/master/LICENSE.markdown. + +JSZip uses the library pako released under the MIT license : +https://github.com/nodeca/pako/blob/master/LICENSE +*/ + +(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.JSZip = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o> 2; + enc2 = ((chr1 & 3) << 4) | (chr2 >> 4); + enc3 = remainingBytes > 1 ? (((chr2 & 15) << 2) | (chr3 >> 6)) : 64; + enc4 = remainingBytes > 2 ? (chr3 & 63) : 64; + + output.push(_keyStr.charAt(enc1) + _keyStr.charAt(enc2) + _keyStr.charAt(enc3) + _keyStr.charAt(enc4)); + + } + + return output.join(""); +}; + +// public method for decoding +exports.decode = function(input) { + var chr1, chr2, chr3; + var enc1, enc2, enc3, enc4; + var i = 0, resultIndex = 0; + + var dataUrlPrefix = "data:"; + + if (input.substr(0, dataUrlPrefix.length) === dataUrlPrefix) { + // This is a common error: people give a data url + // (data:image/png;base64,iVBOR...) with a {base64: true} and + // wonders why things don't work. + // We can detect that the string input looks like a data url but we + // *can't* be sure it is one: removing everything up to the comma would + // be too dangerous. + throw new Error("Invalid base64 input, it looks like a data url."); + } + + input = input.replace(/[^A-Za-z0-9\+\/\=]/g, ""); + + var totalLength = input.length * 3 / 4; + if(input.charAt(input.length - 1) === _keyStr.charAt(64)) { + totalLength--; + } + if(input.charAt(input.length - 2) === _keyStr.charAt(64)) { + totalLength--; + } + if (totalLength % 1 !== 0) { + // totalLength is not an integer, the length does not match a valid + // base64 content. That can happen if: + // - the input is not a base64 content + // - the input is *almost* a base64 content, with a extra chars at the + // beginning or at the end + // - the input uses a base64 variant (base64url for example) + throw new Error("Invalid base64 input, bad content length."); + } + var output; + if (support.uint8array) { + output = new Uint8Array(totalLength|0); + } else { + output = new Array(totalLength|0); + } + + while (i < input.length) { + + enc1 = _keyStr.indexOf(input.charAt(i++)); + enc2 = _keyStr.indexOf(input.charAt(i++)); + enc3 = _keyStr.indexOf(input.charAt(i++)); + enc4 = _keyStr.indexOf(input.charAt(i++)); + + chr1 = (enc1 << 2) | (enc2 >> 4); + chr2 = ((enc2 & 15) << 4) | (enc3 >> 2); + chr3 = ((enc3 & 3) << 6) | enc4; + + output[resultIndex++] = chr1; + + if (enc3 !== 64) { + output[resultIndex++] = chr2; + } + if (enc4 !== 64) { + output[resultIndex++] = chr3; + } + + } + + return output; +}; + +},{"./support":30,"./utils":32}],2:[function(require,module,exports){ +'use strict'; + +var external = require("./external"); +var DataWorker = require('./stream/DataWorker'); +var Crc32Probe = require('./stream/Crc32Probe'); +var DataLengthProbe = require('./stream/DataLengthProbe'); + +/** + * Represent a compressed object, with everything needed to decompress it. + * @constructor + * @param {number} compressedSize the size of the data compressed. + * @param {number} uncompressedSize the size of the data after decompression. + * @param {number} crc32 the crc32 of the decompressed file. + * @param {object} compression the type of compression, see lib/compressions.js. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the compressed data. + */ +function CompressedObject(compressedSize, uncompressedSize, crc32, compression, data) { + this.compressedSize = compressedSize; + this.uncompressedSize = uncompressedSize; + this.crc32 = crc32; + this.compression = compression; + this.compressedContent = data; +} + +CompressedObject.prototype = { + /** + * Create a worker to get the uncompressed content. + * @return {GenericWorker} the worker. + */ + getContentWorker: function () { + var worker = new DataWorker(external.Promise.resolve(this.compressedContent)) + .pipe(this.compression.uncompressWorker()) + .pipe(new DataLengthProbe("data_length")); + + var that = this; + worker.on("end", function () { + if (this.streamInfo['data_length'] !== that.uncompressedSize) { + throw new Error("Bug : uncompressed data size mismatch"); + } + }); + return worker; + }, + /** + * Create a worker to get the compressed content. + * @return {GenericWorker} the worker. + */ + getCompressedWorker: function () { + return new DataWorker(external.Promise.resolve(this.compressedContent)) + .withStreamInfo("compressedSize", this.compressedSize) + .withStreamInfo("uncompressedSize", this.uncompressedSize) + .withStreamInfo("crc32", this.crc32) + .withStreamInfo("compression", this.compression) + ; + } +}; + +/** + * Chain the given worker with other workers to compress the content with the + * given compression. + * @param {GenericWorker} uncompressedWorker the worker to pipe. + * @param {Object} compression the compression object. + * @param {Object} compressionOptions the options to use when compressing. + * @return {GenericWorker} the new worker compressing the content. + */ +CompressedObject.createWorkerFrom = function (uncompressedWorker, compression, compressionOptions) { + return uncompressedWorker + .pipe(new Crc32Probe()) + .pipe(new DataLengthProbe("uncompressedSize")) + .pipe(compression.compressWorker(compressionOptions)) + .pipe(new DataLengthProbe("compressedSize")) + .withStreamInfo("compression", compression); +}; + +module.exports = CompressedObject; + +},{"./external":6,"./stream/Crc32Probe":25,"./stream/DataLengthProbe":26,"./stream/DataWorker":27}],3:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require("./stream/GenericWorker"); + +exports.STORE = { + magic: "\x00\x00", + compressWorker : function (compressionOptions) { + return new GenericWorker("STORE compression"); + }, + uncompressWorker : function () { + return new GenericWorker("STORE decompression"); + } +}; +exports.DEFLATE = require('./flate'); + +},{"./flate":7,"./stream/GenericWorker":28}],4:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); + +/** + * The following functions come from pako, from pako/lib/zlib/crc32.js + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Use ordinary array, since untyped makes no boost here +function makeTable() { + var c, table = []; + + for(var n =0; n < 256; n++){ + c = n; + for(var k =0; k < 8; k++){ + c = ((c&1) ? (0xEDB88320 ^ (c >>> 1)) : (c >>> 1)); + } + table[n] = c; + } + + return table; +} + +// Create table on load. Just 255 signed longs. Not a problem. +var crcTable = makeTable(); + + +function crc32(crc, buf, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ buf[i]) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +// That's all for the pako functions. + +/** + * Compute the crc32 of a string. + * This is almost the same as the function crc32, but for strings. Using the + * same function for the two use cases leads to horrible performances. + * @param {Number} crc the starting value of the crc. + * @param {String} str the string to use. + * @param {Number} len the length of the string. + * @param {Number} pos the starting position for the crc32 computation. + * @return {Number} the computed crc32. + */ +function crc32str(crc, str, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ str.charCodeAt(i)) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +module.exports = function crc32wrapper(input, crc) { + if (typeof input === "undefined" || !input.length) { + return 0; + } + + var isArray = utils.getTypeOf(input) !== "string"; + + if(isArray) { + return crc32(crc|0, input, input.length, 0); + } else { + return crc32str(crc|0, input, input.length, 0); + } +}; + +},{"./utils":32}],5:[function(require,module,exports){ +'use strict'; +exports.base64 = false; +exports.binary = false; +exports.dir = false; +exports.createFolders = true; +exports.date = null; +exports.compression = null; +exports.compressionOptions = null; +exports.comment = null; +exports.unixPermissions = null; +exports.dosPermissions = null; + +},{}],6:[function(require,module,exports){ +/* global Promise */ +'use strict'; + +// load the global object first: +// - it should be better integrated in the system (unhandledRejection in node) +// - the environment may have a custom Promise implementation (see zone.js) +var ES6Promise = null; +if (typeof Promise !== "undefined") { + ES6Promise = Promise; +} else { + ES6Promise = require("lie"); +} + +/** + * Let the user use/change some implementations. + */ +module.exports = { + Promise: ES6Promise +}; + +},{"lie":37}],7:[function(require,module,exports){ +'use strict'; +var USE_TYPEDARRAY = (typeof Uint8Array !== 'undefined') && (typeof Uint16Array !== 'undefined') && (typeof Uint32Array !== 'undefined'); + +var pako = require("pako"); +var utils = require("./utils"); +var GenericWorker = require("./stream/GenericWorker"); + +var ARRAY_TYPE = USE_TYPEDARRAY ? "uint8array" : "array"; + +exports.magic = "\x08\x00"; + +/** + * Create a worker that uses pako to inflate/deflate. + * @constructor + * @param {String} action the name of the pako function to call : either "Deflate" or "Inflate". + * @param {Object} options the options to use when (de)compressing. + */ +function FlateWorker(action, options) { + GenericWorker.call(this, "FlateWorker/" + action); + + this._pako = null; + this._pakoAction = action; + this._pakoOptions = options; + // the `meta` object from the last chunk received + // this allow this worker to pass around metadata + this.meta = {}; +} + +utils.inherits(FlateWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +FlateWorker.prototype.processChunk = function (chunk) { + this.meta = chunk.meta; + if (this._pako === null) { + this._createPako(); + } + this._pako.push(utils.transformTo(ARRAY_TYPE, chunk.data), false); +}; + +/** + * @see GenericWorker.flush + */ +FlateWorker.prototype.flush = function () { + GenericWorker.prototype.flush.call(this); + if (this._pako === null) { + this._createPako(); + } + this._pako.push([], true); +}; +/** + * @see GenericWorker.cleanUp + */ +FlateWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this._pako = null; +}; + +/** + * Create the _pako object. + * TODO: lazy-loading this object isn't the best solution but it's the + * quickest. The best solution is to lazy-load the worker list. See also the + * issue #446. + */ +FlateWorker.prototype._createPako = function () { + this._pako = new pako[this._pakoAction]({ + raw: true, + level: this._pakoOptions.level || -1 // default compression + }); + var self = this; + this._pako.onData = function(data) { + self.push({ + data : data, + meta : self.meta + }); + }; +}; + +exports.compressWorker = function (compressionOptions) { + return new FlateWorker("Deflate", compressionOptions); +}; +exports.uncompressWorker = function () { + return new FlateWorker("Inflate", {}); +}; + +},{"./stream/GenericWorker":28,"./utils":32,"pako":38}],8:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); +var utf8 = require('../utf8'); +var crc32 = require('../crc32'); +var signature = require('../signature'); + +/** + * Transform an integer into a string in hexadecimal. + * @private + * @param {number} dec the number to convert. + * @param {number} bytes the number of bytes to generate. + * @returns {string} the result. + */ +var decToHex = function(dec, bytes) { + var hex = "", i; + for (i = 0; i < bytes; i++) { + hex += String.fromCharCode(dec & 0xff); + dec = dec >>> 8; + } + return hex; +}; + +/** + * Generate the UNIX part of the external file attributes. + * @param {Object} unixPermissions the unix permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * adapted from http://unix.stackexchange.com/questions/14705/the-zip-formats-external-file-attribute : + * + * TTTTsstrwxrwxrwx0000000000ADVSHR + * ^^^^____________________________ file type, see zipinfo.c (UNX_*) + * ^^^_________________________ setuid, setgid, sticky + * ^^^^^^^^^________________ permissions + * ^^^^^^^^^^______ not used ? + * ^^^^^^ DOS attribute bits : Archive, Directory, Volume label, System file, Hidden, Read only + */ +var generateUnixExternalFileAttr = function (unixPermissions, isDir) { + + var result = unixPermissions; + if (!unixPermissions) { + // I can't use octal values in strict mode, hence the hexa. + // 040775 => 0x41fd + // 0100664 => 0x81b4 + result = isDir ? 0x41fd : 0x81b4; + } + return (result & 0xFFFF) << 16; +}; + +/** + * Generate the DOS part of the external file attributes. + * @param {Object} dosPermissions the dos permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * Bit 0 Read-Only + * Bit 1 Hidden + * Bit 2 System + * Bit 3 Volume Label + * Bit 4 Directory + * Bit 5 Archive + */ +var generateDosExternalFileAttr = function (dosPermissions, isDir) { + + // the dir flag is already set for compatibility + return (dosPermissions || 0) & 0x3F; +}; + +/** + * Generate the various parts used in the construction of the final zip file. + * @param {Object} streamInfo the hash with information about the compressed file. + * @param {Boolean} streamedContent is the content streamed ? + * @param {Boolean} streamingEnded is the stream finished ? + * @param {number} offset the current offset from the start of the zip file. + * @param {String} platform let's pretend we are this platform (change platform dependents fields) + * @param {Function} encodeFileName the function to encode the file name / comment. + * @return {Object} the zip parts. + */ +var generateZipParts = function(streamInfo, streamedContent, streamingEnded, offset, platform, encodeFileName) { + var file = streamInfo['file'], + compression = streamInfo['compression'], + useCustomEncoding = encodeFileName !== utf8.utf8encode, + encodedFileName = utils.transformTo("string", encodeFileName(file.name)), + utfEncodedFileName = utils.transformTo("string", utf8.utf8encode(file.name)), + comment = file.comment, + encodedComment = utils.transformTo("string", encodeFileName(comment)), + utfEncodedComment = utils.transformTo("string", utf8.utf8encode(comment)), + useUTF8ForFileName = utfEncodedFileName.length !== file.name.length, + useUTF8ForComment = utfEncodedComment.length !== comment.length, + dosTime, + dosDate, + extraFields = "", + unicodePathExtraField = "", + unicodeCommentExtraField = "", + dir = file.dir, + date = file.date; + + + var dataInfo = { + crc32 : 0, + compressedSize : 0, + uncompressedSize : 0 + }; + + // if the content is streamed, the sizes/crc32 are only available AFTER + // the end of the stream. + if (!streamedContent || streamingEnded) { + dataInfo.crc32 = streamInfo['crc32']; + dataInfo.compressedSize = streamInfo['compressedSize']; + dataInfo.uncompressedSize = streamInfo['uncompressedSize']; + } + + var bitflag = 0; + if (streamedContent) { + // Bit 3: the sizes/crc32 are set to zero in the local header. + // The correct values are put in the data descriptor immediately + // following the compressed data. + bitflag |= 0x0008; + } + if (!useCustomEncoding && (useUTF8ForFileName || useUTF8ForComment)) { + // Bit 11: Language encoding flag (EFS). + bitflag |= 0x0800; + } + + + var extFileAttr = 0; + var versionMadeBy = 0; + if (dir) { + // dos or unix, we set the dos dir flag + extFileAttr |= 0x00010; + } + if(platform === "UNIX") { + versionMadeBy = 0x031E; // UNIX, version 3.0 + extFileAttr |= generateUnixExternalFileAttr(file.unixPermissions, dir); + } else { // DOS or other, fallback to DOS + versionMadeBy = 0x0014; // DOS, version 2.0 + extFileAttr |= generateDosExternalFileAttr(file.dosPermissions, dir); + } + + // date + // @see http://www.delorie.com/djgpp/doc/rbinter/it/52/13.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/65/16.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/66/16.html + + dosTime = date.getUTCHours(); + dosTime = dosTime << 6; + dosTime = dosTime | date.getUTCMinutes(); + dosTime = dosTime << 5; + dosTime = dosTime | date.getUTCSeconds() / 2; + + dosDate = date.getUTCFullYear() - 1980; + dosDate = dosDate << 4; + dosDate = dosDate | (date.getUTCMonth() + 1); + dosDate = dosDate << 5; + dosDate = dosDate | date.getUTCDate(); + + if (useUTF8ForFileName) { + // set the unicode path extra field. unzip needs at least one extra + // field to correctly handle unicode path, so using the path is as good + // as any other information. This could improve the situation with + // other archive managers too. + // This field is usually used without the utf8 flag, with a non + // unicode path in the header (winrar, winzip). This helps (a bit) + // with the messy Windows' default compressed folders feature but + // breaks on p7zip which doesn't seek the unicode path extra field. + // So for now, UTF-8 everywhere ! + unicodePathExtraField = + // Version + decToHex(1, 1) + + // NameCRC32 + decToHex(crc32(encodedFileName), 4) + + // UnicodeName + utfEncodedFileName; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x70" + + // size + decToHex(unicodePathExtraField.length, 2) + + // content + unicodePathExtraField; + } + + if(useUTF8ForComment) { + + unicodeCommentExtraField = + // Version + decToHex(1, 1) + + // CommentCRC32 + decToHex(crc32(encodedComment), 4) + + // UnicodeName + utfEncodedComment; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x63" + + // size + decToHex(unicodeCommentExtraField.length, 2) + + // content + unicodeCommentExtraField; + } + + var header = ""; + + // version needed to extract + header += "\x0A\x00"; + // general purpose bit flag + header += decToHex(bitflag, 2); + // compression method + header += compression.magic; + // last mod file time + header += decToHex(dosTime, 2); + // last mod file date + header += decToHex(dosDate, 2); + // crc-32 + header += decToHex(dataInfo.crc32, 4); + // compressed size + header += decToHex(dataInfo.compressedSize, 4); + // uncompressed size + header += decToHex(dataInfo.uncompressedSize, 4); + // file name length + header += decToHex(encodedFileName.length, 2); + // extra field length + header += decToHex(extraFields.length, 2); + + + var fileRecord = signature.LOCAL_FILE_HEADER + header + encodedFileName + extraFields; + + var dirRecord = signature.CENTRAL_FILE_HEADER + + // version made by (00: DOS) + decToHex(versionMadeBy, 2) + + // file header (common to file and central directory) + header + + // file comment length + decToHex(encodedComment.length, 2) + + // disk number start + "\x00\x00" + + // internal file attributes TODO + "\x00\x00" + + // external file attributes + decToHex(extFileAttr, 4) + + // relative offset of local header + decToHex(offset, 4) + + // file name + encodedFileName + + // extra field + extraFields + + // file comment + encodedComment; + + return { + fileRecord: fileRecord, + dirRecord: dirRecord + }; +}; + +/** + * Generate the EOCD record. + * @param {Number} entriesCount the number of entries in the zip file. + * @param {Number} centralDirLength the length (in bytes) of the central dir. + * @param {Number} localDirLength the length (in bytes) of the local dir. + * @param {String} comment the zip file comment as a binary string. + * @param {Function} encodeFileName the function to encode the comment. + * @return {String} the EOCD record. + */ +var generateCentralDirectoryEnd = function (entriesCount, centralDirLength, localDirLength, comment, encodeFileName) { + var dirEnd = ""; + var encodedComment = utils.transformTo("string", encodeFileName(comment)); + + // end of central dir signature + dirEnd = signature.CENTRAL_DIRECTORY_END + + // number of this disk + "\x00\x00" + + // number of the disk with the start of the central directory + "\x00\x00" + + // total number of entries in the central directory on this disk + decToHex(entriesCount, 2) + + // total number of entries in the central directory + decToHex(entriesCount, 2) + + // size of the central directory 4 bytes + decToHex(centralDirLength, 4) + + // offset of start of central directory with respect to the starting disk number + decToHex(localDirLength, 4) + + // .ZIP file comment length + decToHex(encodedComment.length, 2) + + // .ZIP file comment + encodedComment; + + return dirEnd; +}; + +/** + * Generate data descriptors for a file entry. + * @param {Object} streamInfo the hash generated by a worker, containing information + * on the file entry. + * @return {String} the data descriptors. + */ +var generateDataDescriptors = function (streamInfo) { + var descriptor = ""; + descriptor = signature.DATA_DESCRIPTOR + + // crc-32 4 bytes + decToHex(streamInfo['crc32'], 4) + + // compressed size 4 bytes + decToHex(streamInfo['compressedSize'], 4) + + // uncompressed size 4 bytes + decToHex(streamInfo['uncompressedSize'], 4); + + return descriptor; +}; + + +/** + * A worker to concatenate other workers to create a zip file. + * @param {Boolean} streamFiles `true` to stream the content of the files, + * `false` to accumulate it. + * @param {String} comment the comment to use. + * @param {String} platform the platform to use, "UNIX" or "DOS". + * @param {Function} encodeFileName the function to encode file names and comments. + */ +function ZipFileWorker(streamFiles, comment, platform, encodeFileName) { + GenericWorker.call(this, "ZipFileWorker"); + // The number of bytes written so far. This doesn't count accumulated chunks. + this.bytesWritten = 0; + // The comment of the zip file + this.zipComment = comment; + // The platform "generating" the zip file. + this.zipPlatform = platform; + // the function to encode file names and comments. + this.encodeFileName = encodeFileName; + // Should we stream the content of the files ? + this.streamFiles = streamFiles; + // If `streamFiles` is false, we will need to accumulate the content of the + // files to calculate sizes / crc32 (and write them *before* the content). + // This boolean indicates if we are accumulating chunks (it will change a lot + // during the lifetime of this worker). + this.accumulate = false; + // The buffer receiving chunks when accumulating content. + this.contentBuffer = []; + // The list of generated directory records. + this.dirRecords = []; + // The offset (in bytes) from the beginning of the zip file for the current source. + this.currentSourceOffset = 0; + // The total number of entries in this zip file. + this.entriesCount = 0; + // the name of the file currently being added, null when handling the end of the zip file. + // Used for the emitted metadata. + this.currentFile = null; + + + + this._sources = []; +} +utils.inherits(ZipFileWorker, GenericWorker); + +/** + * @see GenericWorker.push + */ +ZipFileWorker.prototype.push = function (chunk) { + + var currentFilePercent = chunk.meta.percent || 0; + var entriesCount = this.entriesCount; + var remainingFiles = this._sources.length; + + if(this.accumulate) { + this.contentBuffer.push(chunk); + } else { + this.bytesWritten += chunk.data.length; + + GenericWorker.prototype.push.call(this, { + data : chunk.data, + meta : { + currentFile : this.currentFile, + percent : entriesCount ? (currentFilePercent + 100 * (entriesCount - remainingFiles - 1)) / entriesCount : 100 + } + }); + } +}; + +/** + * The worker started a new source (an other worker). + * @param {Object} streamInfo the streamInfo object from the new source. + */ +ZipFileWorker.prototype.openedSource = function (streamInfo) { + this.currentSourceOffset = this.bytesWritten; + this.currentFile = streamInfo['file'].name; + + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + + // don't stream folders (because they don't have any content) + if(streamedContent) { + var record = generateZipParts(streamInfo, streamedContent, false, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + } else { + // we need to wait for the whole file before pushing anything + this.accumulate = true; + } +}; + +/** + * The worker finished a source (an other worker). + * @param {Object} streamInfo the streamInfo object from the finished source. + */ +ZipFileWorker.prototype.closedSource = function (streamInfo) { + this.accumulate = false; + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + var record = generateZipParts(streamInfo, streamedContent, true, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + + this.dirRecords.push(record.dirRecord); + if(streamedContent) { + // after the streamed file, we put data descriptors + this.push({ + data : generateDataDescriptors(streamInfo), + meta : {percent:100} + }); + } else { + // the content wasn't streamed, we need to push everything now + // first the file record, then the content + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + while(this.contentBuffer.length) { + this.push(this.contentBuffer.shift()); + } + } + this.currentFile = null; +}; + +/** + * @see GenericWorker.flush + */ +ZipFileWorker.prototype.flush = function () { + + var localDirLength = this.bytesWritten; + for(var i = 0; i < this.dirRecords.length; i++) { + this.push({ + data : this.dirRecords[i], + meta : {percent:100} + }); + } + var centralDirLength = this.bytesWritten - localDirLength; + + var dirEnd = generateCentralDirectoryEnd(this.dirRecords.length, centralDirLength, localDirLength, this.zipComment, this.encodeFileName); + + this.push({ + data : dirEnd, + meta : {percent:100} + }); +}; + +/** + * Prepare the next source to be read. + */ +ZipFileWorker.prototype.prepareNextSource = function () { + this.previous = this._sources.shift(); + this.openedSource(this.previous.streamInfo); + if (this.isPaused) { + this.previous.pause(); + } else { + this.previous.resume(); + } +}; + +/** + * @see GenericWorker.registerPrevious + */ +ZipFileWorker.prototype.registerPrevious = function (previous) { + this._sources.push(previous); + var self = this; + + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.closedSource(self.previous.streamInfo); + if(self._sources.length) { + self.prepareNextSource(); + } else { + self.end(); + } + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; +}; + +/** + * @see GenericWorker.resume + */ +ZipFileWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this.previous && this._sources.length) { + this.prepareNextSource(); + return true; + } + if (!this.previous && !this._sources.length && !this.generatedError) { + this.end(); + return true; + } +}; + +/** + * @see GenericWorker.error + */ +ZipFileWorker.prototype.error = function (e) { + var sources = this._sources; + if(!GenericWorker.prototype.error.call(this, e)) { + return false; + } + for(var i = 0; i < sources.length; i++) { + try { + sources[i].error(e); + } catch(e) { + // the `error` exploded, nothing to do + } + } + return true; +}; + +/** + * @see GenericWorker.lock + */ +ZipFileWorker.prototype.lock = function () { + GenericWorker.prototype.lock.call(this); + var sources = this._sources; + for(var i = 0; i < sources.length; i++) { + sources[i].lock(); + } +}; + +module.exports = ZipFileWorker; + +},{"../crc32":4,"../signature":23,"../stream/GenericWorker":28,"../utf8":31,"../utils":32}],9:[function(require,module,exports){ +'use strict'; + +var compressions = require('../compressions'); +var ZipFileWorker = require('./ZipFileWorker'); + +/** + * Find the compression to use. + * @param {String} fileCompression the compression defined at the file level, if any. + * @param {String} zipCompression the compression defined at the load() level. + * @return {Object} the compression object to use. + */ +var getCompression = function (fileCompression, zipCompression) { + + var compressionName = fileCompression || zipCompression; + var compression = compressions[compressionName]; + if (!compression) { + throw new Error(compressionName + " is not a valid compression method !"); + } + return compression; +}; + +/** + * Create a worker to generate a zip file. + * @param {JSZip} zip the JSZip instance at the right root level. + * @param {Object} options to generate the zip file. + * @param {String} comment the comment to use. + */ +exports.generateWorker = function (zip, options, comment) { + + var zipFileWorker = new ZipFileWorker(options.streamFiles, comment, options.platform, options.encodeFileName); + var entriesCount = 0; + try { + + zip.forEach(function (relativePath, file) { + entriesCount++; + var compression = getCompression(file.options.compression, options.compression); + var compressionOptions = file.options.compressionOptions || options.compressionOptions || {}; + var dir = file.dir, date = file.date; + + file._compressWorker(compression, compressionOptions) + .withStreamInfo("file", { + name : relativePath, + dir : dir, + date : date, + comment : file.comment || "", + unixPermissions : file.unixPermissions, + dosPermissions : file.dosPermissions + }) + .pipe(zipFileWorker); + }); + zipFileWorker.entriesCount = entriesCount; + } catch (e) { + zipFileWorker.error(e); + } + + return zipFileWorker; +}; + +},{"../compressions":3,"./ZipFileWorker":8}],10:[function(require,module,exports){ +'use strict'; + +/** + * Representation a of zip file in js + * @constructor + */ +function JSZip() { + // if this constructor is used without `new`, it adds `new` before itself: + if(!(this instanceof JSZip)) { + return new JSZip(); + } + + if(arguments.length) { + throw new Error("The constructor with parameters has been removed in JSZip 3.0, please check the upgrade guide."); + } + + // object containing the files : + // { + // "folder/" : {...}, + // "folder/data.txt" : {...} + // } + // NOTE: we use a null prototype because we do not + // want filenames like "toString" coming from a zip file + // to overwrite methods and attributes in a normal Object. + this.files = Object.create(null); + + this.comment = null; + + // Where we are in the hierarchy + this.root = ""; + this.clone = function() { + var newObj = new JSZip(); + for (var i in this) { + if (typeof this[i] !== "function") { + newObj[i] = this[i]; + } + } + return newObj; + }; +} +JSZip.prototype = require('./object'); +JSZip.prototype.loadAsync = require('./load'); +JSZip.support = require('./support'); +JSZip.defaults = require('./defaults'); + +// TODO find a better way to handle this version, +// a require('package.json').version doesn't work with webpack, see #327 +JSZip.version = "3.7.1"; + +JSZip.loadAsync = function (content, options) { + return new JSZip().loadAsync(content, options); +}; + +JSZip.external = require("./external"); +module.exports = JSZip; + +},{"./defaults":5,"./external":6,"./load":11,"./object":15,"./support":30}],11:[function(require,module,exports){ +'use strict'; +var utils = require('./utils'); +var external = require("./external"); +var utf8 = require('./utf8'); +var ZipEntries = require('./zipEntries'); +var Crc32Probe = require('./stream/Crc32Probe'); +var nodejsUtils = require("./nodejsUtils"); + +/** + * Check the CRC32 of an entry. + * @param {ZipEntry} zipEntry the zip entry to check. + * @return {Promise} the result. + */ +function checkEntryCRC32(zipEntry) { + return new external.Promise(function (resolve, reject) { + var worker = zipEntry.decompressed.getContentWorker().pipe(new Crc32Probe()); + worker.on("error", function (e) { + reject(e); + }) + .on("end", function () { + if (worker.streamInfo.crc32 !== zipEntry.decompressed.crc32) { + reject(new Error("Corrupted zip : CRC32 mismatch")); + } else { + resolve(); + } + }) + .resume(); + }); +} + +module.exports = function (data, options) { + var zip = this; + options = utils.extend(options || {}, { + base64: false, + checkCRC32: false, + optimizedBinaryString: false, + createFolders: false, + decodeFileName: utf8.utf8decode + }); + + if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + return external.Promise.reject(new Error("JSZip can't accept a stream when loading a zip file.")); + } + + return utils.prepareContent("the loaded zip file", data, true, options.optimizedBinaryString, options.base64) + .then(function (data) { + var zipEntries = new ZipEntries(options); + zipEntries.load(data); + return zipEntries; + }).then(function checkCRC32(zipEntries) { + var promises = [external.Promise.resolve(zipEntries)]; + var files = zipEntries.files; + if (options.checkCRC32) { + for (var i = 0; i < files.length; i++) { + promises.push(checkEntryCRC32(files[i])); + } + } + return external.Promise.all(promises); + }).then(function addFiles(results) { + var zipEntries = results.shift(); + var files = zipEntries.files; + for (var i = 0; i < files.length; i++) { + var input = files[i]; + zip.file(input.fileNameStr, input.decompressed, { + binary: true, + optimizedBinaryString: true, + date: input.date, + dir: input.dir, + comment: input.fileCommentStr.length ? input.fileCommentStr : null, + unixPermissions: input.unixPermissions, + dosPermissions: input.dosPermissions, + createFolders: options.createFolders + }); + } + if (zipEntries.zipComment.length) { + zip.comment = zipEntries.zipComment; + } + + return zip; + }); +}; + +},{"./external":6,"./nodejsUtils":14,"./stream/Crc32Probe":25,"./utf8":31,"./utils":32,"./zipEntries":33}],12:[function(require,module,exports){ +"use strict"; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); + +/** + * A worker that use a nodejs stream as source. + * @constructor + * @param {String} filename the name of the file entry for this stream. + * @param {Readable} stream the nodejs stream. + */ +function NodejsStreamInputAdapter(filename, stream) { + GenericWorker.call(this, "Nodejs stream input adapter for " + filename); + this._upstreamEnded = false; + this._bindStream(stream); +} + +utils.inherits(NodejsStreamInputAdapter, GenericWorker); + +/** + * Prepare the stream and bind the callbacks on it. + * Do this ASAP on node 0.10 ! A lazy binding doesn't always work. + * @param {Stream} stream the nodejs stream to use. + */ +NodejsStreamInputAdapter.prototype._bindStream = function (stream) { + var self = this; + this._stream = stream; + stream.pause(); + stream + .on("data", function (chunk) { + self.push({ + data: chunk, + meta : { + percent : 0 + } + }); + }) + .on("error", function (e) { + if(self.isPaused) { + this.generatedError = e; + } else { + self.error(e); + } + }) + .on("end", function () { + if(self.isPaused) { + self._upstreamEnded = true; + } else { + self.end(); + } + }); +}; +NodejsStreamInputAdapter.prototype.pause = function () { + if(!GenericWorker.prototype.pause.call(this)) { + return false; + } + this._stream.pause(); + return true; +}; +NodejsStreamInputAdapter.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if(this._upstreamEnded) { + this.end(); + } else { + this._stream.resume(); + } + + return true; +}; + +module.exports = NodejsStreamInputAdapter; + +},{"../stream/GenericWorker":28,"../utils":32}],13:[function(require,module,exports){ +'use strict'; + +var Readable = require('readable-stream').Readable; + +var utils = require('../utils'); +utils.inherits(NodejsStreamOutputAdapter, Readable); + +/** +* A nodejs stream using a worker as source. +* @see the SourceWrapper in http://nodejs.org/api/stream.html +* @constructor +* @param {StreamHelper} helper the helper wrapping the worker +* @param {Object} options the nodejs stream options +* @param {Function} updateCb the update callback. +*/ +function NodejsStreamOutputAdapter(helper, options, updateCb) { + Readable.call(this, options); + this._helper = helper; + + var self = this; + helper.on("data", function (data, meta) { + if (!self.push(data)) { + self._helper.pause(); + } + if(updateCb) { + updateCb(meta); + } + }) + .on("error", function(e) { + self.emit('error', e); + }) + .on("end", function () { + self.push(null); + }); +} + + +NodejsStreamOutputAdapter.prototype._read = function() { + this._helper.resume(); +}; + +module.exports = NodejsStreamOutputAdapter; + +},{"../utils":32,"readable-stream":16}],14:[function(require,module,exports){ +'use strict'; + +module.exports = { + /** + * True if this is running in Nodejs, will be undefined in a browser. + * In a browser, browserify won't include this file and the whole module + * will be resolved an empty object. + */ + isNode : typeof Buffer !== "undefined", + /** + * Create a new nodejs Buffer from an existing content. + * @param {Object} data the data to pass to the constructor. + * @param {String} encoding the encoding to use. + * @return {Buffer} a new Buffer. + */ + newBufferFrom: function(data, encoding) { + if (Buffer.from && Buffer.from !== Uint8Array.from) { + return Buffer.from(data, encoding); + } else { + if (typeof data === "number") { + // Safeguard for old Node.js versions. On newer versions, + // Buffer.from(number) / Buffer(number, encoding) already throw. + throw new Error("The \"data\" argument must not be a number"); + } + return new Buffer(data, encoding); + } + }, + /** + * Create a new nodejs Buffer with the specified size. + * @param {Integer} size the size of the buffer. + * @return {Buffer} a new Buffer. + */ + allocBuffer: function (size) { + if (Buffer.alloc) { + return Buffer.alloc(size); + } else { + var buf = new Buffer(size); + buf.fill(0); + return buf; + } + }, + /** + * Find out if an object is a Buffer. + * @param {Object} b the object to test. + * @return {Boolean} true if the object is a Buffer, false otherwise. + */ + isBuffer : function(b){ + return Buffer.isBuffer(b); + }, + + isStream : function (obj) { + return obj && + typeof obj.on === "function" && + typeof obj.pause === "function" && + typeof obj.resume === "function"; + } +}; + +},{}],15:[function(require,module,exports){ +'use strict'; +var utf8 = require('./utf8'); +var utils = require('./utils'); +var GenericWorker = require('./stream/GenericWorker'); +var StreamHelper = require('./stream/StreamHelper'); +var defaults = require('./defaults'); +var CompressedObject = require('./compressedObject'); +var ZipObject = require('./zipObject'); +var generate = require("./generate"); +var nodejsUtils = require("./nodejsUtils"); +var NodejsStreamInputAdapter = require("./nodejs/NodejsStreamInputAdapter"); + + +/** + * Add a file in the current folder. + * @private + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data of the file + * @param {Object} originalOptions the options of the file + * @return {Object} the new file. + */ +var fileAdd = function(name, data, originalOptions) { + // be sure sub folders exist + var dataType = utils.getTypeOf(data), + parent; + + + /* + * Correct options. + */ + + var o = utils.extend(originalOptions || {}, defaults); + o.date = o.date || new Date(); + if (o.compression !== null) { + o.compression = o.compression.toUpperCase(); + } + + if (typeof o.unixPermissions === "string") { + o.unixPermissions = parseInt(o.unixPermissions, 8); + } + + // UNX_IFDIR 0040000 see zipinfo.c + if (o.unixPermissions && (o.unixPermissions & 0x4000)) { + o.dir = true; + } + // Bit 4 Directory + if (o.dosPermissions && (o.dosPermissions & 0x0010)) { + o.dir = true; + } + + if (o.dir) { + name = forceTrailingSlash(name); + } + if (o.createFolders && (parent = parentFolder(name))) { + folderAdd.call(this, parent, true); + } + + var isUnicodeString = dataType === "string" && o.binary === false && o.base64 === false; + if (!originalOptions || typeof originalOptions.binary === "undefined") { + o.binary = !isUnicodeString; + } + + + var isCompressedEmpty = (data instanceof CompressedObject) && data.uncompressedSize === 0; + + if (isCompressedEmpty || o.dir || !data || data.length === 0) { + o.base64 = false; + o.binary = true; + data = ""; + o.compression = "STORE"; + dataType = "string"; + } + + /* + * Convert content to fit. + */ + + var zipObjectContent = null; + if (data instanceof CompressedObject || data instanceof GenericWorker) { + zipObjectContent = data; + } else if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + zipObjectContent = new NodejsStreamInputAdapter(name, data); + } else { + zipObjectContent = utils.prepareContent(name, data, o.binary, o.optimizedBinaryString, o.base64); + } + + var object = new ZipObject(name, zipObjectContent, o); + this.files[name] = object; + /* + TODO: we can't throw an exception because we have async promises + (we can have a promise of a Date() for example) but returning a + promise is useless because file(name, data) returns the JSZip + object for chaining. Should we break that to allow the user + to catch the error ? + + return external.Promise.resolve(zipObjectContent) + .then(function () { + return object; + }); + */ +}; + +/** + * Find the parent folder of the path. + * @private + * @param {string} path the path to use + * @return {string} the parent folder, or "" + */ +var parentFolder = function (path) { + if (path.slice(-1) === '/') { + path = path.substring(0, path.length - 1); + } + var lastSlash = path.lastIndexOf('/'); + return (lastSlash > 0) ? path.substring(0, lastSlash) : ""; +}; + +/** + * Returns the path with a slash at the end. + * @private + * @param {String} path the path to check. + * @return {String} the path with a trailing slash. + */ +var forceTrailingSlash = function(path) { + // Check the name ends with a / + if (path.slice(-1) !== "/") { + path += "/"; // IE doesn't like substr(-1) + } + return path; +}; + +/** + * Add a (sub) folder in the current folder. + * @private + * @param {string} name the folder's name + * @param {boolean=} [createFolders] If true, automatically create sub + * folders. Defaults to false. + * @return {Object} the new folder. + */ +var folderAdd = function(name, createFolders) { + createFolders = (typeof createFolders !== 'undefined') ? createFolders : defaults.createFolders; + + name = forceTrailingSlash(name); + + // Does this folder already exist? + if (!this.files[name]) { + fileAdd.call(this, name, null, { + dir: true, + createFolders: createFolders + }); + } + return this.files[name]; +}; + +/** +* Cross-window, cross-Node-context regular expression detection +* @param {Object} object Anything +* @return {Boolean} true if the object is a regular expression, +* false otherwise +*/ +function isRegExp(object) { + return Object.prototype.toString.call(object) === "[object RegExp]"; +} + +// return the actual prototype of JSZip +var out = { + /** + * @see loadAsync + */ + load: function() { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + + /** + * Call a callback function for each entry at this folder level. + * @param {Function} cb the callback function: + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + */ + forEach: function(cb) { + var filename, relativePath, file; + /* jshint ignore:start */ + // ignore warning about unwanted properties because this.files is a null prototype object + for (filename in this.files) { + file = this.files[filename]; + relativePath = filename.slice(this.root.length, filename.length); + if (relativePath && filename.slice(0, this.root.length) === this.root) { // the file is in the current root + cb(relativePath, file); // TODO reverse the parameters ? need to be clean AND consistent with the filter search fn... + } + } + /* jshint ignore:end */ + }, + + /** + * Filter nested files/folders with the specified function. + * @param {Function} search the predicate to use : + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + * @return {Array} An array of matching elements. + */ + filter: function(search) { + var result = []; + this.forEach(function (relativePath, entry) { + if (search(relativePath, entry)) { // the file matches the function + result.push(entry); + } + + }); + return result; + }, + + /** + * Add a file to the zip file, or search a file. + * @param {string|RegExp} name The name of the file to add (if data is defined), + * the name of the file to find (if no data) or a regex to match files. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data The file data, either raw or base64 encoded + * @param {Object} o File options + * @return {JSZip|Object|Array} this JSZip object (when adding a file), + * a file (when searching by string) or an array of files (when searching by regex). + */ + file: function(name, data, o) { + if (arguments.length === 1) { + if (isRegExp(name)) { + var regexp = name; + return this.filter(function(relativePath, file) { + return !file.dir && regexp.test(relativePath); + }); + } + else { // text + var obj = this.files[this.root + name]; + if (obj && !obj.dir) { + return obj; + } else { + return null; + } + } + } + else { // more than one argument : we have data ! + name = this.root + name; + fileAdd.call(this, name, data, o); + } + return this; + }, + + /** + * Add a directory to the zip file, or search. + * @param {String|RegExp} arg The name of the directory to add, or a regex to search folders. + * @return {JSZip} an object with the new directory as the root, or an array containing matching folders. + */ + folder: function(arg) { + if (!arg) { + return this; + } + + if (isRegExp(arg)) { + return this.filter(function(relativePath, file) { + return file.dir && arg.test(relativePath); + }); + } + + // else, name is a new folder + var name = this.root + arg; + var newFolder = folderAdd.call(this, name); + + // Allow chaining by returning a new object with this folder as the root + var ret = this.clone(); + ret.root = newFolder.name; + return ret; + }, + + /** + * Delete a file, or a directory and all sub-files, from the zip + * @param {string} name the name of the file to delete + * @return {JSZip} this JSZip object + */ + remove: function(name) { + name = this.root + name; + var file = this.files[name]; + if (!file) { + // Look for any folders + if (name.slice(-1) !== "/") { + name += "/"; + } + file = this.files[name]; + } + + if (file && !file.dir) { + // file + delete this.files[name]; + } else { + // maybe a folder, delete recursively + var kids = this.filter(function(relativePath, file) { + return file.name.slice(0, name.length) === name; + }); + for (var i = 0; i < kids.length; i++) { + delete this.files[kids[i].name]; + } + } + + return this; + }, + + /** + * Generate the complete zip file + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the zip file + */ + generate: function(options) { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + /** + * Generate the complete zip file as an internal stream. + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {StreamHelper} the streamed zip file. + */ + generateInternalStream: function(options) { + var worker, opts = {}; + try { + opts = utils.extend(options || {}, { + streamFiles: false, + compression: "STORE", + compressionOptions : null, + type: "", + platform: "DOS", + comment: null, + mimeType: 'application/zip', + encodeFileName: utf8.utf8encode + }); + + opts.type = opts.type.toLowerCase(); + opts.compression = opts.compression.toUpperCase(); + + // "binarystring" is preferred but the internals use "string". + if(opts.type === "binarystring") { + opts.type = "string"; + } + + if (!opts.type) { + throw new Error("No output type specified."); + } + + utils.checkSupport(opts.type); + + // accept nodejs `process.platform` + if( + opts.platform === 'darwin' || + opts.platform === 'freebsd' || + opts.platform === 'linux' || + opts.platform === 'sunos' + ) { + opts.platform = "UNIX"; + } + if (opts.platform === 'win32') { + opts.platform = "DOS"; + } + + var comment = opts.comment || this.comment || ""; + worker = generate.generateWorker(this, opts, comment); + } catch (e) { + worker = new GenericWorker("error"); + worker.error(e); + } + return new StreamHelper(worker, opts.type || "string", opts.mimeType); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateAsync: function(options, onUpdate) { + return this.generateInternalStream(options).accumulate(onUpdate); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateNodeStream: function(options, onUpdate) { + options = options || {}; + if (!options.type) { + options.type = "nodebuffer"; + } + return this.generateInternalStream(options).toNodejsStream(onUpdate); + } +}; +module.exports = out; + +},{"./compressedObject":2,"./defaults":5,"./generate":9,"./nodejs/NodejsStreamInputAdapter":12,"./nodejsUtils":14,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31,"./utils":32,"./zipObject":35}],16:[function(require,module,exports){ +/* + * This file is used by module bundlers (browserify/webpack/etc) when + * including a stream implementation. We use "readable-stream" to get a + * consistent behavior between nodejs versions but bundlers often have a shim + * for "stream". Using this shim greatly improve the compatibility and greatly + * reduce the final size of the bundle (only one stream implementation, not + * two). + */ +module.exports = require("stream"); + +},{"stream":undefined}],17:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function ArrayReader(data) { + DataReader.call(this, data); + for(var i = 0; i < this.data.length; i++) { + data[i] = data[i] & 0xFF; + } +} +utils.inherits(ArrayReader, DataReader); +/** + * @see DataReader.byteAt + */ +ArrayReader.prototype.byteAt = function(i) { + return this.data[this.zero + i]; +}; +/** + * @see DataReader.lastIndexOfSignature + */ +ArrayReader.prototype.lastIndexOfSignature = function(sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3); + for (var i = this.length - 4; i >= 0; --i) { + if (this.data[i] === sig0 && this.data[i + 1] === sig1 && this.data[i + 2] === sig2 && this.data[i + 3] === sig3) { + return i - this.zero; + } + } + + return -1; +}; +/** + * @see DataReader.readAndCheckSignature + */ +ArrayReader.prototype.readAndCheckSignature = function (sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3), + data = this.readData(4); + return sig0 === data[0] && sig1 === data[1] && sig2 === data[2] && sig3 === data[3]; +}; +/** + * @see DataReader.readData + */ +ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + return []; + } + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = ArrayReader; + +},{"../utils":32,"./DataReader":18}],18:[function(require,module,exports){ +'use strict'; +var utils = require('../utils'); + +function DataReader(data) { + this.data = data; // type : see implementation + this.length = data.length; + this.index = 0; + this.zero = 0; +} +DataReader.prototype = { + /** + * Check that the offset will not go too far. + * @param {string} offset the additional offset to check. + * @throws {Error} an Error if the offset is out of bounds. + */ + checkOffset: function(offset) { + this.checkIndex(this.index + offset); + }, + /** + * Check that the specified index will not be too far. + * @param {string} newIndex the index to check. + * @throws {Error} an Error if the index is out of bounds. + */ + checkIndex: function(newIndex) { + if (this.length < this.zero + newIndex || newIndex < 0) { + throw new Error("End of data reached (data length = " + this.length + ", asked index = " + (newIndex) + "). Corrupted zip ?"); + } + }, + /** + * Change the index. + * @param {number} newIndex The new index. + * @throws {Error} if the new index is out of the data. + */ + setIndex: function(newIndex) { + this.checkIndex(newIndex); + this.index = newIndex; + }, + /** + * Skip the next n bytes. + * @param {number} n the number of bytes to skip. + * @throws {Error} if the new index is out of the data. + */ + skip: function(n) { + this.setIndex(this.index + n); + }, + /** + * Get the byte at the specified index. + * @param {number} i the index to use. + * @return {number} a byte. + */ + byteAt: function(i) { + // see implementations + }, + /** + * Get the next number with a given byte size. + * @param {number} size the number of bytes to read. + * @return {number} the corresponding number. + */ + readInt: function(size) { + var result = 0, + i; + this.checkOffset(size); + for (i = this.index + size - 1; i >= this.index; i--) { + result = (result << 8) + this.byteAt(i); + } + this.index += size; + return result; + }, + /** + * Get the next string with a given byte size. + * @param {number} size the number of bytes to read. + * @return {string} the corresponding string. + */ + readString: function(size) { + return utils.transformTo("string", this.readData(size)); + }, + /** + * Get raw data without conversion, bytes. + * @param {number} size the number of bytes to read. + * @return {Object} the raw data, implementation specific. + */ + readData: function(size) { + // see implementations + }, + /** + * Find the last occurrence of a zip signature (4 bytes). + * @param {string} sig the signature to find. + * @return {number} the index of the last occurrence, -1 if not found. + */ + lastIndexOfSignature: function(sig) { + // see implementations + }, + /** + * Read the signature (4 bytes) at the current position and compare it with sig. + * @param {string} sig the expected signature + * @return {boolean} true if the signature matches, false otherwise. + */ + readAndCheckSignature: function(sig) { + // see implementations + }, + /** + * Get the next date. + * @return {Date} the date. + */ + readDate: function() { + var dostime = this.readInt(4); + return new Date(Date.UTC( + ((dostime >> 25) & 0x7f) + 1980, // year + ((dostime >> 21) & 0x0f) - 1, // month + (dostime >> 16) & 0x1f, // day + (dostime >> 11) & 0x1f, // hour + (dostime >> 5) & 0x3f, // minute + (dostime & 0x1f) << 1)); // second + } +}; +module.exports = DataReader; + +},{"../utils":32}],19:[function(require,module,exports){ +'use strict'; +var Uint8ArrayReader = require('./Uint8ArrayReader'); +var utils = require('../utils'); + +function NodeBufferReader(data) { + Uint8ArrayReader.call(this, data); +} +utils.inherits(NodeBufferReader, Uint8ArrayReader); + +/** + * @see DataReader.readData + */ +NodeBufferReader.prototype.readData = function(size) { + this.checkOffset(size); + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = NodeBufferReader; + +},{"../utils":32,"./Uint8ArrayReader":21}],20:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function StringReader(data) { + DataReader.call(this, data); +} +utils.inherits(StringReader, DataReader); +/** + * @see DataReader.byteAt + */ +StringReader.prototype.byteAt = function(i) { + return this.data.charCodeAt(this.zero + i); +}; +/** + * @see DataReader.lastIndexOfSignature + */ +StringReader.prototype.lastIndexOfSignature = function(sig) { + return this.data.lastIndexOf(sig) - this.zero; +}; +/** + * @see DataReader.readAndCheckSignature + */ +StringReader.prototype.readAndCheckSignature = function (sig) { + var data = this.readData(4); + return sig === data; +}; +/** + * @see DataReader.readData + */ +StringReader.prototype.readData = function(size) { + this.checkOffset(size); + // this will work because the constructor applied the "& 0xff" mask. + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = StringReader; + +},{"../utils":32,"./DataReader":18}],21:[function(require,module,exports){ +'use strict'; +var ArrayReader = require('./ArrayReader'); +var utils = require('../utils'); + +function Uint8ArrayReader(data) { + ArrayReader.call(this, data); +} +utils.inherits(Uint8ArrayReader, ArrayReader); +/** + * @see DataReader.readData + */ +Uint8ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + // in IE10, when using subarray(idx, idx), we get the array [0x00] instead of []. + return new Uint8Array(0); + } + var result = this.data.subarray(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = Uint8ArrayReader; + +},{"../utils":32,"./ArrayReader":17}],22:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var support = require('../support'); +var ArrayReader = require('./ArrayReader'); +var StringReader = require('./StringReader'); +var NodeBufferReader = require('./NodeBufferReader'); +var Uint8ArrayReader = require('./Uint8ArrayReader'); + +/** + * Create a reader adapted to the data. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data to read. + * @return {DataReader} the data reader. + */ +module.exports = function (data) { + var type = utils.getTypeOf(data); + utils.checkSupport(type); + if (type === "string" && !support.uint8array) { + return new StringReader(data); + } + if (type === "nodebuffer") { + return new NodeBufferReader(data); + } + if (support.uint8array) { + return new Uint8ArrayReader(utils.transformTo("uint8array", data)); + } + return new ArrayReader(utils.transformTo("array", data)); +}; + +},{"../support":30,"../utils":32,"./ArrayReader":17,"./NodeBufferReader":19,"./StringReader":20,"./Uint8ArrayReader":21}],23:[function(require,module,exports){ +'use strict'; +exports.LOCAL_FILE_HEADER = "PK\x03\x04"; +exports.CENTRAL_FILE_HEADER = "PK\x01\x02"; +exports.CENTRAL_DIRECTORY_END = "PK\x05\x06"; +exports.ZIP64_CENTRAL_DIRECTORY_LOCATOR = "PK\x06\x07"; +exports.ZIP64_CENTRAL_DIRECTORY_END = "PK\x06\x06"; +exports.DATA_DESCRIPTOR = "PK\x07\x08"; + +},{}],24:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var utils = require('../utils'); + +/** + * A worker which convert chunks to a specified type. + * @constructor + * @param {String} destType the destination type. + */ +function ConvertWorker(destType) { + GenericWorker.call(this, "ConvertWorker to " + destType); + this.destType = destType; +} +utils.inherits(ConvertWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +ConvertWorker.prototype.processChunk = function (chunk) { + this.push({ + data : utils.transformTo(this.destType, chunk.data), + meta : chunk.meta + }); +}; +module.exports = ConvertWorker; + +},{"../utils":32,"./GenericWorker":28}],25:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var crc32 = require('../crc32'); +var utils = require('../utils'); + +/** + * A worker which calculate the crc32 of the data flowing through. + * @constructor + */ +function Crc32Probe() { + GenericWorker.call(this, "Crc32Probe"); + this.withStreamInfo("crc32", 0); +} +utils.inherits(Crc32Probe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Crc32Probe.prototype.processChunk = function (chunk) { + this.streamInfo.crc32 = crc32(chunk.data, this.streamInfo.crc32 || 0); + this.push(chunk); +}; +module.exports = Crc32Probe; + +},{"../crc32":4,"../utils":32,"./GenericWorker":28}],26:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +/** + * A worker which calculate the total length of the data flowing through. + * @constructor + * @param {String} propName the name used to expose the length + */ +function DataLengthProbe(propName) { + GenericWorker.call(this, "DataLengthProbe for " + propName); + this.propName = propName; + this.withStreamInfo(propName, 0); +} +utils.inherits(DataLengthProbe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +DataLengthProbe.prototype.processChunk = function (chunk) { + if(chunk) { + var length = this.streamInfo[this.propName] || 0; + this.streamInfo[this.propName] = length + chunk.data.length; + } + GenericWorker.prototype.processChunk.call(this, chunk); +}; +module.exports = DataLengthProbe; + + +},{"../utils":32,"./GenericWorker":28}],27:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +// the size of the generated chunks +// TODO expose this as a public variable +var DEFAULT_BLOCK_SIZE = 16 * 1024; + +/** + * A worker that reads a content and emits chunks. + * @constructor + * @param {Promise} dataP the promise of the data to split + */ +function DataWorker(dataP) { + GenericWorker.call(this, "DataWorker"); + var self = this; + this.dataIsReady = false; + this.index = 0; + this.max = 0; + this.data = null; + this.type = ""; + + this._tickScheduled = false; + + dataP.then(function (data) { + self.dataIsReady = true; + self.data = data; + self.max = data && data.length || 0; + self.type = utils.getTypeOf(data); + if(!self.isPaused) { + self._tickAndRepeat(); + } + }, function (e) { + self.error(e); + }); +} + +utils.inherits(DataWorker, GenericWorker); + +/** + * @see GenericWorker.cleanUp + */ +DataWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this.data = null; +}; + +/** + * @see GenericWorker.resume + */ +DataWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this._tickScheduled && this.dataIsReady) { + this._tickScheduled = true; + utils.delay(this._tickAndRepeat, [], this); + } + return true; +}; + +/** + * Trigger a tick a schedule an other call to this function. + */ +DataWorker.prototype._tickAndRepeat = function() { + this._tickScheduled = false; + if(this.isPaused || this.isFinished) { + return; + } + this._tick(); + if(!this.isFinished) { + utils.delay(this._tickAndRepeat, [], this); + this._tickScheduled = true; + } +}; + +/** + * Read and push a chunk. + */ +DataWorker.prototype._tick = function() { + + if(this.isPaused || this.isFinished) { + return false; + } + + var size = DEFAULT_BLOCK_SIZE; + var data = null, nextIndex = Math.min(this.max, this.index + size); + if (this.index >= this.max) { + // EOF + return this.end(); + } else { + switch(this.type) { + case "string": + data = this.data.substring(this.index, nextIndex); + break; + case "uint8array": + data = this.data.subarray(this.index, nextIndex); + break; + case "array": + case "nodebuffer": + data = this.data.slice(this.index, nextIndex); + break; + } + this.index = nextIndex; + return this.push({ + data : data, + meta : { + percent : this.max ? this.index / this.max * 100 : 0 + } + }); + } +}; + +module.exports = DataWorker; + +},{"../utils":32,"./GenericWorker":28}],28:[function(require,module,exports){ +'use strict'; + +/** + * A worker that does nothing but passing chunks to the next one. This is like + * a nodejs stream but with some differences. On the good side : + * - it works on IE 6-9 without any issue / polyfill + * - it weights less than the full dependencies bundled with browserify + * - it forwards errors (no need to declare an error handler EVERYWHERE) + * + * A chunk is an object with 2 attributes : `meta` and `data`. The former is an + * object containing anything (`percent` for example), see each worker for more + * details. The latter is the real data (String, Uint8Array, etc). + * + * @constructor + * @param {String} name the name of the stream (mainly used for debugging purposes) + */ +function GenericWorker(name) { + // the name of the worker + this.name = name || "default"; + // an object containing metadata about the workers chain + this.streamInfo = {}; + // an error which happened when the worker was paused + this.generatedError = null; + // an object containing metadata to be merged by this worker into the general metadata + this.extraStreamInfo = {}; + // true if the stream is paused (and should not do anything), false otherwise + this.isPaused = true; + // true if the stream is finished (and should not do anything), false otherwise + this.isFinished = false; + // true if the stream is locked to prevent further structure updates (pipe), false otherwise + this.isLocked = false; + // the event listeners + this._listeners = { + 'data':[], + 'end':[], + 'error':[] + }; + // the previous worker, if any + this.previous = null; +} + +GenericWorker.prototype = { + /** + * Push a chunk to the next workers. + * @param {Object} chunk the chunk to push + */ + push : function (chunk) { + this.emit("data", chunk); + }, + /** + * End the stream. + * @return {Boolean} true if this call ended the worker, false otherwise. + */ + end : function () { + if (this.isFinished) { + return false; + } + + this.flush(); + try { + this.emit("end"); + this.cleanUp(); + this.isFinished = true; + } catch (e) { + this.emit("error", e); + } + return true; + }, + /** + * End the stream with an error. + * @param {Error} e the error which caused the premature end. + * @return {Boolean} true if this call ended the worker with an error, false otherwise. + */ + error : function (e) { + if (this.isFinished) { + return false; + } + + if(this.isPaused) { + this.generatedError = e; + } else { + this.isFinished = true; + + this.emit("error", e); + + // in the workers chain exploded in the middle of the chain, + // the error event will go downward but we also need to notify + // workers upward that there has been an error. + if(this.previous) { + this.previous.error(e); + } + + this.cleanUp(); + } + return true; + }, + /** + * Add a callback on an event. + * @param {String} name the name of the event (data, end, error) + * @param {Function} listener the function to call when the event is triggered + * @return {GenericWorker} the current object for chainability + */ + on : function (name, listener) { + this._listeners[name].push(listener); + return this; + }, + /** + * Clean any references when a worker is ending. + */ + cleanUp : function () { + this.streamInfo = this.generatedError = this.extraStreamInfo = null; + this._listeners = []; + }, + /** + * Trigger an event. This will call registered callback with the provided arg. + * @param {String} name the name of the event (data, end, error) + * @param {Object} arg the argument to call the callback with. + */ + emit : function (name, arg) { + if (this._listeners[name]) { + for(var i = 0; i < this._listeners[name].length; i++) { + this._listeners[name][i].call(this, arg); + } + } + }, + /** + * Chain a worker with an other. + * @param {Worker} next the worker receiving events from the current one. + * @return {worker} the next worker for chainability + */ + pipe : function (next) { + return next.registerPrevious(this); + }, + /** + * Same as `pipe` in the other direction. + * Using an API with `pipe(next)` is very easy. + * Implementing the API with the point of view of the next one registering + * a source is easier, see the ZipFileWorker. + * @param {Worker} previous the previous worker, sending events to this one + * @return {Worker} the current worker for chainability + */ + registerPrevious : function (previous) { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + + // sharing the streamInfo... + this.streamInfo = previous.streamInfo; + // ... and adding our own bits + this.mergeStreamInfo(); + this.previous = previous; + var self = this; + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.end(); + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; + }, + /** + * Pause the stream so it doesn't send events anymore. + * @return {Boolean} true if this call paused the worker, false otherwise. + */ + pause : function () { + if(this.isPaused || this.isFinished) { + return false; + } + this.isPaused = true; + + if(this.previous) { + this.previous.pause(); + } + return true; + }, + /** + * Resume a paused stream. + * @return {Boolean} true if this call resumed the worker, false otherwise. + */ + resume : function () { + if(!this.isPaused || this.isFinished) { + return false; + } + this.isPaused = false; + + // if true, the worker tried to resume but failed + var withError = false; + if(this.generatedError) { + this.error(this.generatedError); + withError = true; + } + if(this.previous) { + this.previous.resume(); + } + + return !withError; + }, + /** + * Flush any remaining bytes as the stream is ending. + */ + flush : function () {}, + /** + * Process a chunk. This is usually the method overridden. + * @param {Object} chunk the chunk to process. + */ + processChunk : function(chunk) { + this.push(chunk); + }, + /** + * Add a key/value to be added in the workers chain streamInfo once activated. + * @param {String} key the key to use + * @param {Object} value the associated value + * @return {Worker} the current worker for chainability + */ + withStreamInfo : function (key, value) { + this.extraStreamInfo[key] = value; + this.mergeStreamInfo(); + return this; + }, + /** + * Merge this worker's streamInfo into the chain's streamInfo. + */ + mergeStreamInfo : function () { + for(var key in this.extraStreamInfo) { + if (!this.extraStreamInfo.hasOwnProperty(key)) { + continue; + } + this.streamInfo[key] = this.extraStreamInfo[key]; + } + }, + + /** + * Lock the stream to prevent further updates on the workers chain. + * After calling this method, all calls to pipe will fail. + */ + lock: function () { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + this.isLocked = true; + if (this.previous) { + this.previous.lock(); + } + }, + + /** + * + * Pretty print the workers chain. + */ + toString : function () { + var me = "Worker " + this.name; + if (this.previous) { + return this.previous + " -> " + me; + } else { + return me; + } + } +}; + +module.exports = GenericWorker; + +},{}],29:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var ConvertWorker = require('./ConvertWorker'); +var GenericWorker = require('./GenericWorker'); +var base64 = require('../base64'); +var support = require("../support"); +var external = require("../external"); + +var NodejsStreamOutputAdapter = null; +if (support.nodestream) { + try { + NodejsStreamOutputAdapter = require('../nodejs/NodejsStreamOutputAdapter'); + } catch(e) {} +} + +/** + * Apply the final transformation of the data. If the user wants a Blob for + * example, it's easier to work with an U8intArray and finally do the + * ArrayBuffer/Blob conversion. + * @param {String} type the name of the final type + * @param {String|Uint8Array|Buffer} content the content to transform + * @param {String} mimeType the mime type of the content, if applicable. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the content in the right format. + */ +function transformZipOutput(type, content, mimeType) { + switch(type) { + case "blob" : + return utils.newBlob(utils.transformTo("arraybuffer", content), mimeType); + case "base64" : + return base64.encode(content); + default : + return utils.transformTo(type, content); + } +} + +/** + * Concatenate an array of data of the given type. + * @param {String} type the type of the data in the given array. + * @param {Array} dataArray the array containing the data chunks to concatenate + * @return {String|Uint8Array|Buffer} the concatenated data + * @throws Error if the asked type is unsupported + */ +function concat (type, dataArray) { + var i, index = 0, res = null, totalLength = 0; + for(i = 0; i < dataArray.length; i++) { + totalLength += dataArray[i].length; + } + switch(type) { + case "string": + return dataArray.join(""); + case "array": + return Array.prototype.concat.apply([], dataArray); + case "uint8array": + res = new Uint8Array(totalLength); + for(i = 0; i < dataArray.length; i++) { + res.set(dataArray[i], index); + index += dataArray[i].length; + } + return res; + case "nodebuffer": + return Buffer.concat(dataArray); + default: + throw new Error("concat : unsupported type '" + type + "'"); + } +} + +/** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {StreamHelper} helper the helper to use. + * @param {Function} updateCallback a callback called on each update. Called + * with one arg : + * - the metadata linked to the update received. + * @return Promise the promise for the accumulation. + */ +function accumulate(helper, updateCallback) { + return new external.Promise(function (resolve, reject){ + var dataArray = []; + var chunkType = helper._internalType, + resultType = helper._outputType, + mimeType = helper._mimeType; + helper + .on('data', function (data, meta) { + dataArray.push(data); + if(updateCallback) { + updateCallback(meta); + } + }) + .on('error', function(err) { + dataArray = []; + reject(err); + }) + .on('end', function (){ + try { + var result = transformZipOutput(resultType, concat(chunkType, dataArray), mimeType); + resolve(result); + } catch (e) { + reject(e); + } + dataArray = []; + }) + .resume(); + }); +} + +/** + * An helper to easily use workers outside of JSZip. + * @constructor + * @param {Worker} worker the worker to wrap + * @param {String} outputType the type of data expected by the use + * @param {String} mimeType the mime type of the content, if applicable. + */ +function StreamHelper(worker, outputType, mimeType) { + var internalType = outputType; + switch(outputType) { + case "blob": + case "arraybuffer": + internalType = "uint8array"; + break; + case "base64": + internalType = "string"; + break; + } + + try { + // the type used internally + this._internalType = internalType; + // the type used to output results + this._outputType = outputType; + // the mime type + this._mimeType = mimeType; + utils.checkSupport(internalType); + this._worker = worker.pipe(new ConvertWorker(internalType)); + // the last workers can be rewired without issues but we need to + // prevent any updates on previous workers. + worker.lock(); + } catch(e) { + this._worker = new GenericWorker("error"); + this._worker.error(e); + } +} + +StreamHelper.prototype = { + /** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {Function} updateCb the update callback. + * @return Promise the promise for the accumulation. + */ + accumulate : function (updateCb) { + return accumulate(this, updateCb); + }, + /** + * Add a listener on an event triggered on a stream. + * @param {String} evt the name of the event + * @param {Function} fn the listener + * @return {StreamHelper} the current helper. + */ + on : function (evt, fn) { + var self = this; + + if(evt === "data") { + this._worker.on(evt, function (chunk) { + fn.call(self, chunk.data, chunk.meta); + }); + } else { + this._worker.on(evt, function () { + utils.delay(fn, arguments, self); + }); + } + return this; + }, + /** + * Resume the flow of chunks. + * @return {StreamHelper} the current helper. + */ + resume : function () { + utils.delay(this._worker.resume, [], this._worker); + return this; + }, + /** + * Pause the flow of chunks. + * @return {StreamHelper} the current helper. + */ + pause : function () { + this._worker.pause(); + return this; + }, + /** + * Return a nodejs stream for this helper. + * @param {Function} updateCb the update callback. + * @return {NodejsStreamOutputAdapter} the nodejs stream. + */ + toNodejsStream : function (updateCb) { + utils.checkSupport("nodestream"); + if (this._outputType !== "nodebuffer") { + // an object stream containing blob/arraybuffer/uint8array/string + // is strange and I don't know if it would be useful. + // I you find this comment and have a good usecase, please open a + // bug report ! + throw new Error(this._outputType + " is not supported by this method"); + } + + return new NodejsStreamOutputAdapter(this, { + objectMode : this._outputType !== "nodebuffer" + }, updateCb); + } +}; + + +module.exports = StreamHelper; + +},{"../base64":1,"../external":6,"../nodejs/NodejsStreamOutputAdapter":13,"../support":30,"../utils":32,"./ConvertWorker":24,"./GenericWorker":28}],30:[function(require,module,exports){ +'use strict'; + +exports.base64 = true; +exports.array = true; +exports.string = true; +exports.arraybuffer = typeof ArrayBuffer !== "undefined" && typeof Uint8Array !== "undefined"; +exports.nodebuffer = typeof Buffer !== "undefined"; +// contains true if JSZip can read/generate Uint8Array, false otherwise. +exports.uint8array = typeof Uint8Array !== "undefined"; + +if (typeof ArrayBuffer === "undefined") { + exports.blob = false; +} +else { + var buffer = new ArrayBuffer(0); + try { + exports.blob = new Blob([buffer], { + type: "application/zip" + }).size === 0; + } + catch (e) { + try { + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(buffer); + exports.blob = builder.getBlob('application/zip').size === 0; + } + catch (e) { + exports.blob = false; + } + } +} + +try { + exports.nodestream = !!require('readable-stream').Readable; +} catch(e) { + exports.nodestream = false; +} + +},{"readable-stream":16}],31:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); +var support = require('./support'); +var nodejsUtils = require('./nodejsUtils'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * The following functions come from pako, from pako/lib/utils/strings + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Table with utf8 lengths (calculated by first byte of sequence) +// Note, that 5 & 6-byte values and some 4-byte values can not be represented in JS, +// because max possible codepoint is 0x10ffff +var _utf8len = new Array(256); +for (var i=0; i<256; i++) { + _utf8len[i] = (i >= 252 ? 6 : i >= 248 ? 5 : i >= 240 ? 4 : i >= 224 ? 3 : i >= 192 ? 2 : 1); +} +_utf8len[254]=_utf8len[254]=1; // Invalid sequence start + +// convert string to array (typed, when possible) +var string2buf = function (str) { + var buf, c, c2, m_pos, i, str_len = str.length, buf_len = 0; + + // count binary size + for (m_pos = 0; m_pos < str_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + buf_len += c < 0x80 ? 1 : c < 0x800 ? 2 : c < 0x10000 ? 3 : 4; + } + + // allocate buffer + if (support.uint8array) { + buf = new Uint8Array(buf_len); + } else { + buf = new Array(buf_len); + } + + // convert + for (i=0, m_pos = 0; i < buf_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + if (c < 0x80) { + /* one byte */ + buf[i++] = c; + } else if (c < 0x800) { + /* two bytes */ + buf[i++] = 0xC0 | (c >>> 6); + buf[i++] = 0x80 | (c & 0x3f); + } else if (c < 0x10000) { + /* three bytes */ + buf[i++] = 0xE0 | (c >>> 12); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } else { + /* four bytes */ + buf[i++] = 0xf0 | (c >>> 18); + buf[i++] = 0x80 | (c >>> 12 & 0x3f); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } + } + + return buf; +}; + +// Calculate max possible position in utf8 buffer, +// that will not break sequence. If that's not possible +// - (very small limits) return max size as is. +// +// buf[] - utf8 bytes array +// max - length limit (mandatory); +var utf8border = function(buf, max) { + var pos; + + max = max || buf.length; + if (max > buf.length) { max = buf.length; } + + // go back from last position, until start of sequence found + pos = max-1; + while (pos >= 0 && (buf[pos] & 0xC0) === 0x80) { pos--; } + + // Fuckup - very small and broken sequence, + // return max, because we should return something anyway. + if (pos < 0) { return max; } + + // If we came to start of buffer - that means vuffer is too small, + // return max too. + if (pos === 0) { return max; } + + return (pos + _utf8len[buf[pos]] > max) ? pos : max; +}; + +// convert array to string +var buf2string = function (buf) { + var str, i, out, c, c_len; + var len = buf.length; + + // Reserve max possible length (2 words per char) + // NB: by unknown reasons, Array is significantly faster for + // String.fromCharCode.apply than Uint16Array. + var utf16buf = new Array(len*2); + + for (out=0, i=0; i 4) { utf16buf[out++] = 0xfffd; i += c_len-1; continue; } + + // apply mask on first byte + c &= c_len === 2 ? 0x1f : c_len === 3 ? 0x0f : 0x07; + // join the rest + while (c_len > 1 && i < len) { + c = (c << 6) | (buf[i++] & 0x3f); + c_len--; + } + + // terminated by end of string? + if (c_len > 1) { utf16buf[out++] = 0xfffd; continue; } + + if (c < 0x10000) { + utf16buf[out++] = c; + } else { + c -= 0x10000; + utf16buf[out++] = 0xd800 | ((c >> 10) & 0x3ff); + utf16buf[out++] = 0xdc00 | (c & 0x3ff); + } + } + + // shrinkBuf(utf16buf, out) + if (utf16buf.length !== out) { + if(utf16buf.subarray) { + utf16buf = utf16buf.subarray(0, out); + } else { + utf16buf.length = out; + } + } + + // return String.fromCharCode.apply(null, utf16buf); + return utils.applyFromCharCode(utf16buf); +}; + + +// That's all for the pako functions. + + +/** + * Transform a javascript string into an array (typed if possible) of bytes, + * UTF-8 encoded. + * @param {String} str the string to encode + * @return {Array|Uint8Array|Buffer} the UTF-8 encoded string. + */ +exports.utf8encode = function utf8encode(str) { + if (support.nodebuffer) { + return nodejsUtils.newBufferFrom(str, "utf-8"); + } + + return string2buf(str); +}; + + +/** + * Transform a bytes array (or a representation) representing an UTF-8 encoded + * string into a javascript string. + * @param {Array|Uint8Array|Buffer} buf the data de decode + * @return {String} the decoded string. + */ +exports.utf8decode = function utf8decode(buf) { + if (support.nodebuffer) { + return utils.transformTo("nodebuffer", buf).toString("utf-8"); + } + + buf = utils.transformTo(support.uint8array ? "uint8array" : "array", buf); + + return buf2string(buf); +}; + +/** + * A worker to decode utf8 encoded binary chunks into string chunks. + * @constructor + */ +function Utf8DecodeWorker() { + GenericWorker.call(this, "utf-8 decode"); + // the last bytes if a chunk didn't end with a complete codepoint. + this.leftOver = null; +} +utils.inherits(Utf8DecodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8DecodeWorker.prototype.processChunk = function (chunk) { + + var data = utils.transformTo(support.uint8array ? "uint8array" : "array", chunk.data); + + // 1st step, re-use what's left of the previous chunk + if (this.leftOver && this.leftOver.length) { + if(support.uint8array) { + var previousData = data; + data = new Uint8Array(previousData.length + this.leftOver.length); + data.set(this.leftOver, 0); + data.set(previousData, this.leftOver.length); + } else { + data = this.leftOver.concat(data); + } + this.leftOver = null; + } + + var nextBoundary = utf8border(data); + var usableData = data; + if (nextBoundary !== data.length) { + if (support.uint8array) { + usableData = data.subarray(0, nextBoundary); + this.leftOver = data.subarray(nextBoundary, data.length); + } else { + usableData = data.slice(0, nextBoundary); + this.leftOver = data.slice(nextBoundary, data.length); + } + } + + this.push({ + data : exports.utf8decode(usableData), + meta : chunk.meta + }); +}; + +/** + * @see GenericWorker.flush + */ +Utf8DecodeWorker.prototype.flush = function () { + if(this.leftOver && this.leftOver.length) { + this.push({ + data : exports.utf8decode(this.leftOver), + meta : {} + }); + this.leftOver = null; + } +}; +exports.Utf8DecodeWorker = Utf8DecodeWorker; + +/** + * A worker to endcode string chunks into utf8 encoded binary chunks. + * @constructor + */ +function Utf8EncodeWorker() { + GenericWorker.call(this, "utf-8 encode"); +} +utils.inherits(Utf8EncodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8EncodeWorker.prototype.processChunk = function (chunk) { + this.push({ + data : exports.utf8encode(chunk.data), + meta : chunk.meta + }); +}; +exports.Utf8EncodeWorker = Utf8EncodeWorker; + +},{"./nodejsUtils":14,"./stream/GenericWorker":28,"./support":30,"./utils":32}],32:[function(require,module,exports){ +'use strict'; + +var support = require('./support'); +var base64 = require('./base64'); +var nodejsUtils = require('./nodejsUtils'); +var setImmediate = require('set-immediate-shim'); +var external = require("./external"); + + +/** + * Convert a string that pass as a "binary string": it should represent a byte + * array but may have > 255 char codes. Be sure to take only the first byte + * and returns the byte array. + * @param {String} str the string to transform. + * @return {Array|Uint8Array} the string in a binary format. + */ +function string2binary(str) { + var result = null; + if (support.uint8array) { + result = new Uint8Array(str.length); + } else { + result = new Array(str.length); + } + return stringToArrayLike(str, result); +} + +/** + * Create a new blob with the given content and the given type. + * @param {String|ArrayBuffer} part the content to put in the blob. DO NOT use + * an Uint8Array because the stock browser of android 4 won't accept it (it + * will be silently converted to a string, "[object Uint8Array]"). + * + * Use only ONE part to build the blob to avoid a memory leak in IE11 / Edge: + * when a large amount of Array is used to create the Blob, the amount of + * memory consumed is nearly 100 times the original data amount. + * + * @param {String} type the mime type of the blob. + * @return {Blob} the created blob. + */ +exports.newBlob = function(part, type) { + exports.checkSupport("blob"); + + try { + // Blob constructor + return new Blob([part], { + type: type + }); + } + catch (e) { + + try { + // deprecated, browser only, old way + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(part); + return builder.getBlob(type); + } + catch (e) { + + // well, fuck ?! + throw new Error("Bug : can't construct the Blob."); + } + } + + +}; +/** + * The identity function. + * @param {Object} input the input. + * @return {Object} the same input. + */ +function identity(input) { + return input; +} + +/** + * Fill in an array with a string. + * @param {String} str the string to use. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to fill in (will be mutated). + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated array. + */ +function stringToArrayLike(str, array) { + for (var i = 0; i < str.length; ++i) { + array[i] = str.charCodeAt(i) & 0xFF; + } + return array; +} + +/** + * An helper for the function arrayLikeToString. + * This contains static information and functions that + * can be optimized by the browser JIT compiler. + */ +var arrayToStringHelper = { + /** + * Transform an array of int into a string, chunk by chunk. + * See the performances notes on arrayLikeToString. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @param {String} type the type of the array. + * @param {Integer} chunk the chunk size. + * @return {String} the resulting string. + * @throws Error if the chunk is too big for the stack. + */ + stringifyByChunk: function(array, type, chunk) { + var result = [], k = 0, len = array.length; + // shortcut + if (len <= chunk) { + return String.fromCharCode.apply(null, array); + } + while (k < len) { + if (type === "array" || type === "nodebuffer") { + result.push(String.fromCharCode.apply(null, array.slice(k, Math.min(k + chunk, len)))); + } + else { + result.push(String.fromCharCode.apply(null, array.subarray(k, Math.min(k + chunk, len)))); + } + k += chunk; + } + return result.join(""); + }, + /** + * Call String.fromCharCode on every item in the array. + * This is the naive implementation, which generate A LOT of intermediate string. + * This should be used when everything else fail. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ + stringifyByChar: function(array){ + var resultStr = ""; + for(var i = 0; i < array.length; i++) { + resultStr += String.fromCharCode(array[i]); + } + return resultStr; + }, + applyCanBeUsed : { + /** + * true if the browser accepts to use String.fromCharCode on Uint8Array + */ + uint8array : (function () { + try { + return support.uint8array && String.fromCharCode.apply(null, new Uint8Array(1)).length === 1; + } catch (e) { + return false; + } + })(), + /** + * true if the browser accepts to use String.fromCharCode on nodejs Buffer. + */ + nodebuffer : (function () { + try { + return support.nodebuffer && String.fromCharCode.apply(null, nodejsUtils.allocBuffer(1)).length === 1; + } catch (e) { + return false; + } + })() + } +}; + +/** + * Transform an array-like object to a string. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ +function arrayLikeToString(array) { + // Performances notes : + // -------------------- + // String.fromCharCode.apply(null, array) is the fastest, see + // see http://jsperf.com/converting-a-uint8array-to-a-string/2 + // but the stack is limited (and we can get huge arrays !). + // + // result += String.fromCharCode(array[i]); generate too many strings ! + // + // This code is inspired by http://jsperf.com/arraybuffer-to-string-apply-performance/2 + // TODO : we now have workers that split the work. Do we still need that ? + var chunk = 65536, + type = exports.getTypeOf(array), + canUseApply = true; + if (type === "uint8array") { + canUseApply = arrayToStringHelper.applyCanBeUsed.uint8array; + } else if (type === "nodebuffer") { + canUseApply = arrayToStringHelper.applyCanBeUsed.nodebuffer; + } + + if (canUseApply) { + while (chunk > 1) { + try { + return arrayToStringHelper.stringifyByChunk(array, type, chunk); + } catch (e) { + chunk = Math.floor(chunk / 2); + } + } + } + + // no apply or chunk error : slow and painful algorithm + // default browser on android 4.* + return arrayToStringHelper.stringifyByChar(array); +} + +exports.applyFromCharCode = arrayLikeToString; + + +/** + * Copy the data from an array-like to an other array-like. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayFrom the origin array. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayTo the destination array which will be mutated. + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated destination array. + */ +function arrayLikeToArrayLike(arrayFrom, arrayTo) { + for (var i = 0; i < arrayFrom.length; i++) { + arrayTo[i] = arrayFrom[i]; + } + return arrayTo; +} + +// a matrix containing functions to transform everything into everything. +var transform = {}; + +// string to ? +transform["string"] = { + "string": identity, + "array": function(input) { + return stringToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["string"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return stringToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": function(input) { + return stringToArrayLike(input, nodejsUtils.allocBuffer(input.length)); + } +}; + +// array to ? +transform["array"] = { + "string": arrayLikeToString, + "array": identity, + "arraybuffer": function(input) { + return (new Uint8Array(input)).buffer; + }, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// arraybuffer to ? +transform["arraybuffer"] = { + "string": function(input) { + return arrayLikeToString(new Uint8Array(input)); + }, + "array": function(input) { + return arrayLikeToArrayLike(new Uint8Array(input), new Array(input.byteLength)); + }, + "arraybuffer": identity, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(new Uint8Array(input)); + } +}; + +// uint8array to ? +transform["uint8array"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return input.buffer; + }, + "uint8array": identity, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// nodebuffer to ? +transform["nodebuffer"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["nodebuffer"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return arrayLikeToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": identity +}; + +/** + * Transform an input into any type. + * The supported output type are : string, array, uint8array, arraybuffer, nodebuffer. + * If no output type is specified, the unmodified input will be returned. + * @param {String} outputType the output type. + * @param {String|Array|ArrayBuffer|Uint8Array|Buffer} input the input to convert. + * @throws {Error} an Error if the browser doesn't support the requested output type. + */ +exports.transformTo = function(outputType, input) { + if (!input) { + // undefined, null, etc + // an empty string won't harm. + input = ""; + } + if (!outputType) { + return input; + } + exports.checkSupport(outputType); + var inputType = exports.getTypeOf(input); + var result = transform[inputType][outputType](input); + return result; +}; + +/** + * Return the type of the input. + * The type will be in a format valid for JSZip.utils.transformTo : string, array, uint8array, arraybuffer. + * @param {Object} input the input to identify. + * @return {String} the (lowercase) type of the input. + */ +exports.getTypeOf = function(input) { + if (typeof input === "string") { + return "string"; + } + if (Object.prototype.toString.call(input) === "[object Array]") { + return "array"; + } + if (support.nodebuffer && nodejsUtils.isBuffer(input)) { + return "nodebuffer"; + } + if (support.uint8array && input instanceof Uint8Array) { + return "uint8array"; + } + if (support.arraybuffer && input instanceof ArrayBuffer) { + return "arraybuffer"; + } +}; + +/** + * Throw an exception if the type is not supported. + * @param {String} type the type to check. + * @throws {Error} an Error if the browser doesn't support the requested type. + */ +exports.checkSupport = function(type) { + var supported = support[type.toLowerCase()]; + if (!supported) { + throw new Error(type + " is not supported by this platform"); + } +}; + +exports.MAX_VALUE_16BITS = 65535; +exports.MAX_VALUE_32BITS = -1; // well, "\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF" is parsed as -1 + +/** + * Prettify a string read as binary. + * @param {string} str the string to prettify. + * @return {string} a pretty string. + */ +exports.pretty = function(str) { + var res = '', + code, i; + for (i = 0; i < (str || "").length; i++) { + code = str.charCodeAt(i); + res += '\\x' + (code < 16 ? "0" : "") + code.toString(16).toUpperCase(); + } + return res; +}; + +/** + * Defer the call of a function. + * @param {Function} callback the function to call asynchronously. + * @param {Array} args the arguments to give to the callback. + */ +exports.delay = function(callback, args, self) { + setImmediate(function () { + callback.apply(self || null, args || []); + }); +}; + +/** + * Extends a prototype with an other, without calling a constructor with + * side effects. Inspired by nodejs' `utils.inherits` + * @param {Function} ctor the constructor to augment + * @param {Function} superCtor the parent constructor to use + */ +exports.inherits = function (ctor, superCtor) { + var Obj = function() {}; + Obj.prototype = superCtor.prototype; + ctor.prototype = new Obj(); +}; + +/** + * Merge the objects passed as parameters into a new one. + * @private + * @param {...Object} var_args All objects to merge. + * @return {Object} a new object with the data of the others. + */ +exports.extend = function() { + var result = {}, i, attr; + for (i = 0; i < arguments.length; i++) { // arguments is not enumerable in some browsers + for (attr in arguments[i]) { + if (arguments[i].hasOwnProperty(attr) && typeof result[attr] === "undefined") { + result[attr] = arguments[i][attr]; + } + } + } + return result; +}; + +/** + * Transform arbitrary content into a Promise. + * @param {String} name a name for the content being processed. + * @param {Object} inputData the content to process. + * @param {Boolean} isBinary true if the content is not an unicode string + * @param {Boolean} isOptimizedBinaryString true if the string content only has one byte per character. + * @param {Boolean} isBase64 true if the string content is encoded with base64. + * @return {Promise} a promise in a format usable by JSZip. + */ +exports.prepareContent = function(name, inputData, isBinary, isOptimizedBinaryString, isBase64) { + + // if inputData is already a promise, this flatten it. + var promise = external.Promise.resolve(inputData).then(function(data) { + + + var isBlob = support.blob && (data instanceof Blob || ['[object File]', '[object Blob]'].indexOf(Object.prototype.toString.call(data)) !== -1); + + if (isBlob && typeof FileReader !== "undefined") { + return new external.Promise(function (resolve, reject) { + var reader = new FileReader(); + + reader.onload = function(e) { + resolve(e.target.result); + }; + reader.onerror = function(e) { + reject(e.target.error); + }; + reader.readAsArrayBuffer(data); + }); + } else { + return data; + } + }); + + return promise.then(function(data) { + var dataType = exports.getTypeOf(data); + + if (!dataType) { + return external.Promise.reject( + new Error("Can't read the data of '" + name + "'. Is it " + + "in a supported JavaScript type (String, Blob, ArrayBuffer, etc) ?") + ); + } + // special case : it's way easier to work with Uint8Array than with ArrayBuffer + if (dataType === "arraybuffer") { + data = exports.transformTo("uint8array", data); + } else if (dataType === "string") { + if (isBase64) { + data = base64.decode(data); + } + else if (isBinary) { + // optimizedBinaryString === true means that the file has already been filtered with a 0xFF mask + if (isOptimizedBinaryString !== true) { + // this is a string, not in a base64 format. + // Be sure that this is a correct "binary string" + data = string2binary(data); + } + } + } + return data; + }); +}; + +},{"./base64":1,"./external":6,"./nodejsUtils":14,"./support":30,"set-immediate-shim":54}],33:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var sig = require('./signature'); +var ZipEntry = require('./zipEntry'); +var utf8 = require('./utf8'); +var support = require('./support'); +// class ZipEntries {{{ +/** + * All the entries in the zip file. + * @constructor + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntries(loadOptions) { + this.files = []; + this.loadOptions = loadOptions; +} +ZipEntries.prototype = { + /** + * Check that the reader is on the specified signature. + * @param {string} expectedSignature the expected signature. + * @throws {Error} if it is an other signature. + */ + checkSignature: function(expectedSignature) { + if (!this.reader.readAndCheckSignature(expectedSignature)) { + this.reader.index -= 4; + var signature = this.reader.readString(4); + throw new Error("Corrupted zip or bug: unexpected signature " + "(" + utils.pretty(signature) + ", expected " + utils.pretty(expectedSignature) + ")"); + } + }, + /** + * Check if the given signature is at the given index. + * @param {number} askedIndex the index to check. + * @param {string} expectedSignature the signature to expect. + * @return {boolean} true if the signature is here, false otherwise. + */ + isSignature: function(askedIndex, expectedSignature) { + var currentIndex = this.reader.index; + this.reader.setIndex(askedIndex); + var signature = this.reader.readString(4); + var result = signature === expectedSignature; + this.reader.setIndex(currentIndex); + return result; + }, + /** + * Read the end of the central directory. + */ + readBlockEndOfCentral: function() { + this.diskNumber = this.reader.readInt(2); + this.diskWithCentralDirStart = this.reader.readInt(2); + this.centralDirRecordsOnThisDisk = this.reader.readInt(2); + this.centralDirRecords = this.reader.readInt(2); + this.centralDirSize = this.reader.readInt(4); + this.centralDirOffset = this.reader.readInt(4); + + this.zipCommentLength = this.reader.readInt(2); + // warning : the encoding depends of the system locale + // On a linux machine with LANG=en_US.utf8, this field is utf8 encoded. + // On a windows machine, this field is encoded with the localized windows code page. + var zipComment = this.reader.readData(this.zipCommentLength); + var decodeParamType = support.uint8array ? "uint8array" : "array"; + // To get consistent behavior with the generation part, we will assume that + // this is utf8 encoded unless specified otherwise. + var decodeContent = utils.transformTo(decodeParamType, zipComment); + this.zipComment = this.loadOptions.decodeFileName(decodeContent); + }, + /** + * Read the end of the Zip 64 central directory. + * Not merged with the method readEndOfCentral : + * The end of central can coexist with its Zip64 brother, + * I don't want to read the wrong number of bytes ! + */ + readBlockZip64EndOfCentral: function() { + this.zip64EndOfCentralSize = this.reader.readInt(8); + this.reader.skip(4); + // this.versionMadeBy = this.reader.readString(2); + // this.versionNeeded = this.reader.readInt(2); + this.diskNumber = this.reader.readInt(4); + this.diskWithCentralDirStart = this.reader.readInt(4); + this.centralDirRecordsOnThisDisk = this.reader.readInt(8); + this.centralDirRecords = this.reader.readInt(8); + this.centralDirSize = this.reader.readInt(8); + this.centralDirOffset = this.reader.readInt(8); + + this.zip64ExtensibleData = {}; + var extraDataSize = this.zip64EndOfCentralSize - 44, + index = 0, + extraFieldId, + extraFieldLength, + extraFieldValue; + while (index < extraDataSize) { + extraFieldId = this.reader.readInt(2); + extraFieldLength = this.reader.readInt(4); + extraFieldValue = this.reader.readData(extraFieldLength); + this.zip64ExtensibleData[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + }, + /** + * Read the end of the Zip 64 central directory locator. + */ + readBlockZip64EndOfCentralLocator: function() { + this.diskWithZip64CentralDirStart = this.reader.readInt(4); + this.relativeOffsetEndOfZip64CentralDir = this.reader.readInt(8); + this.disksCount = this.reader.readInt(4); + if (this.disksCount > 1) { + throw new Error("Multi-volumes zip are not supported"); + } + }, + /** + * Read the local files, based on the offset read in the central part. + */ + readLocalFiles: function() { + var i, file; + for (i = 0; i < this.files.length; i++) { + file = this.files[i]; + this.reader.setIndex(file.localHeaderOffset); + this.checkSignature(sig.LOCAL_FILE_HEADER); + file.readLocalPart(this.reader); + file.handleUTF8(); + file.processAttributes(); + } + }, + /** + * Read the central directory. + */ + readCentralDir: function() { + var file; + + this.reader.setIndex(this.centralDirOffset); + while (this.reader.readAndCheckSignature(sig.CENTRAL_FILE_HEADER)) { + file = new ZipEntry({ + zip64: this.zip64 + }, this.loadOptions); + file.readCentralPart(this.reader); + this.files.push(file); + } + + if (this.centralDirRecords !== this.files.length) { + if (this.centralDirRecords !== 0 && this.files.length === 0) { + // We expected some records but couldn't find ANY. + // This is really suspicious, as if something went wrong. + throw new Error("Corrupted zip or bug: expected " + this.centralDirRecords + " records in central dir, got " + this.files.length); + } else { + // We found some records but not all. + // Something is wrong but we got something for the user: no error here. + // console.warn("expected", this.centralDirRecords, "records in central dir, got", this.files.length); + } + } + }, + /** + * Read the end of central directory. + */ + readEndOfCentral: function() { + var offset = this.reader.lastIndexOfSignature(sig.CENTRAL_DIRECTORY_END); + if (offset < 0) { + // Check if the content is a truncated zip or complete garbage. + // A "LOCAL_FILE_HEADER" is not required at the beginning (auto + // extractible zip for example) but it can give a good hint. + // If an ajax request was used without responseType, we will also + // get unreadable data. + var isGarbage = !this.isSignature(0, sig.LOCAL_FILE_HEADER); + + if (isGarbage) { + throw new Error("Can't find end of central directory : is this a zip file ? " + + "If it is, see https://stuk.github.io/jszip/documentation/howto/read_zip.html"); + } else { + throw new Error("Corrupted zip: can't find end of central directory"); + } + + } + this.reader.setIndex(offset); + var endOfCentralDirOffset = offset; + this.checkSignature(sig.CENTRAL_DIRECTORY_END); + this.readBlockEndOfCentral(); + + + /* extract from the zip spec : + 4) If one of the fields in the end of central directory + record is too small to hold required data, the field + should be set to -1 (0xFFFF or 0xFFFFFFFF) and the + ZIP64 format record should be created. + 5) The end of central directory record and the + Zip64 end of central directory locator record must + reside on the same disk when splitting or spanning + an archive. + */ + if (this.diskNumber === utils.MAX_VALUE_16BITS || this.diskWithCentralDirStart === utils.MAX_VALUE_16BITS || this.centralDirRecordsOnThisDisk === utils.MAX_VALUE_16BITS || this.centralDirRecords === utils.MAX_VALUE_16BITS || this.centralDirSize === utils.MAX_VALUE_32BITS || this.centralDirOffset === utils.MAX_VALUE_32BITS) { + this.zip64 = true; + + /* + Warning : the zip64 extension is supported, but ONLY if the 64bits integer read from + the zip file can fit into a 32bits integer. This cannot be solved : JavaScript represents + all numbers as 64-bit double precision IEEE 754 floating point numbers. + So, we have 53bits for integers and bitwise operations treat everything as 32bits. + see https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Operators/Bitwise_Operators + and http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-262.pdf section 8.5 + */ + + // should look for a zip64 EOCD locator + offset = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + if (offset < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory locator"); + } + this.reader.setIndex(offset); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + this.readBlockZip64EndOfCentralLocator(); + + // now the zip64 EOCD record + if (!this.isSignature(this.relativeOffsetEndOfZip64CentralDir, sig.ZIP64_CENTRAL_DIRECTORY_END)) { + // console.warn("ZIP64 end of central directory not where expected."); + this.relativeOffsetEndOfZip64CentralDir = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + if (this.relativeOffsetEndOfZip64CentralDir < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory"); + } + } + this.reader.setIndex(this.relativeOffsetEndOfZip64CentralDir); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + this.readBlockZip64EndOfCentral(); + } + + var expectedEndOfCentralDirOffset = this.centralDirOffset + this.centralDirSize; + if (this.zip64) { + expectedEndOfCentralDirOffset += 20; // end of central dir 64 locator + expectedEndOfCentralDirOffset += 12 /* should not include the leading 12 bytes */ + this.zip64EndOfCentralSize; + } + + var extraBytes = endOfCentralDirOffset - expectedEndOfCentralDirOffset; + + if (extraBytes > 0) { + // console.warn(extraBytes, "extra bytes at beginning or within zipfile"); + if (this.isSignature(endOfCentralDirOffset, sig.CENTRAL_FILE_HEADER)) { + // The offsets seem wrong, but we have something at the specified offset. + // So… we keep it. + } else { + // the offset is wrong, update the "zero" of the reader + // this happens if data has been prepended (crx files for example) + this.reader.zero = extraBytes; + } + } else if (extraBytes < 0) { + throw new Error("Corrupted zip: missing " + Math.abs(extraBytes) + " bytes."); + } + }, + prepareReader: function(data) { + this.reader = readerFor(data); + }, + /** + * Read a zip file and create ZipEntries. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the binary string representing a zip file. + */ + load: function(data) { + this.prepareReader(data); + this.readEndOfCentral(); + this.readCentralDir(); + this.readLocalFiles(); + } +}; +// }}} end of ZipEntries +module.exports = ZipEntries; + +},{"./reader/readerFor":22,"./signature":23,"./support":30,"./utf8":31,"./utils":32,"./zipEntry":34}],34:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var CompressedObject = require('./compressedObject'); +var crc32fn = require('./crc32'); +var utf8 = require('./utf8'); +var compressions = require('./compressions'); +var support = require('./support'); + +var MADE_BY_DOS = 0x00; +var MADE_BY_UNIX = 0x03; + +/** + * Find a compression registered in JSZip. + * @param {string} compressionMethod the method magic to find. + * @return {Object|null} the JSZip compression object, null if none found. + */ +var findCompression = function(compressionMethod) { + for (var method in compressions) { + if (!compressions.hasOwnProperty(method)) { + continue; + } + if (compressions[method].magic === compressionMethod) { + return compressions[method]; + } + } + return null; +}; + +// class ZipEntry {{{ +/** + * An entry in the zip file. + * @constructor + * @param {Object} options Options of the current file. + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntry(options, loadOptions) { + this.options = options; + this.loadOptions = loadOptions; +} +ZipEntry.prototype = { + /** + * say if the file is encrypted. + * @return {boolean} true if the file is encrypted, false otherwise. + */ + isEncrypted: function() { + // bit 1 is set + return (this.bitFlag & 0x0001) === 0x0001; + }, + /** + * say if the file has utf-8 filename/comment. + * @return {boolean} true if the filename/comment is in utf-8, false otherwise. + */ + useUTF8: function() { + // bit 11 is set + return (this.bitFlag & 0x0800) === 0x0800; + }, + /** + * Read the local part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readLocalPart: function(reader) { + var compression, localExtraFieldsLength; + + // we already know everything from the central dir ! + // If the central dir data are false, we are doomed. + // On the bright side, the local part is scary : zip64, data descriptors, both, etc. + // The less data we get here, the more reliable this should be. + // Let's skip the whole header and dash to the data ! + reader.skip(22); + // in some zip created on windows, the filename stored in the central dir contains \ instead of /. + // Strangely, the filename here is OK. + // I would love to treat these zip files as corrupted (see http://www.info-zip.org/FAQ.html#backslashes + // or APPNOTE#4.4.17.1, "All slashes MUST be forward slashes '/'") but there are a lot of bad zip generators... + // Search "unzip mismatching "local" filename continuing with "central" filename version" on + // the internet. + // + // I think I see the logic here : the central directory is used to display + // content and the local directory is used to extract the files. Mixing / and \ + // may be used to display \ to windows users and use / when extracting the files. + // Unfortunately, this lead also to some issues : http://seclists.org/fulldisclosure/2009/Sep/394 + this.fileNameLength = reader.readInt(2); + localExtraFieldsLength = reader.readInt(2); // can't be sure this will be the same as the central dir + // the fileName is stored as binary data, the handleUTF8 method will take care of the encoding. + this.fileName = reader.readData(this.fileNameLength); + reader.skip(localExtraFieldsLength); + + if (this.compressedSize === -1 || this.uncompressedSize === -1) { + throw new Error("Bug or corrupted zip : didn't get enough information from the central directory " + "(compressedSize === -1 || uncompressedSize === -1)"); + } + + compression = findCompression(this.compressionMethod); + if (compression === null) { // no compression found + throw new Error("Corrupted zip : compression " + utils.pretty(this.compressionMethod) + " unknown (inner file : " + utils.transformTo("string", this.fileName) + ")"); + } + this.decompressed = new CompressedObject(this.compressedSize, this.uncompressedSize, this.crc32, compression, reader.readData(this.compressedSize)); + }, + + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readCentralPart: function(reader) { + this.versionMadeBy = reader.readInt(2); + reader.skip(2); + // this.versionNeeded = reader.readInt(2); + this.bitFlag = reader.readInt(2); + this.compressionMethod = reader.readString(2); + this.date = reader.readDate(); + this.crc32 = reader.readInt(4); + this.compressedSize = reader.readInt(4); + this.uncompressedSize = reader.readInt(4); + var fileNameLength = reader.readInt(2); + this.extraFieldsLength = reader.readInt(2); + this.fileCommentLength = reader.readInt(2); + this.diskNumberStart = reader.readInt(2); + this.internalFileAttributes = reader.readInt(2); + this.externalFileAttributes = reader.readInt(4); + this.localHeaderOffset = reader.readInt(4); + + if (this.isEncrypted()) { + throw new Error("Encrypted zip are not supported"); + } + + // will be read in the local part, see the comments there + reader.skip(fileNameLength); + this.readExtraFields(reader); + this.parseZIP64ExtraField(reader); + this.fileComment = reader.readData(this.fileCommentLength); + }, + + /** + * Parse the external file attributes and get the unix/dos permissions. + */ + processAttributes: function () { + this.unixPermissions = null; + this.dosPermissions = null; + var madeBy = this.versionMadeBy >> 8; + + // Check if we have the DOS directory flag set. + // We look for it in the DOS and UNIX permissions + // but some unknown platform could set it as a compatibility flag. + this.dir = this.externalFileAttributes & 0x0010 ? true : false; + + if(madeBy === MADE_BY_DOS) { + // first 6 bits (0 to 5) + this.dosPermissions = this.externalFileAttributes & 0x3F; + } + + if(madeBy === MADE_BY_UNIX) { + this.unixPermissions = (this.externalFileAttributes >> 16) & 0xFFFF; + // the octal permissions are in (this.unixPermissions & 0x01FF).toString(8); + } + + // fail safe : if the name ends with a / it probably means a folder + if (!this.dir && this.fileNameStr.slice(-1) === '/') { + this.dir = true; + } + }, + + /** + * Parse the ZIP64 extra field and merge the info in the current ZipEntry. + * @param {DataReader} reader the reader to use. + */ + parseZIP64ExtraField: function(reader) { + + if (!this.extraFields[0x0001]) { + return; + } + + // should be something, preparing the extra reader + var extraReader = readerFor(this.extraFields[0x0001].value); + + // I really hope that these 64bits integer can fit in 32 bits integer, because js + // won't let us have more. + if (this.uncompressedSize === utils.MAX_VALUE_32BITS) { + this.uncompressedSize = extraReader.readInt(8); + } + if (this.compressedSize === utils.MAX_VALUE_32BITS) { + this.compressedSize = extraReader.readInt(8); + } + if (this.localHeaderOffset === utils.MAX_VALUE_32BITS) { + this.localHeaderOffset = extraReader.readInt(8); + } + if (this.diskNumberStart === utils.MAX_VALUE_32BITS) { + this.diskNumberStart = extraReader.readInt(4); + } + }, + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readExtraFields: function(reader) { + var end = reader.index + this.extraFieldsLength, + extraFieldId, + extraFieldLength, + extraFieldValue; + + if (!this.extraFields) { + this.extraFields = {}; + } + + while (reader.index + 4 < end) { + extraFieldId = reader.readInt(2); + extraFieldLength = reader.readInt(2); + extraFieldValue = reader.readData(extraFieldLength); + + this.extraFields[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + + reader.setIndex(end); + }, + /** + * Apply an UTF8 transformation if needed. + */ + handleUTF8: function() { + var decodeParamType = support.uint8array ? "uint8array" : "array"; + if (this.useUTF8()) { + this.fileNameStr = utf8.utf8decode(this.fileName); + this.fileCommentStr = utf8.utf8decode(this.fileComment); + } else { + var upath = this.findExtraFieldUnicodePath(); + if (upath !== null) { + this.fileNameStr = upath; + } else { + // ASCII text or unsupported code page + var fileNameByteArray = utils.transformTo(decodeParamType, this.fileName); + this.fileNameStr = this.loadOptions.decodeFileName(fileNameByteArray); + } + + var ucomment = this.findExtraFieldUnicodeComment(); + if (ucomment !== null) { + this.fileCommentStr = ucomment; + } else { + // ASCII text or unsupported code page + var commentByteArray = utils.transformTo(decodeParamType, this.fileComment); + this.fileCommentStr = this.loadOptions.decodeFileName(commentByteArray); + } + } + }, + + /** + * Find the unicode path declared in the extra field, if any. + * @return {String} the unicode path, null otherwise. + */ + findExtraFieldUnicodePath: function() { + var upathField = this.extraFields[0x7075]; + if (upathField) { + var extraReader = readerFor(upathField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the filename changed, this field is out of date. + if (crc32fn(this.fileName) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(upathField.length - 5)); + } + return null; + }, + + /** + * Find the unicode comment declared in the extra field, if any. + * @return {String} the unicode comment, null otherwise. + */ + findExtraFieldUnicodeComment: function() { + var ucommentField = this.extraFields[0x6375]; + if (ucommentField) { + var extraReader = readerFor(ucommentField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the comment changed, this field is out of date. + if (crc32fn(this.fileComment) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(ucommentField.length - 5)); + } + return null; + } +}; +module.exports = ZipEntry; + +},{"./compressedObject":2,"./compressions":3,"./crc32":4,"./reader/readerFor":22,"./support":30,"./utf8":31,"./utils":32}],35:[function(require,module,exports){ +'use strict'; + +var StreamHelper = require('./stream/StreamHelper'); +var DataWorker = require('./stream/DataWorker'); +var utf8 = require('./utf8'); +var CompressedObject = require('./compressedObject'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * A simple object representing a file in the zip file. + * @constructor + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data + * @param {Object} options the options of the file + */ +var ZipObject = function(name, data, options) { + this.name = name; + this.dir = options.dir; + this.date = options.date; + this.comment = options.comment; + this.unixPermissions = options.unixPermissions; + this.dosPermissions = options.dosPermissions; + + this._data = data; + this._dataBinary = options.binary; + // keep only the compression + this.options = { + compression : options.compression, + compressionOptions : options.compressionOptions + }; +}; + +ZipObject.prototype = { + /** + * Create an internal stream for the content of this object. + * @param {String} type the type of each chunk. + * @return StreamHelper the stream. + */ + internalStream: function (type) { + var result = null, outputType = "string"; + try { + if (!type) { + throw new Error("No output type specified."); + } + outputType = type.toLowerCase(); + var askUnicodeString = outputType === "string" || outputType === "text"; + if (outputType === "binarystring" || outputType === "text") { + outputType = "string"; + } + result = this._decompressWorker(); + + var isUnicodeString = !this._dataBinary; + + if (isUnicodeString && !askUnicodeString) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + if (!isUnicodeString && askUnicodeString) { + result = result.pipe(new utf8.Utf8DecodeWorker()); + } + } catch (e) { + result = new GenericWorker("error"); + result.error(e); + } + + return new StreamHelper(result, outputType, ""); + }, + + /** + * Prepare the content in the asked type. + * @param {String} type the type of the result. + * @param {Function} onUpdate a function to call on each internal update. + * @return Promise the promise of the result. + */ + async: function (type, onUpdate) { + return this.internalStream(type).accumulate(onUpdate); + }, + + /** + * Prepare the content as a nodejs stream. + * @param {String} type the type of each chunk. + * @param {Function} onUpdate a function to call on each internal update. + * @return Stream the stream. + */ + nodeStream: function (type, onUpdate) { + return this.internalStream(type || "nodebuffer").toNodejsStream(onUpdate); + }, + + /** + * Return a worker for the compressed content. + * @private + * @param {Object} compression the compression object to use. + * @param {Object} compressionOptions the options to use when compressing. + * @return Worker the worker. + */ + _compressWorker: function (compression, compressionOptions) { + if ( + this._data instanceof CompressedObject && + this._data.compression.magic === compression.magic + ) { + return this._data.getCompressedWorker(); + } else { + var result = this._decompressWorker(); + if(!this._dataBinary) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + return CompressedObject.createWorkerFrom(result, compression, compressionOptions); + } + }, + /** + * Return a worker for the decompressed content. + * @private + * @return Worker the worker. + */ + _decompressWorker : function () { + if (this._data instanceof CompressedObject) { + return this._data.getContentWorker(); + } else if (this._data instanceof GenericWorker) { + return this._data; + } else { + return new DataWorker(this._data); + } + } +}; + +var removedMethods = ["asText", "asBinary", "asNodeBuffer", "asUint8Array", "asArrayBuffer"]; +var removedFn = function () { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); +}; + +for(var i = 0; i < removedMethods.length; i++) { + ZipObject.prototype[removedMethods[i]] = removedFn; +} +module.exports = ZipObject; + +},{"./compressedObject":2,"./stream/DataWorker":27,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31}],36:[function(require,module,exports){ +(function (global){ +'use strict'; +var Mutation = global.MutationObserver || global.WebKitMutationObserver; + +var scheduleDrain; + +{ + if (Mutation) { + var called = 0; + var observer = new Mutation(nextTick); + var element = global.document.createTextNode(''); + observer.observe(element, { + characterData: true + }); + scheduleDrain = function () { + element.data = (called = ++called % 2); + }; + } else if (!global.setImmediate && typeof global.MessageChannel !== 'undefined') { + var channel = new global.MessageChannel(); + channel.port1.onmessage = nextTick; + scheduleDrain = function () { + channel.port2.postMessage(0); + }; + } else if ('document' in global && 'onreadystatechange' in global.document.createElement('script')) { + scheduleDrain = function () { + + // Create a + + + + + +
+ +

index.html

+
+ + diff --git a/overview-tree.html b/overview-tree.html new file mode 100644 index 000000000..1e107b345 --- /dev/null +++ b/overview-tree.html @@ -0,0 +1,552 @@ + + + + + +Class Hierarchy (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Annotation Type Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+
+ +
+ + diff --git a/package-search-index.js b/package-search-index.js new file mode 100644 index 000000000..1eb133b1e --- /dev/null +++ b/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","url":"allpackages-index.html"},{"l":"com.backblaze.b2.client"},{"l":"com.backblaze.b2.client.contentHandlers"},{"l":"com.backblaze.b2.client.contentSources"},{"l":"com.backblaze.b2.client.credentialsSources"},{"l":"com.backblaze.b2.client.exceptions"},{"l":"com.backblaze.b2.client.structures"},{"l":"com.backblaze.b2.client.webApiClients"},{"l":"com.backblaze.b2.json"},{"l":"com.backblaze.b2.util"}] \ No newline at end of file diff --git a/package-search-index.zip b/package-search-index.zip new file mode 100644 index 0000000000000000000000000000000000000000..c7c7c893fe2e97867b444e89922e0744d2874cf1 GIT binary patch literal 310 zcmWIWW@Zs#;Nak3n6=?U1OpO~1hNYfld}`kQ+10|6N{2FbTji(QY-Ybiu3b&C+y`r zWWduB&zh9mKb#}nXOD8-?hvao%Qm`?)Nr#9JoRsvExf%rEN>jUL}qZ_~k#FbE+Q;{`;0FZwVNX2n-^JoI; zP;4#$8DIy*Yk-P>VN(DUKmPse7mx+ExD4O|;?E5D0Z5($mjO3`*anwQU^s{ZDK#Lz zj>~{qyaIx5K!t%=G&2IJNzg!ChRpyLkO7}Ry!QaotAHAMpbB3AF(}|_f!G-oI|uK6 z`id_dumai5K%C3Y$;tKS_iqMPHg<*|-@e`liWLAggVM!zAP#@l;=c>S03;{#04Z~5 zN_+ss=Yg6*hTr59mzMwZ@+l~q!+?ft!fF66AXT#wWavHt30bZWFCK%!BNk}LN?0Hg z1VF_nfs`Lm^DjYZ1(1uD0u4CSIr)XAaqW6IT{!St5~1{i=i}zAy76p%_|w8rh@@c0Axr!ns=D-X+|*sY6!@wacG9%)Qn*O zl0sa739kT-&_?#oVxXF6tOnqTD)cZ}2vi$`ZU8RLAlo8=_z#*P3xI~i!lEh+Pdu-L zx{d*wgjtXbnGX_Yf@Tc7Q3YhLhPvc8noGJs2DA~1DySiA&6V{5JzFt ojAY1KXm~va;tU{v7C?Xj0BHw!K;2aXV*mgE07*qoM6N<$f;4TDA^-pY literal 0 HcmV?d00001 diff --git a/script.js b/script.js new file mode 100644 index 000000000..7dc93c48e --- /dev/null +++ b/script.js @@ -0,0 +1,149 @@ +/* + * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'jquery/jszip/dist/jszip.js'); + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils.js'); + if (window.navigator.userAgent.indexOf('MSIE ') > 0 || window.navigator.userAgent.indexOf('Trident/') > 0 || + window.navigator.userAgent.indexOf('Edge/') > 0) { + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils-ie.js'); + } + createElem(doc, tag, 'search.js'); + + $.get(pathtoroot + "module-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "module-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("module-search-index.json").async("text").then(function(content){ + moduleSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "package-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "package-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("package-search-index.json").async("text").then(function(content){ + packageSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "type-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "type-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("type-search-index.json").async("text").then(function(content){ + typeSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "member-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "member-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("member-search-index.json").async("text").then(function(content){ + memberSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "tag-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "tag-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("tag-search-index.json").async("text").then(function(content){ + tagSearchIndex = JSON.parse(content); + }); + }); + }); + }); + if (!moduleSearchIndex) { + createElem(doc, tag, 'module-search-index.js'); + } + if (!packageSearchIndex) { + createElem(doc, tag, 'package-search-index.js'); + } + if (!typeSearchIndex) { + createElem(doc, tag, 'type-search-index.js'); + } + if (!memberSearchIndex) { + createElem(doc, tag, 'member-search-index.js'); + } + if (!tagSearchIndex) { + createElem(doc, tag, 'tag-search-index.js'); + } + $(window).resize(function() { + $('.navPadding').css('padding-top', $('.fixedNav').css("height")); + }); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(type) { + count = 0; + for (var key in data) { + var row = document.getElementById(key); + if ((data[key] & type) !== 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) { + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} + +function updateModuleFrame(pFrame, cFrame) { + top.packageFrame.location = pFrame; + top.classFrame.location = cFrame; +} diff --git a/search.js b/search.js new file mode 100644 index 000000000..8492271e7 --- /dev/null +++ b/search.js @@ -0,0 +1,326 @@ +/* + * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var noResult = {l: "No results found"}; +var catModules = "Modules"; +var catPackages = "Packages"; +var catTypes = "Types"; +var catMembers = "Members"; +var catSearchTags = "SearchTags"; +var highlight = "$&"; +var camelCaseRegexp = ""; +var secondaryMatcher = ""; +function getHighlightedText(item) { + var ccMatcher = new RegExp(camelCaseRegexp); + var label = item.replace(ccMatcher, highlight); + if (label === item) { + label = item.replace(secondaryMatcher, highlight); + } + return label; +} +function getURLPrefix(ui) { + var urlPrefix=""; + if (useModuleDirectories) { + var slash = "/"; + if (ui.item.category === catModules) { + return ui.item.l + slash; + } else if (ui.item.category === catPackages && ui.item.m) { + return ui.item.m + slash; + } else if ((ui.item.category === catTypes && ui.item.p) || ui.item.category === catMembers) { + $.each(packageSearchIndex, function(index, item) { + if (item.m && ui.item.p == item.l) { + urlPrefix = item.m + slash; + } + }); + return urlPrefix; + } else { + return urlPrefix; + } + } + return urlPrefix; +} +var watermark = 'Search'; +$(function() { + $("#search").val(''); + $("#search").prop("disabled", false); + $("#reset").prop("disabled", false); + $("#search").val(watermark).addClass('watermark'); + $("#search").blur(function() { + if ($(this).val().length == 0) { + $(this).val(watermark).addClass('watermark'); + } + }); + $("#search").on('click keydown', function() { + if ($(this).val() == watermark) { + $(this).val('').removeClass('watermark'); + } + }); + $("#reset").click(function() { + $("#search").val(''); + $("#search").focus(); + }); + $("#search").focus(); + $("#search")[0].setSelectionRange(0, 0); +}); +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); + }, + _renderMenu: function(ul, items) { + var rMenu = this, + currentCategory = ""; + rMenu.menu.bindings = $(); + $.each(items, function(index, item) { + var li; + if (item.l !== noResult.l && item.category !== currentCategory) { + ul.append("
  • " + item.category + "
  • "); + currentCategory = item.category; + } + li = rMenu._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", item.category + " : " + item.l); + li.attr("class", "resultItem"); + } else { + li.attr("aria-label", item.l); + li.attr("class", "resultItem"); + } + }); + }, + _renderItem: function(ul, item) { + var label = ""; + if (item.category === catModules) { + label = getHighlightedText(item.l); + } else if (item.category === catPackages) { + label = (item.m) + ? getHighlightedText(item.m + "/" + item.l) + : getHighlightedText(item.l); + } else if (item.category === catTypes) { + label = (item.p) + ? getHighlightedText(item.p + "." + item.l) + : getHighlightedText(item.l); + } else if (item.category === catMembers) { + label = getHighlightedText(item.p + "." + (item.c + "." + item.l)); + } else if (item.category === catSearchTags) { + label = getHighlightedText(item.l); + } else { + label = item.l; + } + var li = $("
  • ").appendTo(ul); + var div = $("
    ").appendTo(li); + if (item.category === catSearchTags) { + if (item.d) { + div.html(label + " (" + item.h + ")
    " + + item.d + "
    "); + } else { + div.html(label + " (" + item.h + ")"); + } + } else { + div.html(label); + } + return li; + } +}); +$(function() { + $("#search").catcomplete({ + minLength: 1, + delay: 100, + source: function(request, response) { + var result = new Array(); + var presult = new Array(); + var tresult = new Array(); + var mresult = new Array(); + var tgresult = new Array(); + var secondaryresult = new Array(); + var displayCount = 0; + var exactMatcher = new RegExp("^" + $.ui.autocomplete.escapeRegex(request.term) + "$", "i"); + camelCaseRegexp = ($.ui.autocomplete.escapeRegex(request.term)).split(/(?=[A-Z])/).join("([a-z0-9_$]*?)"); + var camelCaseMatcher = new RegExp("^" + camelCaseRegexp); + secondaryMatcher = new RegExp($.ui.autocomplete.escapeRegex(request.term), "i"); + + // Return the nested innermost name from the specified object + function nestedName(e) { + return e.l.substring(e.l.lastIndexOf(".") + 1); + } + + function concatResults(a1, a2) { + a1 = a1.concat(a2); + a2.length = 0; + return a1; + } + + if (moduleSearchIndex) { + var mdleCount = 0; + $.each(moduleSearchIndex, function(index, item) { + item.category = catModules; + if (exactMatcher.test(item.l)) { + result.push(item); + mdleCount++; + } else if (camelCaseMatcher.test(item.l)) { + result.push(item); + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + displayCount = mdleCount; + result = concatResults(result, secondaryresult); + } + if (packageSearchIndex) { + var pCount = 0; + var pkg = ""; + $.each(packageSearchIndex, function(index, item) { + item.category = catPackages; + pkg = (item.m) + ? (item.m + "/" + item.l) + : item.l; + if (exactMatcher.test(item.l)) { + presult.push(item); + pCount++; + } else if (camelCaseMatcher.test(pkg)) { + presult.push(item); + } else if (secondaryMatcher.test(pkg)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(presult, secondaryresult)); + displayCount = (pCount > displayCount) ? pCount : displayCount; + } + if (typeSearchIndex) { + var tCount = 0; + $.each(typeSearchIndex, function(index, item) { + item.category = catTypes; + var s = nestedName(item); + if (exactMatcher.test(s)) { + tresult.push(item); + tCount++; + } else if (camelCaseMatcher.test(s)) { + tresult.push(item); + } else if (secondaryMatcher.test(item.p + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tresult, secondaryresult)); + displayCount = (tCount > displayCount) ? tCount : displayCount; + } + if (memberSearchIndex) { + var mCount = 0; + $.each(memberSearchIndex, function(index, item) { + item.category = catMembers; + var s = nestedName(item); + if (exactMatcher.test(s)) { + mresult.push(item); + mCount++; + } else if (camelCaseMatcher.test(s)) { + mresult.push(item); + } else if (secondaryMatcher.test(item.c + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(mresult, secondaryresult)); + displayCount = (mCount > displayCount) ? mCount : displayCount; + } + if (tagSearchIndex) { + var tgCount = 0; + $.each(tagSearchIndex, function(index, item) { + item.category = catSearchTags; + if (exactMatcher.test(item.l)) { + tgresult.push(item); + tgCount++; + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tgresult, secondaryresult)); + displayCount = (tgCount > displayCount) ? tgCount : displayCount; + } + displayCount = (displayCount > 500) ? displayCount : 500; + var counter = function() { + var count = {Modules: 0, Packages: 0, Types: 0, Members: 0, SearchTags: 0}; + var f = function(item) { + count[item.category] += 1; + return (count[item.category] <= displayCount); + }; + return f; + }(); + response(result.filter(counter)); + }, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push(noResult); + } else { + $("#search").empty(); + } + }, + autoFocus: true, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.l !== noResult.l) { + var url = getURLPrefix(ui); + if (ui.item.category === catModules) { + if (useModuleDirectories) { + url += "module-summary.html"; + } else { + url = ui.item.l + "-summary.html"; + } + } else if (ui.item.category === catPackages) { + if (ui.item.url) { + url = ui.item.url; + } else { + url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (ui.item.category === catTypes) { + if (ui.item.url) { + url = ui.item.url; + } else if (ui.item.p === "") { + url += ui.item.l + ".html"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html"; + } + } else if (ui.item.category === catMembers) { + if (ui.item.p === "") { + url += ui.item.c + ".html" + "#"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; + } + if (ui.item.url) { + url += ui.item.url; + } else { + url += ui.item.l; + } + } else if (ui.item.category === catSearchTags) { + url += ui.item.u; + } + if (top !== window) { + parent.classFrame.location = pathtoroot + url; + } else { + window.location.href = pathtoroot + url; + } + $("#search").focus(); + } + } + }); +}); diff --git a/serialized-form.html b/serialized-form.html new file mode 100644 index 000000000..dd598eb58 --- /dev/null +++ b/serialized-form.html @@ -0,0 +1,293 @@ + + + + + +Serialized Form (b2-sdk-core 6.3.0-SNAPSHOT API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Serialized Form

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/stylesheet.css b/stylesheet.css new file mode 100644 index 000000000..de945eda2 --- /dev/null +++ b/stylesheet.css @@ -0,0 +1,910 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:#bb7a2a; +} +a[name] { + color:#353833; +} +a[name]:before, a[name]:target, a[id]:before, a[id]:target { + content:""; + display:inline-block; + position:relative; + padding-top:129px; + margin-top:-129px; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} + +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* + * Styles for navigation bar. + */ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.navPadding { + padding-top: 107px; +} +.fixedNav { + position:fixed; + width:100%; + z-index:999; + background-color:#ffffff; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch { + float:right; + margin:0 0 0 0; + padding:0; +} +ul.navListSearch li { + list-style:none; + float:right; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch li label { + position:relative; + right:-16px; +} +ul.subNavList li { + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Styles for page header and footer. + */ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexNav { + position:relative; + font-size:12px; + background-color:#dee3e9; +} +.indexNav ul { + margin-top:0; + padding:5px; +} +.indexNav ul li { + display:inline; + list-style-type:none; + padding-right:10px; + text-transform:uppercase; +} +.indexNav h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* + * Styles for headings. + */ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* + * Styles for page layout containers. + */ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer, +.allClassesContainer, .allPackagesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* + * Styles for tables. + */ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary, +.requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + width:100%; + border-spacing:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary, .requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption, +.requiresSummary caption, .packagesSummary caption, .providesSummary caption, .usesSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.constantsSummary caption a:link, .constantsSummary caption a:visited, +.useSummary caption a:link, .useSummary caption a:visited { + color:#1f389c; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.deprecatedSummary caption a:link, +.requiresSummary caption a:link, .packagesSummary caption a:link, .providesSummary caption a:link, +.usesSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.requiresSummary caption a:hover, .packagesSummary caption a:hover, .providesSummary caption a:hover, +.usesSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.requiresSummary caption a:active, .packagesSummary caption a:active, .providesSummary caption a:active, +.usesSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.deprecatedSummary caption a:visited, +.requiresSummary caption a:visited, .packagesSummary caption a:visited, .providesSummary caption a:visited, +.usesSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span, +.requiresSummary caption span, .packagesSummary caption span, .providesSummary caption span, +.usesSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span, .packagesSummary caption span.activeTableTab span, +.overviewSummary caption span.activeTableTab span, .typeSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span, .packagesSummary caption span.tableTab span, +.overviewSummary caption span.tableTab span, .typeSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab, +.packagesSummary caption span.tableTab, .packagesSummary caption span.activeTableTab, +.overviewSummary caption span.tableTab, .overviewSummary caption span.activeTableTab, +.typeSummary caption span.tableTab, .typeSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd, +.requiresSummary .tabEnd, .packagesSummary .tabEnd, .providesSummary .tabEnd, .usesSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd, .packagesSummary .activeTableTab .tabEnd, +.overviewSummary .activeTableTab .tabEnd, .typeSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd, .packagesSummary .tableTab .tabEnd, +.overviewSummary .tableTab .tabEnd, .typeSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; +} +.rowColor th, .altColor th { + font-weight:normal; +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td, +.requiresSummary td, .packagesSummary td, .providesSummary td, .usesSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .useSummary th, +.constantsSummary th, .packagesSummary th, td.colFirst, td.colSecond, td.colLast, .useSummary td, +.constantsSummary td { + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .constantsSummary th, +.packagesSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + font-size:13px; +} +td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colDeprecatedItemName, th.colLast { + font-size:13px; +} +.constantsSummary th, .packagesSummary th { + font-size:13px; +} +.providesSummary th.colFirst, .providesSummary th.colLast, .providesSummary td.colFirst, +.providesSummary td.colLast { + white-space:normal; + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.requiresSummary td.colFirst, .requiresSummary th.colFirst, +.packagesSummary td.colFirst, .packagesSummary td.colSecond, .packagesSummary th.colFirst, .packagesSummary th, +.usesSummary td.colFirst, .usesSummary th.colFirst, +.providesSummary td.colFirst, .providesSummary th.colFirst, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colSecond, .memberSummary th.colSecond, .memberSummary th.colConstructorName, +.typeSummary td.colFirst, .typeSummary th.colFirst { + vertical-align:top; +} +.packagesSummary th.colLast, .packagesSummary td.colLast { + white-space:normal; +} +td.colFirst a:link, td.colFirst a:visited, +td.colSecond a:link, td.colSecond a:visited, +th.colFirst a:link, th.colFirst a:visited, +th.colSecond a:link, th.colSecond a:visited, +th.colConstructorName a:link, th.colConstructorName a:visited, +th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited, +.constantValuesContainer td a:link, .constantValuesContainer td a:visited, +.allClassesContainer td a:link, .allClassesContainer td a:visited, +.allPackagesContainer td a:link, .allPackagesContainer td a:visited { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor, .altColor th { + background-color:#FFFFFF; +} +.rowColor, .rowColor th { + background-color:#EEEEEF; +} +/* + * Styles for contents. + */ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +td.colLast div { + padding-top:0px; +} +td.colLast a { + padding-bottom:3px; +} +/* + * Styles for formatting effect. + */ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .implementationLabel, .memberNameLabel, .memberNameLink, +.moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel, .packageLabelInType, +.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, +.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} +.deprecationBlock { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} +div.contentContainer ul.blockList li.blockList h2 { + padding-bottom:0px; +} +/* + * Styles for IFRAME. + */ +.mainContainer { + margin:0 auto; + padding:0; + height:100%; + width:100%; + position:fixed; + top:0; + left:0; +} +.leftContainer { + height:100%; + position:fixed; + width:320px; +} +.leftTop { + position:relative; + float:left; + width:315px; + top:0; + left:0; + height:30%; + border-right:6px solid #ccc; + border-bottom:6px solid #ccc; +} +.leftBottom { + position:relative; + float:left; + width:315px; + bottom:0; + left:0; + height:70%; + border-right:6px solid #ccc; + border-top:1px solid #000; +} +.rightContainer { + position:absolute; + left:320px; + top:0; + bottom:0; + height:100%; + right:0; + border-left:1px solid #000; +} +.rightIframe { + margin:0; + padding:0; + height:100%; + right:30px; + width:100%; + overflow:visible; + margin-bottom:30px; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:#4D7A97; + color:#FFFFFF; +} +.resultItem { + font-size:13px; +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:scroll; + overflow-x:scroll; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:999999; + background-color: #FFFFFF; +} +ul.ui-autocomplete li { + float:left; + clear:both; + width:100%; +} +.resultHighlight { + font-weight:bold; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +#search { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + padding-left:20px; + position:relative; + right:-18px; +} +#reset { + background-color: rgb(255,255,255); + background-image:url('resources/x.png'); + background-position:center; + background-repeat:no-repeat; + background-size:12px; + border:0 none; + width:16px; + height:17px; + position:relative; + left:-4px; + top:-4px; + font-size:0px; +} +.watermark { + color:#545454; +} +.searchTagDescResult { + font-style:italic; + font-size:11px; +} +.searchTagHolderResult { + font-style:italic; + font-size:12px; +} +.searchTagResult:before, .searchTagResult:target { + color:red; +} +.moduleGraph span { + display:none; + position:absolute; +} +.moduleGraph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.methodSignature { + white-space:normal; +} + +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid black; +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid black; +} +table.striped { + border-collapse: collapse; + border: 1px solid black; +} +table.striped > thead { + background-color: #E3E3E3; +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid black; +} +table.striped > tbody > tr:nth-child(even) { + background-color: #EEE +} +table.striped > tbody > tr:nth-child(odd) { + background-color: #FFF +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid black; + border-right: 1px solid black; +} +table.striped > tbody > tr > th { + font-weight: normal; +} diff --git a/type-search-index.js b/type-search-index.js new file mode 100644 index 000000000..a50b0fb7d --- /dev/null +++ b/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"l":"All Classes","url":"allclasses-index.html"},{"p":"com.backblaze.b2.client.structures","l":"B2AccountAuthorization"},{"p":"com.backblaze.b2.client","l":"B2AccountAuthorizer"},{"p":"com.backblaze.b2.client","l":"B2AccountAuthorizerSimpleImpl"},{"p":"com.backblaze.b2.client.structures","l":"B2Allowed"},{"p":"com.backblaze.b2.client","l":"B2AlreadyStoredPartStorer"},{"p":"com.backblaze.b2.client.structures","l":"B2ApplicationKey"},{"p":"com.backblaze.b2.client.structures","l":"B2AuthorizationFilteredResponseField"},{"p":"com.backblaze.b2.client.structures","l":"B2AuthorizeAccountRequest"},{"p":"com.backblaze.b2.client.exceptions","l":"B2BadRequestException"},{"p":"com.backblaze.b2.client.structures","l":"B2Bucket"},{"p":"com.backblaze.b2.client.structures","l":"B2BucketDefaultRetention"},{"p":"com.backblaze.b2.client.structures","l":"B2BucketDefaultRetentionPeriod"},{"p":"com.backblaze.b2.client.structures","l":"B2BucketFileLockConfiguration"},{"p":"com.backblaze.b2.client.structures","l":"B2BucketReplicationConfiguration"},{"p":"com.backblaze.b2.client.structures","l":"B2BucketServerSideEncryption"},{"p":"com.backblaze.b2.client.structures","l":"B2BucketTypes"},{"p":"com.backblaze.b2.client.contentSources","l":"B2ByteArrayContentSource"},{"p":"com.backblaze.b2.util","l":"B2ByteProgressListener"},{"p":"com.backblaze.b2.util","l":"B2ByteRange"},{"p":"com.backblaze.b2.client","l":"B2CancellableContentSource"},{"p":"com.backblaze.b2.client.structures","l":"B2CancelLargeFileRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2CancelLargeFileResponse"},{"p":"com.backblaze.b2.client","l":"B2CancellationToken"},{"p":"com.backblaze.b2.client.exceptions","l":"B2CannotComputeException"},{"p":"com.backblaze.b2.client.structures","l":"B2Capabilities"},{"p":"com.backblaze.b2.client","l":"B2ClientConfig"},{"p":"com.backblaze.b2.util","l":"B2Clock"},{"p":"com.backblaze.b2.util","l":"B2ClockImpl"},{"p":"com.backblaze.b2.util","l":"B2ClockSim"},{"p":"com.backblaze.b2.util","l":"B2Collections"},{"p":"com.backblaze.b2.client.exceptions","l":"B2ConnectFailedException"},{"p":"com.backblaze.b2.client.exceptions","l":"B2ConnectionBrokenException"},{"p":"com.backblaze.b2.client.contentHandlers","l":"B2ContentFileWriter"},{"p":"com.backblaze.b2.client.contentHandlers","l":"B2ContentMemoryWriter"},{"p":"com.backblaze.b2.client.contentHandlers","l":"B2ContentOutputStreamWriter"},{"p":"com.backblaze.b2.client.contentHandlers","l":"B2ContentSink"},{"p":"com.backblaze.b2.client.contentSources","l":"B2ContentSource"},{"p":"com.backblaze.b2.client.contentSources","l":"B2ContentTypes"},{"p":"com.backblaze.b2.client.contentHandlers","l":"B2ContentWriter"},{"p":"com.backblaze.b2.client.structures","l":"B2CopyFileRequest"},{"p":"com.backblaze.b2.client","l":"B2CopyingPartStorer"},{"p":"com.backblaze.b2.client.structures","l":"B2CopyPartRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2CorsRule"},{"p":"com.backblaze.b2.client.structures","l":"B2CreateBucketRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2CreateBucketRequestReal"},{"p":"com.backblaze.b2.client.structures","l":"B2CreatedApplicationKey"},{"p":"com.backblaze.b2.client.structures","l":"B2CreateKeyRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2CreateKeyRequestReal"},{"p":"com.backblaze.b2.client.credentialsSources","l":"B2Credentials"},{"p":"com.backblaze.b2.client.credentialsSources","l":"B2CredentialsFromEnvironmentSource"},{"p":"com.backblaze.b2.client.credentialsSources","l":"B2CredentialsImpl"},{"p":"com.backblaze.b2.client.credentialsSources","l":"B2CredentialsSource"},{"p":"com.backblaze.b2.util","l":"B2DateTimeUtil"},{"p":"com.backblaze.b2.client","l":"B2DefaultRetryPolicy"},{"p":"com.backblaze.b2.client.structures","l":"B2DeleteBucketRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2DeleteBucketRequestReal"},{"p":"com.backblaze.b2.client.structures","l":"B2DeleteFileVersionRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2DeleteFileVersionResponse"},{"p":"com.backblaze.b2.client.structures","l":"B2DeleteKeyRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2DownloadAuthorization"},{"p":"com.backblaze.b2.client.structures","l":"B2DownloadByIdRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2DownloadByNameRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2ErrorStructure"},{"p":"com.backblaze.b2.client.structures","l":"B2EventNotification"},{"p":"com.backblaze.b2.client.structures","l":"B2EventNotificationEvent"},{"p":"com.backblaze.b2.client.structures","l":"B2EventNotificationRule"},{"p":"com.backblaze.b2.client.structures","l":"B2EventNotificationTargetConfiguration"},{"p":"com.backblaze.b2.client.exceptions","l":"B2Exception"},{"p":"com.backblaze.b2.util","l":"B2ExecutorUtils"},{"p":"com.backblaze.b2.client.contentSources","l":"B2FileContentSource"},{"p":"com.backblaze.b2.client","l":"B2FilePolicy"},{"p":"com.backblaze.b2.client.structures","l":"B2FileRetention"},{"p":"com.backblaze.b2.client.structures","l":"B2FileRetentionMode"},{"p":"com.backblaze.b2.client.structures","l":"B2FileRetentionPeriodUnit"},{"p":"com.backblaze.b2.client.structures","l":"B2FileSseForRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2FileSseForResponse"},{"p":"com.backblaze.b2.client.structures","l":"B2FileVersion"},{"p":"com.backblaze.b2.client.structures","l":"B2FinishLargeFileRequest"},{"p":"com.backblaze.b2.util","l":"B2FlushAndSyncFileOnCloseOutputStream"},{"p":"com.backblaze.b2.client.exceptions","l":"B2ForbiddenException"},{"p":"com.backblaze.b2.client.structures","l":"B2GetBucketNotificationRulesRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2GetBucketNotificationRulesResponse"},{"p":"com.backblaze.b2.client.structures","l":"B2GetDownloadAuthorizationRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2GetFileInfoByNameRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2GetFileInfoRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2GetUploadPartUrlRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2GetUploadUrlRequest"},{"p":"com.backblaze.b2.client.contentSources","l":"B2Headers"},{"p":"com.backblaze.b2.client.contentSources","l":"B2HeadersImpl"},{"p":"com.backblaze.b2.client.structures","l":"B2HideFileRequest"},{"p":"com.backblaze.b2.util","l":"B2InputStreamExcerpt"},{"p":"com.backblaze.b2.util","l":"B2InputStreamWithByteProgressListener"},{"p":"com.backblaze.b2.client.exceptions","l":"B2InternalErrorException"},{"p":"com.backblaze.b2.util","l":"B2IoUtils"},{"p":"com.backblaze.b2.json","l":"B2Json"},{"p":"com.backblaze.b2.json","l":"B2JsonAtomicLongArrayHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonBadValueException"},{"p":"com.backblaze.b2.json","l":"B2JsonBigDecimalHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonBigIntegerHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonBooleanArrayHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonBooleanHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonBoundedByteArrayOutputStream"},{"p":"com.backblaze.b2.json","l":"B2JsonByteArrayHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonByteHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonCharacterHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonCharArrayHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonCharSquenceHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonConcurrentMapHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonDoubleArrayHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonDoubleHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonEnumHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonEnumSetHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonException"},{"p":"com.backblaze.b2.json","l":"B2JsonFloatArrayHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonFloatHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonHandlerMap"},{"p":"com.backblaze.b2.json","l":"B2JsonInitializedTypeHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonIntArrayHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonIntegerHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonLinkedHashSetHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonListHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonLocalDateHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonLocalDateTimeHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonLongArrayHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonLongHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonMapHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonNonUrlTypeHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonObjectArrayHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonObjectHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonOptions"},{"p":"com.backblaze.b2.json","l":"B2JsonReader"},{"p":"com.backblaze.b2.json","l":"B2JsonSetHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonStringHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonTreeSetHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonTypeHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonTypeHandlerWithDefaults"},{"p":"com.backblaze.b2.json","l":"B2JsonUnionBaseHandler"},{"p":"com.backblaze.b2.json","l":"B2JsonUnionTypeMap"},{"p":"com.backblaze.b2.json","l":"B2JsonUtil"},{"p":"com.backblaze.b2.json","l":"B2JsonWriter"},{"p":"com.backblaze.b2.client","l":"B2LargeFileStorer"},{"p":"com.backblaze.b2.client.structures","l":"B2LegalHold"},{"p":"com.backblaze.b2.client.structures","l":"B2LifecycleRule"},{"p":"com.backblaze.b2.client.structures","l":"B2ListBucketsRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2ListBucketsResponse"},{"p":"com.backblaze.b2.client","l":"B2ListFileNamesIterable"},{"p":"com.backblaze.b2.client.structures","l":"B2ListFileNamesRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2ListFileNamesResponse"},{"p":"com.backblaze.b2.client","l":"B2ListFilesIterable"},{"p":"com.backblaze.b2.client","l":"B2ListFilesIterableBase"},{"p":"com.backblaze.b2.client.structures","l":"B2ListFilesResponse"},{"p":"com.backblaze.b2.client","l":"B2ListFileVersionsIterable"},{"p":"com.backblaze.b2.client.structures","l":"B2ListFileVersionsRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2ListFileVersionsResponse"},{"p":"com.backblaze.b2.client","l":"B2ListKeysIterable"},{"p":"com.backblaze.b2.client","l":"B2ListKeysIterator"},{"p":"com.backblaze.b2.client.structures","l":"B2ListKeysRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2ListKeysRequestReal"},{"p":"com.backblaze.b2.client.structures","l":"B2ListKeysResponse"},{"p":"com.backblaze.b2.client","l":"B2ListPartsIterable"},{"p":"com.backblaze.b2.client","l":"B2ListPartsIterableBase"},{"p":"com.backblaze.b2.client","l":"B2ListPartsIterableImpl"},{"p":"com.backblaze.b2.client.structures","l":"B2ListPartsRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2ListPartsResponse"},{"p":"com.backblaze.b2.client","l":"B2ListUnfinishedLargeFilesIterable"},{"p":"com.backblaze.b2.client.structures","l":"B2ListUnfinishedLargeFilesRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2ListUnfinishedLargeFilesResponse"},{"p":"com.backblaze.b2.client.exceptions","l":"B2LocalException"},{"p":"com.backblaze.b2.util","l":"B2Md5"},{"p":"com.backblaze.b2.client.exceptions","l":"B2NetworkBaseException"},{"p":"com.backblaze.b2.client.exceptions","l":"B2NetworkException"},{"p":"com.backblaze.b2.client.exceptions","l":"B2NetworkTimeoutException"},{"p":"com.backblaze.b2.client.exceptions","l":"B2NotFoundException"},{"p":"com.backblaze.b2.client.structures","l":"B2OverrideableHeaders"},{"p":"com.backblaze.b2.client.structures","l":"B2Part"},{"p":"com.backblaze.b2.client","l":"B2PartSpec"},{"p":"com.backblaze.b2.client","l":"B2PartStorer"},{"p":"com.backblaze.b2.util","l":"B2Preconditions"},{"p":"com.backblaze.b2.client.structures","l":"B2ReplicationRule"},{"p":"com.backblaze.b2.client.structures","l":"B2ReplicationStatus"},{"p":"com.backblaze.b2.client.exceptions","l":"B2RequestTimeoutException"},{"p":"com.backblaze.b2.client","l":"B2RetryPolicy"},{"p":"com.backblaze.b2.client.exceptions","l":"B2RuntimeException"},{"p":"com.backblaze.b2.client","l":"B2Sdk"},{"p":"com.backblaze.b2.client.structures","l":"B2ServerSideEncryptionMode"},{"p":"com.backblaze.b2.client.exceptions","l":"B2ServiceUnavailableException"},{"p":"com.backblaze.b2.client.structures","l":"B2SetBucketNotificationRulesRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2SetBucketNotificationRulesResponse"},{"p":"com.backblaze.b2.util","l":"B2Sha1"},{"p":"com.backblaze.b2.util","l":"B2Sha1AppenderInputStream"},{"p":"com.backblaze.b2.util","l":"B2Sha1InputStream"},{"p":"com.backblaze.b2.client.exceptions","l":"B2SignatureVerificationException"},{"p":"com.backblaze.b2.client.structures","l":"B2StartLargeFileRequest"},{"p":"com.backblaze.b2.client","l":"B2StorageClient"},{"p":"com.backblaze.b2.client","l":"B2StorageClientFactory"},{"p":"com.backblaze.b2.client","l":"B2StorageClientFactoryPathBasedImpl"},{"p":"com.backblaze.b2.client","l":"B2StorageClientImpl"},{"p":"com.backblaze.b2.client","l":"B2StorageClientWebifier"},{"p":"com.backblaze.b2.client","l":"B2StorageClientWebifierImpl"},{"p":"com.backblaze.b2.client.structures","l":"B2StoreLargeFileRequest"},{"p":"com.backblaze.b2.util","l":"B2StringUtil"},{"p":"com.backblaze.b2.client.structures","l":"B2TestMode"},{"p":"com.backblaze.b2.client.exceptions","l":"B2TooManyRequestsException"},{"p":"com.backblaze.b2.json","l":"B2TypeResolver"},{"p":"com.backblaze.b2.client.exceptions","l":"B2UnauthorizedException"},{"p":"com.backblaze.b2.client.structures","l":"B2UpdateBucketRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2UpdateFileLegalHoldRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2UpdateFileLegalHoldResponse"},{"p":"com.backblaze.b2.client.structures","l":"B2UpdateFileRetentionRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2UpdateFileRetentionResponse"},{"p":"com.backblaze.b2.client.structures","l":"B2UploadFileRequest"},{"p":"com.backblaze.b2.client","l":"B2UploadingPartStorer"},{"p":"com.backblaze.b2.client.structures","l":"B2UploadListener"},{"p":"com.backblaze.b2.client.structures","l":"B2UploadPartRequest"},{"p":"com.backblaze.b2.client.structures","l":"B2UploadPartUrlResponse"},{"p":"com.backblaze.b2.client.structures","l":"B2UploadProgress"},{"p":"com.backblaze.b2.client.structures","l":"B2UploadState"},{"p":"com.backblaze.b2.client.structures","l":"B2UploadUrlResponse"},{"p":"com.backblaze.b2.util","l":"B2Utf8Util"},{"p":"com.backblaze.b2.client.webApiClients","l":"B2WebApiClient"},{"p":"com.backblaze.b2.client.structures","l":"B2WebhookConfiguration"},{"p":"com.backblaze.b2.client.structures","l":"B2WebhookCustomHeader"},{"p":"com.backblaze.b2.client","l":"B2AccountAuthorizerSimpleImpl.Builder"},{"p":"com.backblaze.b2.client","l":"B2ClientConfig.Builder"},{"p":"com.backblaze.b2.client.contentHandlers","l":"B2ContentFileWriter.Builder"},{"p":"com.backblaze.b2.client.contentHandlers","l":"B2ContentMemoryWriter.Builder"},{"p":"com.backblaze.b2.client.contentHandlers","l":"B2ContentOutputStreamWriter.Builder"},{"p":"com.backblaze.b2.client.contentSources","l":"B2ByteArrayContentSource.Builder"},{"p":"com.backblaze.b2.client.contentSources","l":"B2FileContentSource.Builder"},{"p":"com.backblaze.b2.client.contentSources","l":"B2HeadersImpl.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2AuthorizeAccountRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2CancelLargeFileRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2CopyFileRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2CopyPartRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2CorsRule.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2CreateBucketRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2CreateKeyRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2DeleteBucketRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2DeleteFileVersionRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2DeleteKeyRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2DownloadByIdRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2DownloadByNameRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2FinishLargeFileRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2GetBucketNotificationRulesRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2GetBucketNotificationRulesResponse.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2GetDownloadAuthorizationRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2GetFileInfoByNameRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2GetFileInfoRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2GetUploadPartUrlRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2GetUploadUrlRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2HideFileRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2LifecycleRule.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2ListBucketsRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2ListFileNamesRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2ListFileVersionsRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2ListKeysRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2ListPartsRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2ListUnfinishedLargeFilesRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2SetBucketNotificationRulesRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2SetBucketNotificationRulesResponse.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2StartLargeFileRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2StoreLargeFileRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2UpdateBucketRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2UpdateFileLegalHoldRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2UpdateFileRetentionRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2UploadFileRequest.Builder"},{"p":"com.backblaze.b2.client.structures","l":"B2UploadPartRequest.Builder"},{"p":"com.backblaze.b2.json","l":"B2JsonOptions.Builder"},{"p":"com.backblaze.b2.json","l":"B2JsonUnionTypeMap.Builder"},{"p":"com.backblaze.b2.json","l":"B2Json.constructor"},{"p":"com.backblaze.b2.json","l":"B2Json.defaultForInvalidEnumValue"},{"p":"com.backblaze.b2.json","l":"B2Json.defaultForUnknownType"},{"p":"com.backblaze.b2.json","l":"B2JsonOptions.ExtraFieldOption"},{"p":"com.backblaze.b2.json","l":"FieldInfo"},{"p":"com.backblaze.b2.json","l":"FieldInfo.FieldRequirement"},{"p":"com.backblaze.b2.json","l":"B2Json.firstVersion"},{"p":"com.backblaze.b2.client.contentHandlers","l":"B2ContentOutputStreamWriter.Helper"},{"p":"com.backblaze.b2.json","l":"B2Json.ignored"},{"p":"com.backblaze.b2.client","l":"B2ListFilesIterableBase.IterBase"},{"p":"com.backblaze.b2.client","l":"B2ListPartsIterableBase.IterBase"},{"p":"com.backblaze.b2.json","l":"B2Json.optional"},{"p":"com.backblaze.b2.json","l":"B2Json.optionalWithDefault"},{"p":"com.backblaze.b2.client.exceptions","l":"B2UnauthorizedException.RequestCategory"},{"p":"com.backblaze.b2.json","l":"B2Json.required"},{"p":"com.backblaze.b2.json","l":"B2Json.sensitive"},{"p":"com.backblaze.b2.json","l":"B2JsonOptions.SerializationOption"},{"p":"com.backblaze.b2.json","l":"B2Json.serializedName"},{"p":"com.backblaze.b2.json","l":"B2Json.type"},{"p":"com.backblaze.b2.json","l":"B2Json.unionSubtypes.type"},{"p":"com.backblaze.b2.json","l":"B2Json.union"},{"p":"com.backblaze.b2.json","l":"B2Json.unionSubtypes"},{"p":"com.backblaze.b2.json","l":"B2Json.versionRange"},{"p":"com.backblaze.b2.json","l":"VersionRange"}] \ No newline at end of file diff --git a/type-search-index.zip b/type-search-index.zip new file mode 100644 index 0000000000000000000000000000000000000000..28c2e0b1823239fecdd81e7a0ede05f4bd50aaa1 GIT binary patch literal 2328 zcmZveYd8}O8^;%7Aw~|<96~vtG89q|skA+6&R)l`(adQiq9kcEq!`Ie6mp(X79%64 zhQvt2C?p=|#?Wwt=GOIHvfS8p6&|D> zPG#ozFHa|7Tx=h~axhE6yM*s0SIJ&G5wY^PURK|TiiF4&E8p@RmD*pZio*<`wW2*X z#{$?Hz)#KjVLmO+^K!M0Oi?v?>(EAeDRp5!VEYulck{(pRh$$i+}g7SS<*bRpJ88E zaVG9QPnhiF)s`^x&ZM3FIbl8w7Q^>Jx-1+1Ou?w$VQtKndC>d&C^NZl`q`vGv7pMu zf>YQ14sqVQhVtWAQMsc5ch+4mFHYFZm{C+{f_ioSW7w@9v*?D&7iw{=K=eZ9_*(CL zV=7Jgj(_-w-4KBYhRWRs1?jcaP-e|3$nleJ1;{#-&N(Zsy~L=BFyW@sQ*-%3x{9q< zMTUNLS0eZ=ulV%Zo6IIaCe9V7y_o7^naJbs>QvtO*);Z6%J|D0k*5m_Fkn)TSn=lD z3|6;#Z(7{c#E;p_+>xx#oUdYIBV1h~0pO`R6+wPlO@iR1>+mkYKDN`gC?#r7TiP%}1y zyv7I_tmtn)!>_vZ0PZN+tgmb7EYG2+ww2k{jPFl%rV=VoPCjBB1wsb`@2H;g&~D&T zFR9Z8v7Lu!>TKz>JG^(F4chRO;b@N3!Vv9l9AQp}%95q|!wE;+V{dE%q<@}-&4B689hchBzQqut<7k64O* zhNU5UnlztSWFN78Hfe}ed#*K8d$bJlp0Be~1g3Nz9_;D%PAgf}FiS+b$;{E!C-Xna zw(T2jf2JrS6rV!%)?{20x?UNW8fV1y97!0looQ|Ax4HoXHHW`iPg%)(^SNy4sBVtN zO^IfaF~=<(v^TV8l(FYBd@!Ub20cXTih}8-9GhDRQGKZ1N>_;8=qiCx)eq(~V=~ z9Lg(^WXwYe^Cv%hs-4ct4qegf;L#yD)#!4dsHKeoo8W0LTH`KU#Rw{)w#_M%Mm@Cy z67Jp?@Jr_vyM49_QXA16$L9x2@fh^3;pW6u}u7;fwG9d?hCmp-p;O1*;Pif8$(?kq468-;xe=RBYTZPfD>JdNIH2xzNk-G< zaZ4vqx{sQAF=454IEwDLxqJ%{+%d~yzu4<}n8C{|e{vSn6BbE-f+;hvjTVJ6O;Tld z@-1nPBY+_ z*PLWGG%e9kA?qcH%I2{#zIjvX{?7H*C-h=-Zc2LY2uGMpDGG6%jU#29w{K2)V&zn@ z%=AF*oeml6NCSP?IJDv8FXnC4HgGM~nbMBCY3{Eu#+!aj)oszS#o5H^ob0$H_3M2{ zztKdz{RT2Sd|%d2l{mGy8)-Z2jUfr zgj!RI?~iH~oQg9e4V*l(3wxKn$n9{^s7p5m3s)ZRJ6*_OG>Tf%?w*mcuDn|#kz5|V zV&J%=a1m6vqkQ4?^3y_vcY#c_c$e|UXj=}y@tYjGv!av?b1+}fN9bW??)NC3Ms$M% zuqbLKR`7-U##td>vGbT7egy$j(dFaXPywgLFNgW_CN^-aE7flJuX!A4oQk%K|MSxM z89R-N=}|R-aY)0i-D((q_$XV1pJq+6iq~x=hIzPyP~ds=rfO=8Bn^na6>Rwtg_X$s zB(IVnFRqHpr5hd~)fWAkNz$;$f~Z9&pvx|JoqlLY3}sRF*&wSo}QL_pnT-;u5)qO|L@DcEDbF(aDYqg#$y#W6+RooUe(*oC=!mx^qTn z7V&yw#$);=^AdWu_jYC>F=gF!-jGD{AU_IwWe$wm&&f|-hTE=w+(*ELfZUDn$QU31 sfVBkx5by(hQh@*Z%fGvS{N;c7|2Bhw9~AuO?!fP{{=J)j{{{g524SObT>t<8 literal 0 HcmV?d00001