EntityTemplate.java revision 069490a5ca2fd1988d29daf45d892f47ad665115
1/*
2 * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/entity/EntityTemplate.java $
3 * $Revision: 496070 $
4 * $Date: 2007-01-14 04:18:34 -0800 (Sun, 14 Jan 2007) $
5 *
6 * ====================================================================
7 * Licensed to the Apache Software Foundation (ASF) under one
8 * or more contributor license agreements.  See the NOTICE file
9 * distributed with this work for additional information
10 * regarding copyright ownership.  The ASF licenses this file
11 * to you under the Apache License, Version 2.0 (the
12 * "License"); you may not use this file except in compliance
13 * with the License.  You may obtain a copy of the License at
14 *
15 *   http://www.apache.org/licenses/LICENSE-2.0
16 *
17 * Unless required by applicable law or agreed to in writing,
18 * software distributed under the License is distributed on an
19 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20 * KIND, either express or implied.  See the License for the
21 * specific language governing permissions and limitations
22 * under the License.
23 * ====================================================================
24 *
25 * This software consists of voluntary contributions made by many
26 * individuals on behalf of the Apache Software Foundation.  For more
27 * information on the Apache Software Foundation, please see
28 * <http://www.apache.org/>.
29 *
30 */
31
32package org.apache.http.entity;
33
34import java.io.IOException;
35import java.io.InputStream;
36import java.io.OutputStream;
37
38/**
39 * Entity that delegates the process of content generation to an abstract
40 * content producer.
41 *
42 * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
43 *
44 * @version $Revision: 496070 $
45 *
46 * @since 4.0
47 */
48public class EntityTemplate extends AbstractHttpEntity {
49
50    private final ContentProducer contentproducer;
51
52    public EntityTemplate(final ContentProducer contentproducer) {
53        super();
54        if (contentproducer == null) {
55            throw new IllegalArgumentException("Content producer may not be null");
56        }
57        this.contentproducer = contentproducer;
58    }
59
60    public long getContentLength() {
61        return -1;
62    }
63
64    public InputStream getContent() {
65        throw new UnsupportedOperationException("Entity template does not implement getContent()");
66    }
67
68    public boolean isRepeatable() {
69        return true;
70    }
71
72    public void writeTo(final OutputStream outstream) throws IOException {
73        if (outstream == null) {
74            throw new IllegalArgumentException("Output stream may not be null");
75        }
76        this.contentproducer.writeTo(outstream);
77    }
78
79    public boolean isStreaming() {
80        return true;
81    }
82
83    public void consumeContent() throws IOException {
84    }
85
86}
87