Constructor Detail

• MultiFileLoader

  @Deprecated
  protected MultiFileLoader​(java.lang.Class<? extends DataObject> representationClass)

  Deprecated. Use MultiFileLoader#MultiFileLoader(String) instead.
  Creates new multi file loader.

  Parameters:

  representationClass - the representation class

• MultiFileLoader

  protected MultiFileLoader​(java.lang.String representationClassName)

  Creates new multi file loader.

  Parameters:

  representationClassName - the fully qualified name of the representation class.

  Since:

  1.10

Method Detail

• handleFindDataObject

  protected final DataObject handleFindDataObject​(org.openide.filesystems.FileObject fo,
                                                  DataLoader.RecognizedFiles recognized)
                                           throws java.io.IOException

  Description copied from class: DataLoader
  Find a data object appropriate to the given file object (as implemented in subclasses).

  Specified by:

  handleFindDataObject in class DataLoader

  Parameters:

  fo - file object to recognize

  recognized - recognized file buffer

  Returns:

  the data object or null

  Throws:

  DataObjectExistsException - as in #findDataObject

  java.io.IOException - as in #findDataObject

  See Also:

  DataLoader.findDataObject(org.openide.filesystems.FileObject, java.util.Set<? super org.openide.filesystems.FileObject>)

• findPrimaryFile

  protected abstract org.openide.filesystems.FileObject findPrimaryFile​(org.openide.filesystems.FileObject fo)

  For a given file finds the primary file.

  Parameters:

  fo - the (secondary) file

  Returns:

  the primary file for the file or null if the file is not recognized by this loader

• createMultiObject

  protected abstract MultiDataObject createMultiObject​(org.openide.filesystems.FileObject primaryFile)
                                                throws DataObjectExistsException,
                                                       java.io.IOException

  Creates the right data object for a given primary file. It is guaranteed that the provided file will actually be the primary file returned by findPrimaryFile(org.openide.filesystems.FileObject).

  Parameters:

  primaryFile - the primary file

  Returns:

  the data object for this file

  Throws:

  DataObjectExistsException - if the primary file already has a data object

  java.io.IOException

• createPrimaryEntry

  protected abstract MultiDataObject.Entry createPrimaryEntry​(MultiDataObject obj,
                                                              org.openide.filesystems.FileObject primaryFile)

  Creates the right primary entry for a given primary file.

  Parameters:

  obj - requesting object

  primaryFile - primary file recognized by this loader

  Returns:

  primary entry for that file

• createSecondaryEntry

  protected abstract MultiDataObject.Entry createSecondaryEntry​(MultiDataObject obj,
                                                                org.openide.filesystems.FileObject secondaryFile)

  Creates a new secondary entry for a given file. Note that separate entries must be created for every secondary file within a given multi-file data object.

  Parameters:

  obj - requesting object

  secondaryFile - a secondary file

  Returns:

  the entry