org.apache.royale.compiler.targets.IJSTarget Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of compiler-jx Show documentation

There is a newer version: 0.9.12

/*
 *
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

package org.apache.royale.compiler.targets;

import java.util.Collection;

import org.apache.royale.compiler.clients.JSConfiguration;
import org.apache.royale.compiler.driver.IBackend;
import org.apache.royale.compiler.driver.js.IJSApplication;
import org.apache.royale.compiler.problems.ICompilerProblem;
import org.apache.royale.compiler.projects.IASProject;

/**
 * The {@link IJSTarget} interface allows the compiler an abstraction to
 * how the actual JavaScript is built.
 * 
 * The interface ties into the {@link IBackend} and is created at the start of
 * compile before the {@link JSConfiguration} class is configured.
 * 
 * @author Michael Schmalle
 * 
 * @see IBackend#createJSTarget(IASProject, ITargetSettings,
 * ITargetProgressMonitor)
 */
public interface IJSTarget extends ITarget
{
    /**
     * Build the target JavaScript application and collect problems. Every time
     * the method is called, a new {@link IJSApplication} model is created.
     * 
     * @param problems compilation problems output
     * @return IJSApplication if build is a success.
     */
    IJSApplication build(Collection problems);
}