Package cdc.issues.io

Class IssuesIoFactory

java.lang.Object
cdc.issues.io.IssuesIoFactory
public class IssuesIoFactory extends Object
Class that can be used to create instances of:
Author:
Damien Carbonne

  • Constructor Details

    • IssuesIoFactory

      public IssuesIoFactory(IssuesIoFactoryFeatures features)
      Creates a factory.
      Parameters:
      features - The features.

  • Method Details

    • getFeatures

      public IssuesIoFactoryFeatures getFeatures()
      Returns:
      The features associated to this factory.;

    • canExportTo

      public boolean canExportTo(File file)
      Parameters:
      file - The file.
      Returns:
      true if export to file is supported. If file is null returns false.

    • createIssuesStreamWriter

      public IssuesStreamWriter createIssuesStreamWriter(File file, OutSettings settings)
      Creates an instance of IssuesStreamWriter fitted for a file.
      Parameters:
      file - The file for which the writer must be created.
      settings - The settings.
      Returns:
      A new instance of IssuesStreamWriter fitted for file.
      Throws:
      IllegalArgumentException - When file or settings is null,* or when file has an unrecognized extension.

    • createIssuesStreamWriter

      public IssuesStreamWriter createIssuesStreamWriter(OutputStream out, IssuesFormat format, OutSettings settings)
      Creates an instance of IssuesStreamWriter fitted for an output stream and a format.
      Parameters:
      out - The output stream.
      format - The format.
      settings - The settings.
      Returns:
      A new instance of IssuesStreamWriter fitted for out and format.
      Throws:
      IllegalArgumentException - When out, format or settings is null.

    • createIssuesWriter

      public IssuesWriter createIssuesWriter(File file)
      Creates an IssuesWriter fitted for a file.

      See IssuesFormat for a list of supported formats.

      Parameters:
      file - The file for which an IssuesWriter must be created.
      Returns:
      A new instance of IssuesWriter fitted for file.
      Throws:
      IllegalArgumentException - When file is null or has an unrecognized extension.

    • createIssuesWriter

      public IssuesWriter createIssuesWriter(OutputStream out, IssuesFormat format)
      Creates an IssuesWriter fitted for an output stream and a format.
      Parameters:
      out - The output stream.
      format - The format.
      Returns:
      A new instance of IssuesWriter fitted for out and format.
      Throws:
      IllegalArgumentException - When out or format is null.

    • canImportFrom

      public boolean canImportFrom(File file)
      Parameters:
      file - The file.
      Returns:
      true if import from file is supported. If file is null returns false.

    • createIssuesReader

      public IssuesReader createIssuesReader(File file)
      Creates an IssuesReader fitted for a file.
      Parameters:
      file - The file.
      Returns:
      A new instance of IssuesReader fitted for file.
      Throws:
      IllegalArgumentException - When file is null, or when file has an unrecognized extension.

    • createIssuesReader

      public IssuesReader createIssuesReader(InputStream in, IssuesFormat format)
      Creates an IssuesReader fitted for an input stream and a format.
      Parameters:
      in - The input stream.
      format - The format.
      Returns:
      A new instance of IssuesReader fitted for in and format.
      Throws:
      IllegalArgumentException - When in or format is null.