Package com.intellij.openapi.options

Class SchemeExporter<T extends Scheme>

java.lang.Object

com.intellij.openapi.options.SchemeExporter<T>

Direct Known Subclasses:

CodeStyleSchemeJsonExporter, ConfigurableSchemeExporter, EditorConfigExporter, SerializableSchemeExporter

public abstract class SchemeExporter<T extends Scheme>
extends java.lang.Object

Base interface to export a scheme.

Constructor Summary

Constructors

Constructor and Description
SchemeExporter()

Method Summary

Modifier and Type	Method and Description
void	exportScheme(Project project, T scheme, java.io.OutputStream outputStream) Writes a scheme to a given outputStream.
void	exportScheme(T scheme, java.io.OutputStream outputStream) Deprecated. use exportScheme(Project, Scheme, OutputStream).
VirtualFile	getDefaultDir(Project project)
java.lang.String	getDefaultFileName(java.lang.String schemeName)
abstract java.lang.String	getExtension()

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemeExporter

public SchemeExporter()

Method Detail

exportScheme

@Deprecated
public void exportScheme(T scheme,
                         java.io.OutputStream outputStream)
                  throws java.lang.Exception

Deprecated. use exportScheme(Project, Scheme, OutputStream).

Throws:

java.lang.Exception

exportScheme

public void exportScheme(Project project,
                         T scheme,
                         java.io.OutputStream outputStream)
                  throws java.lang.Exception

Writes a scheme to a given outputStream.

Parameters:

scheme - The scheme to export.

outputStream - The output stream to write to.

project - The optional project, null if there are no open projects.

Throws:

java.lang.Exception - Scheme export exception. Will be reported to UI.

getExtension

public abstract java.lang.String getExtension()

Returns:

Target file extension without a dot, for example "xml".

getDefaultFileName

public java.lang.String getDefaultFileName(java.lang.String schemeName)

Parameters:

schemeName - The initial scheme display name.

Returns:

The default file name to be used.

getDefaultDir

public VirtualFile getDefaultDir(Project project)

Returns:

A directory which should be preselected for the given project if any.