Package com.intellij.openapi.options

Interface SchemeImporter<T extends Scheme>

All Known Implementing Classes:

CodeStyleSchemeXmlImporter, ColorSchemeImporter, EclipseCodeStyleSchemeImporter, EclipseColorSchemeImporter, InspectionProfileImporter

public interface SchemeImporter<T extends Scheme>

Provides functionality to import a scheme from another non-IntelliJ format.

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getAdditionalImportInfo(T scheme) Called after the scheme has been imported.
default VirtualFile	getImportFile()
java.lang.String []	getSourceExtensions()
T	importScheme(Project project, VirtualFile selectedFile, T currentScheme, SchemeFactory<T> schemeFactory) Import a scheme from the given virtual file

Method Detail

getSourceExtensions

java.lang.String [] getSourceExtensions()

Returns:

An extension of a source file which can be imported, for example, "xml".

importScheme

T importScheme(Project project,
               VirtualFile selectedFile,
               T currentScheme,
               SchemeFactory<T> schemeFactory)
        throws SchemeImportException

Import a scheme from the given virtual file

Parameters:

project - project

selectedFile - The input file to import from.

currentScheme - source scheme to be updated or to base import on

schemeFactory - The factory to create a scheme with a given name. Importer implementation should use this method to create a scheme to which it will save imported values.

Returns:

created/updated scheme, or null if action was cancelled

Throws:

SchemeImportException

See Also:

SchemeFactory

getAdditionalImportInfo

default java.lang.String getAdditionalImportInfo(T scheme)

Called after the scheme has been imported.

Parameters:

scheme - The imported scheme.

Returns:

An information message to be displayed after import.

getImportFile

default VirtualFile getImportFile()

Returns:

File to import scheme. If null, file chooser is shown.