Package org.apache.felix.cm.json.io
Interface ConfigurationReader
-
@ProviderType public interface ConfigurationReader
A configuration reader can read configuration resources as defined in OSGi Configurator specificiation. A reader can be obtained through aConfigurationReader.Builder
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
ConfigurationReader.BinaryHandler
Handler for binary propertiesstatic interface
ConfigurationReader.Builder
Builder to create a reader.static interface
ConfigurationReader.ConfiguratorPropertyHandler
Handler for configurator properties
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<java.lang.String>
getIgnoredErrors()
After reading a configuration (resource) this method will return a list of ignored errors.java.util.Hashtable<java.lang.String,java.lang.Object>
readConfiguration()
Read a single configuration from the provided reader.ConfigurationResource
readConfigurationResource()
Read a configuration resource from the provided reader.
-
-
-
Method Detail
-
readConfiguration
java.util.Hashtable<java.lang.String,java.lang.Object> readConfiguration() throws java.io.IOException
Read a single configuration from the provided reader. The reader is not closed.getIgnoredErrors()
can be used after reading if any ignored errors occurred during processing the configuration.- Returns:
- The read configuration.
- Throws:
java.io.IOException
- If reading fails
-
readConfigurationResource
ConfigurationResource readConfigurationResource() throws java.io.IOException
Read a configuration resource from the provided reader. The reader is not closed.getIgnoredErrors()
can be used after reading if any ignored errors occurred during processing the resource.- Returns:
- The read configurations.
- Throws:
java.io.IOException
- If reading fails
-
getIgnoredErrors
java.util.List<java.lang.String> getIgnoredErrors()
After reading a configuration (resource) this method will return a list of ignored errors.- Returns:
- List of ignored errors, might be empty.
-
-