com.cedarsoft.configuration.ConfigurationPersister Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of configuration Show documentation
The newest version!
/**
 * Copyright (C) cedarsoft GmbH.
 *
 * Licensed under the GNU General Public License version 3 (the "License")
 * with Classpath Exception; you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *         http://www.cedarsoft.org/gpl3ce
 *         (GPL 3 with Classpath Exception)
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 3 only, as
 * published by the Free Software Foundation. cedarsoft GmbH designates this
 * particular file as subject to the "Classpath" exception as provided
 * by cedarsoft GmbH in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 3 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 3 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact cedarsoft GmbH, 72810 Gomaringen, Germany,
 * or visit www.cedarsoft.com if you need additional information or
 * have any questions.
 */

package com.cedarsoft.configuration;


import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import java.io.BufferedInputStream;
import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.io.Reader;
import java.io.Writer;
import java.lang.String;
import java.nio.charset.Charset;
import java.util.List;

/**
 * ConfigurationPersister interface.
 *
 * @author Johannes Schneider ([email protected])
 */
public interface ConfigurationPersister {
  /**
   * Persists the configurations for the given configuration manager
   *
   * @param configurationManager the configuration manager
   * @param out                  the writer the configuration is written to
   * @throws IOException if any.
   */
  void persist( @Nonnull ConfigurationManager configurationManager, @Nonnull Writer out ) throws IOException;

  /**
   * Persists the given configurations
   *
   * @param configurations the configurations
   * @param out            the writer the configurations are written to
   * @throws IOException if any.
   */
  void persist( @Nonnull List configurations, @Nonnull Writer out ) throws IOException;

  /**
   * Persiste the configurations of the given manager
   *
   * @param manager the manager the configurations are persisted of
   * @return the persisted configurations as string
   *
   * @throws IOException if any.
   */
  @Deprecated
  @Nonnull
  String persist( @Nonnull ConfigurationManager manager ) throws IOException;

  /**
   * Persists the state to the given file (in UTF-8)
   *
   * @param manager the manager
   * @param file    the file the state is persisted to
   * @throws IOException if any.
   */
  void persist( @Nonnull ConfigurationManager manager, @Nonnull File file ) throws IOException;

  /**
   * persist
   *
   * @param configurationManager a ConfigurationManager object.
   * @param out                  a Writer object.
   * @param encoding             a String object.
   * @throws IOException if any.
   */
  void persist( @Nonnull ConfigurationManager configurationManager, @Nonnull Writer out, @Nullable String encoding ) throws IOException;

  /**
   * persist
   *
   * @param configurations a List object.
   * @param out            a Writer object.
   * @param encoding       a String object.
   * @throws IOException if any.
   */
  void persist( @Nonnull List configurations, @Nonnull Writer out, @Nullable String encoding ) throws IOException;

  /**
   * persist
   *
   * @param manager a ConfigurationManager object.
   * @param out     a OutputStream object.
   * @param charset a Charset object.
   * @throws IOException if any.
   */
  void persist( @Nonnull ConfigurationManager manager, @Nonnull OutputStream out, @Nonnull Charset charset ) throws IOException;

  /**
   * load
   *
   * @param serialized a String object.
   * @return a List object.
   *
   * @throws IOException if any.
   */
  @Nonnull
  List load( @Nonnull String serialized ) throws IOException;

  /**
   * load
   *
   * @param in a Reader object.
   * @return a List object.
   *
   * @throws IOException if any.
   */
  @Nonnull
  List load( @Nonnull Reader in ) throws IOException;

  /**
   * load
   *
   * @param file a File object.
   * @return a List object.
   *
   * @throws IOException if any.
   */
  @Nonnull
  List load( @Nonnull File file ) throws IOException;

  /**
   * load
   *
   * @param in      a BufferedInputStream object.
   * @param charset a Charset object.
   * @return a List object.
   *
   * @throws IOException if any.
   */
  @Nonnull
  List load( @Nonnull BufferedInputStream in, @Nonnull Charset charset ) throws IOException;
}