com.oracle.tools.runtime.ApplicationBuilder Maven / Gradle / Ivy

Go to download
/*
 * File: ApplicationBuilder.java
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * The contents of this file are subject to the terms and conditions of 
 * the Common Development and Distribution License 1.0 (the "License").
 *
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the License by consulting the LICENSE.txt file
 * distributed with this file, or by consulting https://oss.oracle.com/licenses/CDDL
 *
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file LICENSE.txt.
 *
 * MODIFICATIONS:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 */

package com.oracle.tools.runtime;

import com.oracle.tools.Option;

import com.oracle.tools.runtime.console.NullApplicationConsole;
import com.oracle.tools.runtime.console.SystemApplicationConsole;

/**
 * An internal mechanism to create {@link Application}s based on
 * {@link ApplicationSchema}s for specific {@link Platform}s.
 * 
 * Developers should generally avoid using instances of this class.  Instead
 * they should use instances of specific {@link Platform}s.
 * 

 * Copyright (c) 2011. All Rights Reserved. Oracle Corporation.

 * Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
 *
 * @author Brian Oliver
 *
 * @param   the type of {@link Application}s the {@link ApplicationBuilder}
 *             will realize
 * @param   the type of {@link Platform} the {@link ApplicationBuilder} will
 *             realize {@link Application}s upon
 */
public interface ApplicationBuilder
{
    /**
     * Obtains the {@link Platform} on which the {@link ApplicationBuilder}
     * will realize {@link Application}s.
     *
     * @return  the {@link Platform}
     */
    public P getPlatform();


    /**
     * Realizes an instance of an {@link Application}.
     *
     * @param applicationSchema  the {@link ApplicationSchema} to use for realizing the {@link Application}
     * @param applicationName    the name of the application
     * @param console            the {@link ApplicationConsole} that will be used for I/O by the
     *                           realized {@link Application}. This may be null if not required
     * @param options            the {@link Option}s to use when realizing the {@link Application}
     *
     * @return an {@link Application} representing the application realized by the {@link ApplicationBuilder}
     *
     * @throws RuntimeException when a problem occurs while starting the application
     */
    public > T realize(S                  applicationSchema,
                                                                   String             applicationName,
                                                                   ApplicationConsole console,
                                                                   Option...          options);


    /**
     * Realizes an instance of an {@link Application} (using a {@link SystemApplicationConsole}).
     *
     * @param applicationSchema  the {@link ApplicationSchema} to use for realizing the {@link Application}
     * @param applicationName    the name of the application.
     *
     * @return an {@link Application} representing the application realized by the {@link ApplicationBuilder}
     *
     * @throws RuntimeException when a problem occurs while starting the application
     */
    public > T realize(S      applicationSchema,
                                                                   String applicationName);


    /**
     * Realizes an instance of an {@link Application} (without a name and using a {@link NullApplicationConsole}).
     *
     * @param applicationSchema  the {@link ApplicationSchema} to use for realizing the {@link Application}
     *
     * @return an {@link Application} representing the application realized by the {@link ApplicationBuilder}
     *
     * @throws RuntimeException  when a problem occurs while starting the application
     */
    public > T realize(S applicationSchema);
}