java/compiler/openapi/src/com/intellij/packaging/elements/PackagingElementFactory.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.elements;
  17
  18 import com.intellij.openapi.components.ServiceManager;
  19 import com.intellij.openapi.module.Module;
  20 import com.intellij.openapi.roots.libraries.Library;
  21 import com.intellij.openapi.project.Project;
  22 import com.intellij.packaging.artifacts.Artifact;
  23 import com.intellij.packaging.artifacts.ArtifactPointer;
  24 import org.jetbrains.annotations.NonNls;
  25 import org.jetbrains.annotations.NotNull;
  26 import org.jetbrains.annotations.Nullable;
  27
  28 import java.util.List;
  29
  30 /**
  31  * @author nik
  32  */
  33 public abstract class PackagingElementFactory {
  34
  35   public static PackagingElementFactory getInstance() {
  36     return ServiceManager.getService(PackagingElementFactory.class);
  37   }
  38
  39   @NotNull
  40   public abstract ArtifactRootElement<?> createArtifactRootElement();
  41
  42   @NotNull
  43   public abstract CompositePackagingElement<?> createDirectory(@NotNull @NonNls String directoryName);
  44
  45   @NotNull
  46   public abstract CompositePackagingElement<?> createArchive(@NotNull @NonNls String archiveFileName);
  47
  48   @NotNull
  49   public abstract PackagingElement<?> createModuleOutput(@NotNull String moduleName, Project project);
  50
  51   @NotNull
  52   public abstract PackagingElement<?> createModuleOutput(@NotNull Module module);
  53
  54   @NotNull
  55   public abstract List<? extends PackagingElement<?>> createLibraryElements(@NotNull Library library);
  56
  57   @NotNull
  58   public abstract PackagingElement<?> createArtifactElement(@NotNull ArtifactPointer artifactPointer, @NotNull Project project);
  59
  60   @NotNull
  61   public abstract PackagingElement<?> createArtifactElement(@NotNull Artifact artifact, @NotNull Project project);
  62
  63   @NotNull
  64   public abstract PackagingElement<?> createLibraryFiles(@NotNull String libraryName, @NotNull String level, String moduleName);
  65
  66
  67   @NotNull
  68   public abstract PackagingElement<?> createDirectoryCopyWithParentDirectories(@NotNull String filePath, @NotNull String relativeOutputPath);
  69
  70   @NotNull
  71   public abstract PackagingElement<?> createFileCopyWithParentDirectories(@NotNull String filePath, @NotNull String relativeOutputPath,
  72                                                                           @Nullable String outputFileName);
  73
  74   @NotNull
  75   public abstract PackagingElement<?> createFileCopyWithParentDirectories(@NotNull String filePath, @NotNull String relativeOutputPath);
  76
  77
  78   @NotNull
  79   public abstract CompositePackagingElement<?> getOrCreateDirectory(@NotNull CompositePackagingElement<?> parent, @NotNull String relativePath);
  80
  81   @NotNull
  82   public abstract CompositePackagingElement<?> getOrCreateArchive(@NotNull CompositePackagingElement<?> parent, @NotNull String relativePath);
  83
  84   public abstract void addFileCopy(@NotNull CompositePackagingElement<?> root, @NotNull String outputDirectoryPath, @NotNull String sourceFilePath,
  85                                    final String outputFileName);
  86
  87   public abstract void addFileCopy(@NotNull CompositePackagingElement<?> root, @NotNull String outputDirectoryPath, @NotNull String sourceFilePath);
  88
  89   @NotNull
  90   public abstract PackagingElement<?> createParentDirectories(@NotNull String relativeOutputPath, @NotNull PackagingElement<?> element);
  91
  92
  93   @NotNull
  94   public abstract List<? extends PackagingElement<?>> createParentDirectories(@NotNull String relativeOutputPath, @NotNull List<? extends PackagingElement<?>> elements);
  95
  96   @NotNull
  97
  98   public abstract CompositePackagingElementType<?>[] getCompositeElementTypes();
  99
 100   @Nullable
 101   public abstract PackagingElementType<?> findElementType(String id);
 102
 103   @NotNull
 104   public abstract PackagingElementType<?>[] getNonCompositeElementTypes();
 105
 106   @NotNull
 107   public abstract PackagingElementType[] getAllElementTypes();
 108
 109   @NotNull
 110   public abstract ComplexPackagingElementType<?>[] getComplexElementTypes();
 111 }