Field Detail

• PROP_DISPLAY_NAME

  public static final java.lang.String PROP_DISPLAY_NAME

  property name of display name

  See Also:

  Constant Field Values

• PROP_ACTIONS

  public static final java.lang.String PROP_ACTIONS

  property name of list of actions

  See Also:

  Constant Field Values

Constructor Detail

• DataLoader

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

  Deprecated. Use DataLoader(String) instead.
  Create a new data loader. Pass its representation class as a parameter to the constructor. It is recommended that representation class is superclass of all DataObjects produced by the loaded, but it is not required any more.

  Parameters:

  representationClass - the superclass (not necessarily) of all objects returned from findDataObject(org.openide.filesystems.FileObject, java.util.Set<? super org.openide.filesystems.FileObject>). The class may be anything but should be chosen to be as close as possible to the actual class of objects returned from the loader, to best identify the loader's data objects to listeners.

• DataLoader

  protected DataLoader​(java.lang.String representationClassName)

  Create a new data loader. Pass its representation class name as a parameter to the constructor. The constructor is then allowed to return only subclasses of the representation class as the result of findDataObject(org.openide.filesystems.FileObject, java.util.Set<? super org.openide.filesystems.FileObject>).

  Parameters:

  representationClassName - the name of the superclass for all objects returned from findDataObject(org.openide.filesystems.FileObject, java.util.Set<? super org.openide.filesystems.FileObject>). The class may be anything but should be chosen to be as close as possible to the actual class of objects returned from the loader, to best identify the loader's data objects to listeners.

  Since:

  1.10

Method Detail

• getRepresentationClass

  public final java.lang.Class<? extends DataObject> getRepresentationClass​()

  Get the representation class for this data loader, as passed to the constructor.

  Returns:

  the representation class

• getRepresentationClassName

  public final java.lang.String getRepresentationClassName​()

  Get the name of the representation class for this data loader. Might avoid actually loading the class.

  Returns:

  the class name

  Since:

  3.25

  See Also:

  getRepresentationClass()

• getActions

  public final org.openide.util.actions.SystemAction[] getActions​()

  Get actions. These actions are used to compose a popup menu for the data object. Also these actions should be customizable by the user, so he can modify the popup menu on a data object.

  Returns:

  array of system actions or null if this loader does not have any actions

• actionsContext

  protected java.lang.String actionsContext​()

  Identifies the name of context in layer files where the loader wishes to store its own actions and also read them. In principle any Action instance can be registered in the context and it will be visible in the default DataNode for data object created by this loader. Only SystemAction can however be manipulated from DataLoader getActions/setActions methods.

  The default implementation returns null to indicate that no layer reading should be used (use defaultActions() instead).

  JSeparator instances may be used to separate items.

  Suggested context name: Loaders/PRIMARY-FILE/MIME-TYPE/Actions

  Returns:

  the string name of the context on layer files to read/write actions to

  Since:

  5.0

• defaultActions

  @Deprecated
  protected org.openide.util.actions.SystemAction[] defaultActions​()

  Deprecated. Instead of overriding this method it is preferable to override actionsContext().
  Get default actions.

  Returns:

  array of default system actions

• setActions

  public final void setActions​(org.openide.util.actions.SystemAction[] actions)

  Set actions.

  Note that this method is public, not protected, so it is possible for anyone to modify the loader's popup actions externally (after finding the loader using DataLoaderPool.firstProducerOf(java.lang.Class<? extends org.openide.loaders.DataObject>)). While this is possible, anyone doing so must take care to place new actions into sensible positions, including consideration of separators. This may also adversely affect the intended feel of the data objects. A preferable solution is generally to use service actions.

  Parameters:

  actions - actions for this loader or null if it should not have any

  See Also:

  getActions()

• getDisplayName

  public final java.lang.String getDisplayName​()

  Get the current display name of this loader.

  Returns:

  display name

• setDisplayName

  protected final void setDisplayName​(java.lang.String displayName)

  Set the display name for this loader. Only subclasses should set the name.

  Parameters:

  displayName - new name

• defaultDisplayName

  protected java.lang.String defaultDisplayName​()

  Get the default display name of this loader.

  Returns:

  default display name

• findDataObject

  public final DataObject findDataObject​(org.openide.filesystems.FileObject fo,
                                         java.util.Set<? super org.openide.filesystems.FileObject> recognized)
                                  throws java.io.IOException

  Find a data object appropriate to the given file object--the meat of this class.

  Specified by:

  findDataObject in interface DataObject.Factory

  Parameters:

  fo - file object

  recognized - set of already processed files

  Returns:

  created data object

  Throws:

  java.io.IOException

  DataObjectExistsException - if the data object for the primary file already exists

  java.io.InvalidClassException - if the class is not instance of #getRepresentationClass

  Since:

  7.0

  See Also:

  DataLoader

• findDataObject

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

  Find a data object appropriate to the given file object--the meat of this class.

  For example: for files with the same basename but extensions .java and .class, the handler should return the same DataObject.

  The loader can add all files it has recognized into the recognized buffer. Then all these files will be excluded from further processing.

  Parameters:

  fo - file object to recognize

  recognized - recognized file buffer

  Returns:

  suitable data object or null if the handler cannot recognize this object (or its group)

  Throws:

  DataObjectExistsException - if the data object for the primary file already exists

  java.io.IOException - if the object is recognized but cannot be created

  java.io.InvalidClassException - if the class is not instance of getRepresentationClass()

  See Also:

  handleFindDataObject(org.openide.filesystems.FileObject, org.openide.loaders.DataLoader.RecognizedFiles)

• handleFindDataObject

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

  Find a data object appropriate to the given file object (as implemented in subclasses).

  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:

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

• markFile

  public final void markFile​(org.openide.filesystems.FileObject fo)
                      throws java.io.IOException

  Utility method to mark a file as belonging to this loader. When the file is to be recognized this loader will be used first.

  This method is used by DataObject.markFiles().

  Parameters:

  fo - file to mark

  Throws:

  java.io.IOException - if setting the file's attribute failed

• writeExternal

  public void writeExternal​(java.io.ObjectOutput oo)
                     throws java.io.IOException

  Writes nothing to the stream.

  Overrides:

  writeExternal in class org.openide.util.SharedClassObject

  Parameters:

  oo - ignored

  Throws:

  java.io.IOException

• readExternal

  public void readExternal​(java.io.ObjectInput oi)
                    throws java.io.IOException,
                           java.lang.ClassNotFoundException

  Reads actions and display name from the stream.

  Overrides:

  readExternal in class org.openide.util.SharedClassObject

  Parameters:

  oi - input source to read from

  Throws:

  org.openide.util.io.SafeException - if some of the actions is not found in the stream, but all the content has been read ok. Subclasses can catch this exception and continue reading from the stream

  java.io.IOException

  java.lang.ClassNotFoundException

• clearSharedData

  protected boolean clearSharedData​()

  Overrides:

  clearSharedData in class org.openide.util.SharedClassObject

• getLoader

  public static <T extends DataLoader> T getLoader​(java.lang.Class<T> loaderClass)

  Get a registered loader from the pool.

  Parameters:

  loaderClass - exact class of the loader (not its data object representation class)

  Returns:

  the loader instance, or null if there is no such loader registered

  See Also:

  DataLoaderPool.allLoaders