replaced <code></code> with more concise {@code}
[idea/community.git] / platform / external-system-api / src / com / intellij / openapi / externalSystem / service / project / ExternalLibraryPathTypeMapper.java
1 /*
2  * Copyright 2000-2013 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.externalSystem.service.project;
17
18 import com.intellij.openapi.externalSystem.model.project.LibraryPathType;
19 import com.intellij.openapi.roots.OrderRootType;
20 import org.jetbrains.annotations.NotNull;
21
22 /**
23  * Strategy for mapping {@link LibraryPathType external library path types} to {@link OrderRootType ide library path types}.
24  * <p/>
25  * Is introduced because {@code 'JavadocOrderRootType.getInstance()'} assumes that project IoC is setup thus
26  * make it ineligible for unit testing.
27  * <p/>
28  * Implementations of this interface are expected to be thread-safe.
29  * 
30  * @author Denis Zhdanov
31  * @since 1/17/13 3:51 PM
32  */
33 public interface ExternalLibraryPathTypeMapper {
34
35   @NotNull
36   OrderRootType map(@NotNull LibraryPathType type);
37 }