replaced <code></code> with more concise {@code}
[idea/community.git] / platform / editor-ui-api / src / com / intellij / openapi / editor / colors / EditorColorPaletteFactory.java
1 /*
2  * Copyright 2000-2016 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.editor.colors;
17
18 import com.intellij.lang.Language;
19 import com.intellij.openapi.components.ServiceManager;
20 import org.jetbrains.annotations.NotNull;
21 import org.jetbrains.annotations.Nullable;
22
23 /**
24  * Builds an empty editor color palette. The constructed palette can be filled with {@code EditorColorPalette.with...()} methods.
25  * @see EditorColorPalette#withBackgroundColors()
26  * @see EditorColorPalette#withForegroundColors()
27  */
28 public abstract class EditorColorPaletteFactory {
29   public static EditorColorPaletteFactory getInstance() {
30     return ServiceManager.getService(EditorColorPaletteFactory.class);
31   }
32
33   /**
34    * Builds an empty palette object for the given scheme and language.
35    * 
36    * @param scheme   The editor color scheme to retrieve colors from.
37    * @param language The language. It can be one of the following:
38    *                 <ul>
39    *                 <li><b>null</b> - for colors not associated with any language.</li>  
40    *                 <li><b>Language.ANY</b> - all available colors.</li>
41    *                 <li><i>language</i> - colors for the given language</li>  
42    *                 </ul>
43    * @return The empty color palette for the given scheme and language.
44    */
45   public abstract EditorColorPalette getPalette(@NotNull EditorColorsScheme scheme, @Nullable Language language);
46 }
47