ArtifactCompilerInstructionCreator.java

/*
 * Copyright 2000-2012 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jetbrains.jps.incremental.artifacts.instructions;

import com.intellij.openapi.util.Condition;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.io.File;

/**
 * @author nik
 */
public interface ArtifactCompilerInstructionCreator {

  void addFileCopyInstruction(@NotNull File file, @NotNull String outputFileName);

  void addFileCopyInstruction(@NotNull File file, @NotNull String outputFileName, @NotNull FileCopyingHandler copyingHandler);

  void addDirectoryCopyInstructions(@NotNull File directory);

  void addDirectoryCopyInstructions(@NotNull File directory, @Nullable SourceFileFilter filter);

  void addDirectoryCopyInstructions(@NotNull File directory, @Nullable SourceFileFilter filter, @NotNull FileCopyingHandler copyingHandler);

  /**
   * Add instruction to extract directory from a jar file into the current place in the artifact layout.
   *
   * @param jarFile         jar file to extract
   * @param pathInJar       relative path to directory inside {@code jarFile} which need to be extracted. Use "/" to extract the whole jar contents
   */
  void addExtractDirectoryInstruction(@NotNull File jarFile, @NotNull String pathInJar);

  /**
   * Add instruction to extract directory from a jar file into the current place in the artifact layout.
   * @param jarFile jar file to extract
   * @param pathInJar relative path to directory inside {@code jarFile} which need to be extracted. Use "/" to extract the whole jar contents
   * @param pathInJarFilter a filter instance specifying which entries should be extracted. It should accept paths inside the jar file
   *                        relative to {@code pathInJar} root and return {@code true} if the entry should be extracted and {@code false} otherwise
   */
  void addExtractDirectoryInstruction(@NotNull File jarFile, @NotNull String pathInJar, @NotNull Condition<String> pathInJarFilter);

  ArtifactCompilerInstructionCreator subFolder(@NotNull String directoryName);

  ArtifactCompilerInstructionCreator archive(@NotNull String archiveFileName);

  ArtifactCompilerInstructionCreator subFolderByRelativePath(@NotNull String relativeDirectoryPath);

  ArtifactInstructionsBuilder getInstructionsBuilder();
}