IProcessStep


1   /*******************************************************************************
2    * Copyright (c) 2006 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    * 
8    * Contributors:
9    *     IBM - Initial API and implementation
10   *******************************************************************************/
11  package org.eclipse.update.internal.jarprocessor;
12  
13  import java.io.File  ;
14  import java.util.List  ;
15  import java.util.Properties  ;
16  
17  /**
18   * @author aniefer@ca.ibm.com
19   *
20   */
21  public interface IProcessStep {
22      
23      /**
24       * The effect of this processing step if the JarProcessor was to recurse on this entry.
25       * Return null if this step will not do anything with this entry.
26       * Return the new entryName if this step will modify this entry on recursion.
27       * @param entryName
28       * @return
29       */
30      public String   recursionEffect(String   entryName);
31      
32      /**
33       * Perform some processing on the input file before the JarProcessor considers the entries for recursion.
34       *  return the file containing the result of the processing
35       * @param input
36       * @param workingDirectory
37       * @param containers: inf properties for containing jars, innermost jar is first on the list
38       * @return
39       */
40      public File   preProcess(File   input, File   workingDirectory, List   containers);
41      
42      /**
43       * Perform some processing on the input file after the JarProcessor returns from recursion
44       * return the file containing the result of the processing
45       * @param input
46       * @param workingDirectory
47       * @param containers: inf properties for containing jars, innermost jar is first on the list
48       * @return
49       */
50      public File   postProcess(File   input, File   workingDirectory, List   containers);
51      
52      /**
53       * Return the name of this process step
54       * @return
55       */
56      public String   getStepName();
57  
58      /**
59       * Adjust any properties in the eclipse.inf as appropriate for this step
60       * @param input
61       * @param inf
62       * @param containers: inf properties for containing jars, innermost jar is first on the list
63       */
64      public void adjustInf(File   input, Properties   inf, List   containers);
65  }
66
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags