com.google.appengine.repackaged.com.google.api.client.googleapis.media.MediaHttpUploaderProgressListener Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of appengine-api-1.0-sdk
Show all versions of appengine-api-1.0-sdk
API for Google App Engine standard environment with some of the dependencies shaded (repackaged)
/*
* Copyright 2011 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.api.client.googleapis.media;
import java.io.IOException;
/**
* An interface for receiving progress notifications for uploads.
*
* Sample usage (if media content length is provided, else consider using {@link
* MediaHttpUploader#getNumBytesUploaded} instead of {@link MediaHttpUploader#getProgress}:
*
*
* public static class MyUploadProgressListener implements MediaHttpUploaderProgressListener {
*
* public void progressChanged(MediaHttpUploader uploader) throws IOException {
* switch (uploader.getUploadState()) {
* case INITIATION_STARTED:
* System.out.println("Initiation Started");
* break;
* case INITIATION_COMPLETE:
* System.out.println("Initiation Completed");
* break;
* case MEDIA_IN_PROGRESS:
* System.out.println("Upload in progress");
* System.out.println("Upload percentage: " + uploader.getProgress());
* break;
* case MEDIA_COMPLETE:
* System.out.println("Upload Completed!");
* break;
* }
* }
* }
*
*
* @since 1.9
* @author [email protected] (Ravi Mistry)
*/
public interface MediaHttpUploaderProgressListener {
/**
* Called to notify that progress has been changed.
*
* This method is called once before and after the initiation request. For media uploads it is
* called multiple times depending on how many chunks are uploaded. Once the upload completes it
* is called one final time.
*
*
The upload state can be queried by calling {@link MediaHttpUploader#getUploadState} and the
* progress by calling {@link MediaHttpUploader#getProgress}.
*
* @param uploader Media HTTP uploader
*/
public void progressChanged(MediaHttpUploader uploader) throws IOException;
}