initial version of support project with build support.

[utils] / src / org / wamblee / io / InputResource.java

diff --git a/src/org/wamblee/io/InputResource.java b/src/org/wamblee/io/InputResource.java
new file mode 100644 (file)
index 0000000..aa4fb91
--- /dev/null
+++ b/src/org/wamblee/io/InputResource.java
@@ -0,0 +1,34 @@
+/*
+ * Copyright 2005 the original author or authors.
+ * 
+ * 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.wamblee.io;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+
+/**
+ * Represents a resource from which information can be read.
+ */
+public interface InputResource {
+    /**
+     * Gets the input stream to the resource. The obtained input stream 
+     * must be closed once reading has finished. 
+     * 
+     * @return Input stream to the resource, never null.
+     * @throws IOException in case the resource cannot be found.
+     */
+    InputStream getInputStream(  ) throws IOException;
+}