Interface ICCImportInput

All Superinterfaces:
ICCBase
All Known Implementing Classes:
CCAbstractImportInput

public interface ICCImportInput extends ICCBase
This interface serves the following purposes: 1) During the discovery phase it represents that the importer found valid data that can be used to do an import 2) Can be returned with isValidForImport() set to false to indicate that import is not supported but with error messages indicating why. e.g. could be incomplete data
Since:
3.1
  • Method Details

    • isValidForImport

      boolean isValidForImport()
      Returns true if valid for input. If returning false messages can be added to this object that indicates why it didn't find valid data.
      Returns:
      true if valid for import
    • getImportPath

      String getImportPath()
      Returns:
      the import path initially used to find import data
    • dispose

      void dispose()
      Called to do any required cleanup of artifacts
    • setSourcePaths

      void setSourcePaths(String[] sourcePaths)
      Additional source paths (in addition to what can be found with the results) can be set here and will be used by importers that support external source paths
      Parameters:
      sourcePaths - 1 or more source paths
      Since:
      4.0
    • getSourcePaths

      String[] getSourcePaths()
      Returns 1 or more paths that can be used by an importer to search for source in addition to what is stored with the result
      Returns:
      1 or more source paths that will be used to search for source including path to internal source if available
      Since:
      4.0