java/compiler/openapi/src/com/intellij/packaging/artifacts/ArtifactTemplate.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.packaging.elements.CompositePackagingElement;
  19 import org.jetbrains.annotations.NotNull;
  20 import org.jetbrains.annotations.Nullable;
  21
  22 /**
  23  * @author nik
  24  */
  25 public abstract class ArtifactTemplate {
  26
  27   public abstract String getPresentableName();
  28
  29   /**
  30    * @deprecated override {@link #createArtifact()} instead
  31    */
  32   @Deprecated
  33   public CompositePackagingElement<?> createRootElement(@NotNull String artifactName) {
  34     return null;
  35   }
  36
  37   /**
  38    * @deprecated override {@link #createArtifact()} instead
  39    */
  40   @Deprecated
  41   @NotNull
  42   public String suggestArtifactName() {
  43     return "unnamed";
  44   }
  45
  46   @Nullable
  47   public NewArtifactConfiguration createArtifact() {
  48     final String name = suggestArtifactName();
  49     return new NewArtifactConfiguration(createRootElement(name), name, null);
  50   }
  51
  52   public static class NewArtifactConfiguration {
  53     private final CompositePackagingElement<?> myRootElement;
  54     private final String myArtifactName;
  55     private final ArtifactType myArtifactType;
  56
  57     public NewArtifactConfiguration(CompositePackagingElement<?> rootElement, String artifactName, ArtifactType artifactType) {
  58       myRootElement = rootElement;
  59       myArtifactName = artifactName;
  60       myArtifactType = artifactType;
  61     }
  62
  63     public CompositePackagingElement<?> getRootElement() {
  64       return myRootElement;
  65     }
  66
  67     public String getArtifactName() {
  68       return myArtifactName;
  69     }
  70
  71     public ArtifactType getArtifactType() {
  72       return myArtifactType;
  73     }
  74   }
  75 }