Showing the changes to java/pkg/sun/rmi/rmic/Generator.java (1 of 18352 files). Show all
Unified · Split
| @@ -0,0 +1,79 @@ | ||
| 1 | +/* | |
| 2 | + * Copyright (c) 1998, 2007, 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 | +/* | |
| 27 | + * Licensed Materials - Property of IBM | |
| 28 | + * RMI-IIOP v1.0 | |
| 29 | + * Copyright IBM Corp. 1998 1999 All Rights Reserved | |
| 30 | + * | |
| 31 | + */ | |
| 32 | + | |
| 33 | +package sun.rmi.rmic; | |
| 34 | + | |
| 35 | +import java.io.File; | |
| 36 | +import sun.tools.java.ClassDefinition; | |
| 37 | + | |
| 38 | +/** | |
| 39 | + * Generator defines the protocol for back-end implementations to be added | |
| 40 | + * to rmic. See the rmic.properties file for a description of the format for | |
| 41 | + * adding new Generators to rmic. | |
| 42 | + * <p> | |
| 43 | + * Classes implementing this interface must have a public default constructor | |
| 44 | + * which should set any required arguments to their defaults. When Main | |
| 45 | + * encounters a command line argument which maps to a specific Generator | |
| 46 | + * subclass, it will instantiate one and call parseArgs(...). At some later | |
| 47 | + * point, Main will invoke the generate(...) method once for _each_ class passed | |
| 48 | + * on the command line. | |
| 49 | + * | |
| 50 | + * WARNING: The contents of this source file are not part of any | |
| 51 | + * supported API. Code that depends on them does so at its own risk: | |
| 52 | + * they are subject to change or removal without notice. | |
| 53 | + * | |
| 54 | + * @author Bryan Atsatt | |
| 55 | + */ | |
| 56 | +public interface Generator { | |
| 57 | + | |
| 58 | + /** | |
| 59 | + * Examine and consume command line arguments. | |
| 60 | + * @param argv The command line arguments. Ignore null | |
| 61 | + * and unknown arguments. Set each consumed argument to null. | |
| 62 | + * @param main Report any errors using the main.error() methods. | |
| 63 | + * @return true if no errors, false otherwise. | |
| 64 | + */ | |
| 65 | + public boolean parseArgs(String argv[], Main main); | |
| 66 | + | |
| 67 | + /** | |
| 68 | + * Generate output. Any source files created which need compilation should | |
| 69 | + * be added to the compiler environment using the addGeneratedFile(File) | |
| 70 | + * method. | |
| 71 | + * | |
| 72 | + * @param env The compiler environment | |
| 73 | + * @param cdef The definition for the implementation class or interface from | |
| 74 | + * which to generate output | |
| 75 | + * @param destDir The directory for the root of the package hierarchy | |
| 76 | + * for generated files. May be null. | |
| 77 | + */ | |
| 78 | + public void generate(BatchEnvironment env, ClassDefinition cdef, File destDir); | |
| 79 | +} | |