svn commit: r1463671 - /commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/InputStreamSupport.java

[oh...@apache.org]

Author: oheger
Date: Tue Apr  2 18:58:58 2013
New Revision: 1463671

URL: http://svn.apache.org/r1463671
Log:
Added new InputStreamSupport interface for reading configuration data from an
InputStream rather than a reader.

Added:
    commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/InputStreamSupport.java

Added: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/InputStreamSupport.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/InputStreamSupport.java?rev=1463671&view=auto
==============================================================================
--- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/InputStreamSupport.java (added)
+++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/InputStreamSupport.java Tue Apr  2 18:58:58 2013
@@ -0,0 +1,54 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.commons.configuration.io;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import org.apache.commons.configuration.ConfigurationException;
+
+/**
+ * <p>
+ * Definition of an interface to be implemented by objects which support reading
+ * from an input stream.
+ * </p>
+ * <p>
+ * When reading data using a {@link FileHandler} per default a reader is used as
+ * defined by the {@link FileBased#read(java.io.Reader)} method. For some
+ * configuration formats it is necessary to directly read binary data. In order
+ * to achieve this, a {@link FileBased} object can also implement this
+ * interface. It defines an additional {@code read()} method expecting an
+ * {@code InputStream} as argument. If the {@code FileHandler} detects that its
+ * associated {@code FileBased} object implements this interface, it passes the
+ * input stream directly rather than transforming it to a reader.
+ * </p>
+ *
+ * @version $Id: $
+ * @since 2.0
+ */
+public interface InputStreamSupport
+{
+    /**
+     * Reads the content of this object from the specified {@code InputStream}.
+     *
+     * @param in the input stream
+     * @throws ConfigurationException if a non-I/O related problem occurs, e.g.
+     *         the data read does not have the expected format
+     * @throws IOException if an I/O error occurs
+     */
+    void read(InputStream in) throws ConfigurationException, IOException;
+}