oracle.jdevimpl.audit.preferences
Class AuditPreferencesMigrator

java.lang.Object
  oracle.ide.migration.ExtensionMigrator
      oracle.jdevimpl.audit.preferences.AuditPreferencesMigrator

All Implemented Interfaces:

Migrator

public class AuditPreferencesMigrator
extends ExtensionMigrator

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ide.migration.ExtensionMigrator

ExtensionMigrator.AdjustedObject

Field Summary

Fields inherited from class oracle.ide.migration.ExtensionMigrator

isSelected, ROOT_TAG, SETTINGS

Fields inherited from interface oracle.ide.migration.Migrator

JDEV_HOME_DIR, SYSTEM_DIR

Constructor Summary

AuditPreferencesMigrator()

Method Summary

protected boolean	addToProductPreferences() Determines whether the migrated preferences should be added into the Preferences object or remain separate.
protected ExtensionMigrator.AdjustedObject[]	adjustObject(java.lang.String key, java.lang.Object object) Unset any migrated values that are at the default values.
protected java.util.Collection<java.lang.String>	getClassNamesToIgnoreErrorsOn() Provides a way to suppress errors from Object2Dom when the preferences file is read and contains preferences that are not in the same class loader as the preferences you are migrating.
protected java.lang.String	getExtensionID() Get the extension ID for which settings should be persisted.
protected java.lang.ClassLoader	getMigratorClassLoader() Override to provide a class loader other than the one that supplies the subclass of ExtensionMigrator.
protected java.util.List	getSettingKeys() Get a complete list of all key values for persisting in the ClientSetting object associated with an extension.
protected java.io.File	getSourceFile(java.io.File sourceDir) Get the source File from the given directory.

Methods inherited from class oracle.ide.migration.ExtensionMigrator

canMigrate, copyPreferenceObject, copyPreferenceObjectsAsIs, getDescription, getDestFile, getIde1013ExtensionDirectory, getMigrationCategories, getRootTag, getSourceFileOrJDevExtrasFile, isSelected, loadClass, migrate, setSelected

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuditPreferencesMigrator

public AuditPreferencesMigrator()

Method Detail

getSettingKeys

protected java.util.List getSettingKeys()

Description copied from class: ExtensionMigrator

Get a complete list of all key values for persisting in the ClientSetting object associated with an extension.

Specified by:

getSettingKeys in class ExtensionMigrator

Returns:

a list of String keys.

getExtensionID

protected java.lang.String getExtensionID()

Description copied from class: ExtensionMigrator

Get the extension ID for which settings should be persisted.

Specified by:

getExtensionID in class ExtensionMigrator

Returns:

an extension ID. Must not return null.

getMigratorClassLoader

protected java.lang.ClassLoader getMigratorClassLoader()

Description copied from class: ExtensionMigrator

Override to provide a class loader other than the one that supplies the subclass of ExtensionMigrator. Only need to do this if the class being migrated cannot be loaded by the same class loader.

Overrides:

getMigratorClassLoader in class ExtensionMigrator

getSourceFile

protected java.io.File getSourceFile(java.io.File sourceDir)

Get the source File from the given directory. By default assumes a File located in sourceDir of the name ClientSetting.FILENAME, else IdeSettings.FILENAME

Overrides:

getSourceFile in class ExtensionMigrator

Parameters:

sourceDir - the source directory.

Returns:

the settings File located in the given directory.

addToProductPreferences

protected boolean addToProductPreferences()

Description copied from class: ExtensionMigrator

Determines whether the migrated preferences should be added into the Preferences object or remain separate. This can only be done for preferences which have been modified to use HashStructureAdapter. If the preferences are to be added into the preferences object override this method and return true.

Overrides:

addToProductPreferences in class ExtensionMigrator

adjustObject

protected ExtensionMigrator.AdjustedObject[] adjustObject(java.lang.String key,
                                                          java.lang.Object object)

Unset any migrated values that are at the default values.

Overrides:

adjustObject in class ExtensionMigrator

getClassNamesToIgnoreErrorsOn

protected java.util.Collection<java.lang.String> getClassNamesToIgnoreErrorsOn()

Description copied from class: ExtensionMigrator

Provides a way to suppress errors from Object2Dom when the preferences file is read and contains preferences that are not in the same class loader as the preferences you are migrating. For example the preferences file in o.jdeveloper contains preferences for Ant, Audit, Profiler, and others which are all in different extensions. No matter who tries to migrate this there will be failures as some of the classes may not be found. Override this to provide a list of class names that should not generate errors when your migrator is run

Overrides:

getClassNamesToIgnoreErrorsOn in class ExtensionMigrator