1 /* 2 * Copyright (c) 2012, 2014, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package com.sun.tools.sjavac; 27 28 import java.io.PrintStream; 29 import java.net.URI; 30 import java.util.Set; 31 import java.util.Map; 32 33 import com.sun.tools.sjavac.options.Options; 34 import com.sun.tools.sjavac.server.Sjavac; 35 36 /** 37 * The transform interface is used to transform content inside a package, from one form to another. 38 * Usually the output form is an unpredictable number of output files. (eg class files) 39 * but can also be an unpredictable number of generated source files (eg idl2java) 40 * or a single predictable output file (eg when copying,cleaning or compiling a properties file). 41 * 42 * <p><b>This is NOT part of any supported API. 43 * If you write code that depends on this, you do so at your own risk. 44 * This code and its internal interfaces are subject to change or 45 * deletion without notice.</b> 46 */ 47 public interface Transformer { 48 /** 49 * The transform method takes a set of package names, mapped to their source files and to the 50 * pubapis of the packages. 51 * 52 * The transform implementation must: 53 * store the names of the generated artifacts for each package into package_artifacts 54 * store found dependencies to other packages into the supplied set package_dependencies 55 * store the public api for a package into the supplied set package_pubapis 56 * 57 * Any benign messages as a result of running the transform 58 * are written into stdout, and errors are written to stderr. 59 * 60 * The debug_level can be 0=silent (only warnings and errors) 1=normal 2=verbose 3 or greater=debug 61 * setExtra is used to set the extra information information that can be passed on 62 * the command line to the smart javac wrapper. 63 * 64 * If sjavac is building incrementally from an existing javac_state, the var incremental is true. 65 * 66 * The transformer will only be called if some source in the package (or dependency) has 67 * a modified timestamp. Thus the transformer might get called with many sources, of which 68 * only one has changed. The transformer is allowed to regenerate all artifacts but 69 * a better transformer will only write those artifacts that need updating. 70 * 71 * However the transformer must verify that the existing artifacts really are there! 72 * and it must always update package_artifacts, package_dependencies, and package_pubapis correctly. 73 * This means that at least for Java source, it will always have to recompile the sources. 74 * 75 * The transformer is allowed to put files anywhere in the dest_root. 76 * An example of this is, can be the META-INF transformer that copy files 77 * below META-INF directories to the single META-INF directory below dest_root. 78 * 79 * False is returned if there was an error that prevented the transform. 80 * I.e. something was printed on stderr. 81 * 82 * If num_cores is set to a non-zero value. The transform should attempt to use no more than these 83 * number of threads for heavy work. 84 */ 85 boolean transform(Sjavac sjavac, 86 Map<String,Set<URI>> pkgSrcs, 87 Set<URI> visibleSources, 88 Map<URI,Set<String>> visibleClasses, 89 Map<String,Set<String>> oldPackageDependencies, 90 URI destRoot, 91 Map<String,Set<URI>> packageArtifacts, 92 Map<String,Set<String>> packageDependencies, 93 Map<String,String> packagePublicApis, 94 int debugLevel, 95 boolean incremental, 96 int numCores, 97 PrintStream out, 98 PrintStream err); 99 100 void setExtra(String e); 101 void setExtra(Options args); 102 }