Class DefaultSettingsWriter

  • All Implemented Interfaces:
    SettingsWriter

    @Named
    @Singleton
    public class DefaultSettingsWriter
    extends java.lang.Object
    implements SettingsWriter
    Handles serialization of settings into the default textual format.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void write​(java.io.File output, java.util.Map<java.lang.String,​java.lang.Object> options, Settings settings)
      Writes the supplied settings to the specified file.
      void write​(java.io.OutputStream output, java.util.Map<java.lang.String,​java.lang.Object> options, Settings settings)
      Writes the supplied settings to the specified byte stream.
      void write​(java.io.Writer output, java.util.Map<java.lang.String,​java.lang.Object> options, Settings settings)
      Writes the supplied settings to the specified character writer.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DefaultSettingsWriter

        public DefaultSettingsWriter()
    • Method Detail

      • write

        public void write​(java.io.File output,
                          java.util.Map<java.lang.String,​java.lang.Object> options,
                          Settings settings)
                   throws java.io.IOException
        Description copied from interface: SettingsWriter
        Writes the supplied settings to the specified file. Any non-existing parent directories of the output file will be created automatically.
        Specified by:
        write in interface SettingsWriter
        Parameters:
        output - The file to serialize the settings to, must not be null.
        options - The options to use for serialization, may be null to use the default values.
        settings - The settings to serialize, must not be null.
        Throws:
        java.io.IOException - If the settings could not be serialized.
      • write

        public void write​(java.io.Writer output,
                          java.util.Map<java.lang.String,​java.lang.Object> options,
                          Settings settings)
                   throws java.io.IOException
        Description copied from interface: SettingsWriter
        Writes the supplied settings to the specified character writer. The writer will be automatically closed before the method returns.
        Specified by:
        write in interface SettingsWriter
        Parameters:
        output - The writer to serialize the settings to, must not be null.
        options - The options to use for serialization, may be null to use the default values.
        settings - The settings to serialize, must not be null.
        Throws:
        java.io.IOException - If the settings could not be serialized.
      • write

        public void write​(java.io.OutputStream output,
                          java.util.Map<java.lang.String,​java.lang.Object> options,
                          Settings settings)
                   throws java.io.IOException
        Description copied from interface: SettingsWriter
        Writes the supplied settings to the specified byte stream. The stream will be automatically closed before the method returns.
        Specified by:
        write in interface SettingsWriter
        Parameters:
        output - The stream to serialize the settings to, must not be null.
        options - The options to use for serialization, may be null to use the default values.
        settings - The settings to serialize, must not be null.
        Throws:
        java.io.IOException - If the settings could not be serialized.