blob: fe68fe63d7dcc756219bfb6e76389322d243d338 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2013 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* Mikael Barbero (mikael.barbero@obeo.fr) - Adapted for EMF Compare
*******************************************************************************/
package org.eclipse.emf.compare.rcp.ui.contentmergeviewer.accessor.legacy;
import java.io.InputStream;
import org.eclipse.core.runtime.CoreException;
/**
* An <code>IStreamContentAccessor</code> object represents a set of bytes which can be accessed by means of a
* stream.
* <p>
* Clients may implement this interface, or use the standard implementation, <code>BufferedContent</code>.
* </p>
* <p>
* This was initially copy pasted from org.eclipse.compare.IStreamContentAccessor
* </p>
*
* @see BufferedContent
* @author <a href="mailto:xyz@xyz.com">Ibm Corporation</a>
* @since 4.0
*/
public interface IStreamContentAccessor {
/**
* Returns an open <code>InputStream</code> for this object which can be used to retrieve the object's
* content. The client is responsible for closing the stream when finished. Returns <code>null</code> if
* this object has no streamable contents.
*
* @return an input stream containing the contents of this object
* @exception CoreException
* if the contents of this object could not be accessed
*/
InputStream getContents() throws CoreException;
}