| 1 | /*
|
|---|
| 2 | * Copyright 2001-2002,2004 The Apache Software Foundation
|
|---|
| 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 | */
|
|---|
| 17 |
|
|---|
| 18 | package org.apache.tools.ant.taskdefs.rmic;
|
|---|
| 19 |
|
|---|
| 20 | import org.apache.tools.ant.BuildException;
|
|---|
| 21 | import org.apache.tools.ant.taskdefs.Rmic;
|
|---|
| 22 | import org.apache.tools.ant.types.Path;
|
|---|
| 23 | import org.apache.tools.ant.util.FileNameMapper;
|
|---|
| 24 |
|
|---|
| 25 | /**
|
|---|
| 26 | * The interface that all rmic adapters must adher to.
|
|---|
| 27 | *
|
|---|
| 28 | * <p>A rmic adapter is an adapter that interprets the rmic's
|
|---|
| 29 | * parameters in preperation to be passed off to the compiler this
|
|---|
| 30 | * adapter represents. As all the necessary values are stored in the
|
|---|
| 31 | * Rmic task itself, the only thing all adapters need is the rmic
|
|---|
| 32 | * task, the execute command and a parameterless constructor (for
|
|---|
| 33 | * reflection).</p>
|
|---|
| 34 | *
|
|---|
| 35 | * @since Ant 1.4
|
|---|
| 36 | */
|
|---|
| 37 |
|
|---|
| 38 | public interface RmicAdapter {
|
|---|
| 39 |
|
|---|
| 40 | /**
|
|---|
| 41 | * Sets the rmic attributes, which are stored in the Rmic task.
|
|---|
| 42 | */
|
|---|
| 43 | void setRmic(Rmic attributes);
|
|---|
| 44 |
|
|---|
| 45 | /**
|
|---|
| 46 | * Executes the task.
|
|---|
| 47 | *
|
|---|
| 48 | * @return has the compilation been successful
|
|---|
| 49 | */
|
|---|
| 50 | boolean execute() throws BuildException;
|
|---|
| 51 |
|
|---|
| 52 | /**
|
|---|
| 53 | * Maps source class files to the files generated by this rmic
|
|---|
| 54 | * implementation.
|
|---|
| 55 | */
|
|---|
| 56 | FileNameMapper getMapper();
|
|---|
| 57 |
|
|---|
| 58 | /**
|
|---|
| 59 | * The CLASSPATH this rmic process will use.
|
|---|
| 60 | */
|
|---|
| 61 | Path getClasspath();
|
|---|
| 62 | }
|
|---|
