Interface ICSettingsStorage

    • Method Detail

      • getStorage

        ICStorageElement getStorage​(String id,
                                    boolean create)
                             throws org.eclipse.core.runtime.CoreException
        returns the storage of the specified id
        Parameters:
        id - any custom string value uniquely representing the storage
        Returns:
        ICStorageElement if the settings storage does not contain the information of the specified id an empty storage is created and returned
        Throws:
        org.eclipse.core.runtime.CoreException
        See Also:
        ICStorageElement
      • removeStorage

        void removeStorage​(String id)
                    throws org.eclipse.core.runtime.CoreException
        Remove the storage module with the given ID from this ICSettingsStorage
        Parameters:
        id -
        Throws:
        org.eclipse.core.runtime.CoreException
      • importStorage

        ICStorageElement importStorage​(String id,
                                       ICStorageElement el)
                                throws UnsupportedOperationException,
                                       org.eclipse.core.runtime.CoreException
        Import an existing ICStorageElement storage module into the ICSettingsStorage Returns a handle on the newly imported ICSettingsStorage NB Storage IDs are unique in an ICSettingsStorage. Importing a storage will replace any other storage with equivalent id
        Parameters:
        id - name of the storage to be imported
        el - ICStorageElement to be imported
        Returns:
        ICStorageElement representing the imported storage
        Throws:
        UnsupportedOperationException
        org.eclipse.core.runtime.CoreException
        Since:
        5.1
      • isModified

        boolean isModified()
        Returns whether any non-persisted changes exist in this tree
        Returns:
        boolean indicating whether any elements in this tree have been modified
        Since:
        5.1
      • isReadOnly

        boolean isReadOnly()
        Return whether this Settings Storage is currently read only
        Returns:
        whether this storage is readonly
        Since:
        5.1
      • setReadOnly

        void setReadOnly​(boolean readOnly,
                         boolean keepModify)
        Mark this Settings Storage as read only. If keepModify is set then modified flag will not be reset
        Parameters:
        readOnly -
        keepModify -
        Since:
        5.1