Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'bundles/org.eclipse.compare/compare/org/eclipse/compare/IStreamContentAccessor.java')
-rw-r--r--bundles/org.eclipse.compare/compare/org/eclipse/compare/IStreamContentAccessor.java36
1 files changed, 36 insertions, 0 deletions
diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/IStreamContentAccessor.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/IStreamContentAccessor.java
new file mode 100644
index 000000000..847639a44
--- /dev/null
+++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/IStreamContentAccessor.java
@@ -0,0 +1,36 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2011 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
+ *******************************************************************************/
+package org.eclipse.compare;
+
+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>.
+ *
+ * @see BufferedContent
+ */
+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;
+}

Back to the top