michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.entity;
michael@0: 
michael@0: import java.io.IOException;
michael@0: import java.io.InputStream;
michael@0: import java.io.OutputStream;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.Header;
michael@0: import ch.boye.httpclientandroidlib.HttpEntity;
michael@0: 
michael@0: /**
michael@0:  * Base class for wrapping entities.
michael@0:  * Keeps a {@link #wrappedEntity wrappedEntity} and delegates all
michael@0:  * calls to it. Implementations of wrapping entities can derive
michael@0:  * from this class and need to override only those methods that
michael@0:  * should not be delegated to the wrapped entity.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public class HttpEntityWrapper implements HttpEntity {
michael@0: 
michael@0:     /** The wrapped entity. */
michael@0:     protected HttpEntity wrappedEntity;
michael@0: 
michael@0:     /**
michael@0:      * Creates a new entity wrapper.
michael@0:      *
michael@0:      * @param wrapped   the entity to wrap, not null
michael@0:      * @throws IllegalArgumentException if wrapped is null
michael@0:      */
michael@0:     public HttpEntityWrapper(HttpEntity wrapped) {
michael@0:         super();
michael@0: 
michael@0:         if (wrapped == null) {
michael@0:             throw new IllegalArgumentException
michael@0:                 ("wrapped entity must not be null");
michael@0:         }
michael@0:         wrappedEntity = wrapped;
michael@0: 
michael@0:     } // constructor
michael@0: 
michael@0: 
michael@0:     public boolean isRepeatable() {
michael@0:         return wrappedEntity.isRepeatable();
michael@0:     }
michael@0: 
michael@0:     public boolean isChunked() {
michael@0:         return wrappedEntity.isChunked();
michael@0:     }
michael@0: 
michael@0:     public long getContentLength() {
michael@0:         return wrappedEntity.getContentLength();
michael@0:     }
michael@0: 
michael@0:     public Header getContentType() {
michael@0:         return wrappedEntity.getContentType();
michael@0:     }
michael@0: 
michael@0:     public Header getContentEncoding() {
michael@0:         return wrappedEntity.getContentEncoding();
michael@0:     }
michael@0: 
michael@0:     public InputStream getContent()
michael@0:         throws IOException {
michael@0:         return wrappedEntity.getContent();
michael@0:     }
michael@0: 
michael@0:     public void writeTo(OutputStream outstream)
michael@0:         throws IOException {
michael@0:         wrappedEntity.writeTo(outstream);
michael@0:     }
michael@0: 
michael@0:     public boolean isStreaming() {
michael@0:         return wrappedEntity.isStreaming();
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @deprecated Either use {@link #getContent()} and call {@link java.io.InputStream#close()} on that;
michael@0:      * otherwise call {@link #writeTo(OutputStream)} which is required to free the resources.
michael@0:      */
michael@0:     public void consumeContent() throws IOException {
michael@0:         wrappedEntity.consumeContent();
michael@0:     }
michael@0: 
michael@0: }