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

Go to download
/*
 * File: AbstractPlatform.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.Options;

import java.net.InetAddress;

/**
 * An abstract implementation of a {@link Platform}.
 * 
 * Copyright (c) 2014. All Rights Reserved. Oracle Corporation.

 * Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
 *
 * @author Jonathan Knight
 *
 * @param 
  the type of {@link Platform} used by {@link ApplicationBuilder}s
 */
public abstract class AbstractPlatform implements Platform
{
    /**
     * The name of this {@link Platform}.
     */
    private String name;

    /**
     * The {@link Options} for the {@link Platform}.
     */
    private Options options;


    /**
     * Construct an {@link AbstractPlatform} with the specified name.
     *
     * @param name     the name of this {@link Platform}
     * @param options  the {@link Option}s for the {@link Platform}
     */
    public AbstractPlatform(String    name,
                            Option... options)
    {
        this.name    = name;
        this.options = new Options(options);
    }


    @Override
    public String getName()
    {
        return name;
    }


    @Override
    public Options getOptions()
    {
        return options;
    }


    @Override
    public > A realize(String             applicationName,
                                                                             S                  applicationSchema,
                                                                             ApplicationConsole console,
                                                                             Option...          options)
    {
        ApplicationBuilder builder = getApplicationBuilder(applicationSchema.getApplicationClass());

        if (builder == null)
        {
            return null;
        }

        return builder.realize(applicationSchema, applicationName, console, options);
    }


    /**
     * Obtains a suitable {@link ApplicationBuilder} for a specific class of {@link Application}.
     *
     * @param   the type of {@link Application}
     * @param   the type of {@link ApplicationBuilder}
     *
     * @param applicationClass  the {@link Class} of {@link Application} for which a {@link ApplicationBuilder}
     *                          is required
     * @return  the {@link ApplicationBuilder} or null if this {@link Platform} cannot supply a builder for
     *          the specified {@link Application} {@link Class}
     */
    public abstract > B getApplicationBuilder(Class applicationClass);
}