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 stream.
31 *
32 * @return the length of the stream in bytes or <code>-1</code> if the
33 * length is unknown
34 */
35 long getLength();
36
37 /**
38 * Returns the length of stream.
39 *
40 * @return the length of the stream in bytes or <code>null</code> if the
41 * length is unknown
42 */
43 BigInteger getBigLength();
44
45 /**
46 * Returns the MIME type of the stream.
47 *
48 * @return the MIME type of the stream or <code>null</code> if the MIME type
49 * is unknown
50 */
51 String getMimeType();
52
53 /**
54 * Returns the file name of the stream.
55 *
56 * @return the file name of the stream or <code>null</code> if the file name
57 * is unknown
58 */
59 String getFileName();
60
61 /**
62 * Returns the stream.
63 *
64 * It is important to close this stream properly!
65 */
66 InputStream getStream();
67 }