org.flowable.content.api.ContentObject Maven / Gradle / Ivy

Go to download
/* Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.flowable.content.api;

import java.io.InputStream;

/**
 * @author Frederik Heremans
 */
public interface ContentObject {

    /**
     * @return a unique identifier for this instance.
     */
    String getId();

    /**
     * @return the size of the content, in bytes.
     */
    long getContentLength();

    /**
     * @return the inputstream to read the content from. Multiple calls to this method on the same instance should return the same {@link InputStream} instance. Caller should close the inputstream
     *         after usage to prevent resources leaking.
     */
    InputStream getContent();
}