| 1 | /*
|
|---|
| 2 | * Copyright 2001-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 | package org.apache.tools.ant.taskdefs.optional.jsp.compilers;
|
|---|
| 18 |
|
|---|
| 19 | import org.apache.tools.ant.BuildException;
|
|---|
| 20 | import org.apache.tools.ant.taskdefs.optional.jsp.JspC;
|
|---|
| 21 | import org.apache.tools.ant.taskdefs.optional.jsp.JspMangler;
|
|---|
| 22 |
|
|---|
| 23 | /**
|
|---|
| 24 | * The interface that all jsp compiler adapters must adher to.
|
|---|
| 25 | *
|
|---|
| 26 | * <p>A compiler adapter is an adapter that interprets the jspc's
|
|---|
| 27 | * parameters in preperation to be passed off to the compier this
|
|---|
| 28 | * adapter represents. As all the necessary values are stored in the
|
|---|
| 29 | * Jspc task itself, the only thing all adapters need is the jsp
|
|---|
| 30 | * task, the execute command and a parameterless constructor (for
|
|---|
| 31 | * reflection).</p>
|
|---|
| 32 | *
|
|---|
| 33 | */
|
|---|
| 34 |
|
|---|
| 35 | public interface JspCompilerAdapter {
|
|---|
| 36 |
|
|---|
| 37 | /**
|
|---|
| 38 | * Sets the compiler attributes, which are stored in the Jspc task.
|
|---|
| 39 | */
|
|---|
| 40 | void setJspc(JspC attributes);
|
|---|
| 41 |
|
|---|
| 42 | /**
|
|---|
| 43 | * Executes the task.
|
|---|
| 44 | *
|
|---|
| 45 | * @return has the compilation been successful
|
|---|
| 46 | */
|
|---|
| 47 | boolean execute() throws BuildException;
|
|---|
| 48 |
|
|---|
| 49 | /**
|
|---|
| 50 | * @return an instance of the mangler this compiler uses
|
|---|
| 51 | */
|
|---|
| 52 |
|
|---|
| 53 | JspMangler createMangler();
|
|---|
| 54 |
|
|---|
| 55 | /**
|
|---|
| 56 | * ask if compiler can sort out its own dependencies
|
|---|
| 57 | * @return true if the compiler wants to do its own
|
|---|
| 58 | * depends
|
|---|
| 59 | */
|
|---|
| 60 | boolean implementsOwnDependencyChecking();
|
|---|
| 61 | }
|
|---|
