replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-api / src / com / intellij / openapi / options / SchemeExporter.java
1 /*
2  * Copyright 2000-2015 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.openapi.options;
17
18 import org.jetbrains.annotations.NotNull;
19
20 import java.io.OutputStream;
21
22 /**
23  * Base interface to export a scheme.
24  *
25  * @author Rustam Vishnyakov
26  */
27 public abstract class SchemeExporter<T extends Scheme> {
28   /**
29    * Writes a scheme to a given {@code outputStream}.
30    *
31    * @param scheme       The scheme to export.
32    * @param outputStream The output stream to write to.
33    * @throws Exception
34    */
35   public abstract void exportScheme(@NotNull T scheme, @NotNull OutputStream outputStream) throws Exception;
36
37   /**
38    * @return Target file extension without a dot, for example "xml".
39    */
40   public abstract String getExtension();
41 }