5cb2c2958a07a810e839f5ef0f940f2039206561
[idea/community.git] / java / compiler / openapi / src / com / intellij / packaging / artifacts / Artifact.java
1 /*
2  * Copyright 2000-2009 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.packaging.artifacts;
17
18 import com.intellij.openapi.roots.ProjectModelBuildableElement;
19 import com.intellij.openapi.util.UserDataHolder;
20 import com.intellij.openapi.vfs.VirtualFile;
21 import com.intellij.packaging.elements.CompositePackagingElement;
22 import org.jetbrains.annotations.NotNull;
23 import org.jetbrains.annotations.Nullable;
24
25 import java.util.Collection;
26
27 /**
28  * Describes an artifact configuration. Use {@link ArtifactManager} to create new and get existing artifacts.
29  */
30 public interface Artifact extends UserDataHolder, ProjectModelBuildableElement {
31   @NotNull
32   ArtifactType getArtifactType();
33
34   String getName();
35
36   boolean isBuildOnMake();
37
38   /**
39    * @return the root element in the artifact's output layout tree
40    */
41   @NotNull
42   CompositePackagingElement<?> getRootElement();
43
44   @Nullable
45   String getOutputPath();
46
47   Collection<? extends ArtifactPropertiesProvider> getPropertiesProviders();
48
49   ArtifactProperties<?> getProperties(@NotNull ArtifactPropertiesProvider propertiesProvider);
50
51   @Nullable
52   VirtualFile getOutputFile();
53
54   @Nullable
55   String getOutputFilePath();
56 }