1/*
2 * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/entity/ByteArrayEntity.java $
3 * $Revision: 604625 $
4 * $Date: 2007-12-16 06:11:11 -0800 (Sun, 16 Dec 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.ByteArrayInputStream;
35import java.io.IOException;
36import java.io.InputStream;
37import java.io.OutputStream;
38
39/**
40 *  An entity whose content is retrieved from a byte array.
41 *
42 * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
43 *
44 * @version $Revision: 604625 $
45 *
46 * @since 4.0
47 */
48public class ByteArrayEntity extends AbstractHttpEntity implements Cloneable {
49
50    protected final byte[] content;
51
52    public ByteArrayEntity(final byte[] b) {
53        super();
54        if (b == null) {
55            throw new IllegalArgumentException("Source byte array may not be null");
56        }
57        this.content = b;
58    }
59
60    public boolean isRepeatable() {
61        return true;
62    }
63
64    public long getContentLength() {
65        return this.content.length;
66    }
67
68    public InputStream getContent() {
69        return new ByteArrayInputStream(this.content);
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        outstream.write(this.content);
77        outstream.flush();
78    }
79
80
81    /**
82     * Tells that this entity is not streaming.
83     *
84     * @return <code>false</code>
85     */
86    public boolean isStreaming() {
87        return false;
88    }
89
90    public Object clone() throws CloneNotSupportedException {
91        return super.clone();
92    }
93
94} // class ByteArrayEntity
95