1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.chemistry.opencmis.commons.data;
20
21 import java.io.InputStream;
22 import java.math.BigInteger;
23
24 /**
25 * Content stream.
26 */
27 public interface ContentStream extends ExtensionsData {
28
29 /**
30 * Returns the length of the stream.
31 *
32 * @return the length of the stream in bytes or -1 if the length is unknown
33 */
34 long getLength();
35
36 /**
37 * Returns the length of the stream.
38 *
39 * @return the length of the stream in bytes or {@code null} if the length
40 * is unknown
41 */
42 BigInteger getBigLength();
43
44 /**
45 * Returns the MIME type of the stream.
46 *
47 * @return the MIME type of the stream or {@code null} if the MIME type is
48 * unknown
49 */
50 String getMimeType();
51
52 /**
53 * Returns the file name of the stream.
54 *
55 * @return the file name of the stream or {@code null} if the file name is
56 * unknown
57 */
58 String getFileName();
59
60 /**
61 * Returns the stream.
62 * <p>
63 * It is important to close this stream properly!
64 *
65 * @return the stream
66 */
67 InputStream getStream();
68 }