com.google.api.client.http.HttpContent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-client Show documentation

Google API Client Library for Java. Supports Java 5 (or higher) desktop (SE) and web (EE), Android, and Google App Engine.

There is a newer version: 1.4.1-beta

Show newest version

/*
 * Copyright (c) 2010 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.http;

import java.io.IOException;
import java.io.OutputStream;

/**
 * Serializes HTTP request content into an output stream.
 *
 * @since 1.0
 * @author Yaniv Inbar
 */
public interface HttpContent {

  /**
   * Returns the content length or less than zero if not known.
   *
   * @throws IOException
   */
  long getLength() throws IOException;

  /**
   * Returns the content encoding (for example {@code "gzip"}) or {@code null} for none.
   */
  String getEncoding();

  /**
   * Returns the content type or {@code null} for none.
   * 
   * Upgrade warning: prior to version 1.3 this could never return {@code null}, but now it is a
   * possible return value.
   * 
   */
  String getType();

  /**
   * Writes the content to the given output stream.
   *
   * @throws IOException
   */
  void writeTo(OutputStream out) throws IOException;
}