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

Go to download
/*
 * File: FluentApplicationSchema.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.ComposableOption;
import com.oracle.tools.Option;

import java.util.List;

/**
 * An {@link ApplicationSchema} extension defining {@link ApplicationSchema} specific
 * fluent-methods.
 * 
 * Copyright (c) 2014. 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} that can be configured by the {@link FluentApplicationSchema}
 * @param   the type of {@link FluentApplicationSchema} that will be returned from fluent methods
 */
public interface FluentApplicationSchema>
    extends ApplicationSchema
{
    /**
     * Adds an {@link ApplicationListener} to be notified of life-cycle events
     * on {@link Application}s produced by the {@link FluentApplicationSchema}.
     *
     * @param listener  the {@link ApplicationListener}
     *
     * @return  the {@link FluentApplicationSchema} to permit fluent-style method invocation
     */
    public S addApplicationListener(ApplicationListener listener);


    /**
     * Adds an additional argument to use when starting the {@link Application}.
     *
     * @param argument  the additional argument for the {@link Application}
     *
     * @return  the {@link FluentApplicationSchema} to permit fluent-style method invocation
     */
    public S addArgument(String argument);


    /**
     * Adds multiple arguments to use when starting the {@link Application}.
     *
     * @param arguments  the additional arguments for the {@link Application}
     *
     * @return  the {@link FluentApplicationSchema} to permit fluent-style method invocation
     */
    public S addArguments(String... arguments);


    /**
     * Adds multiple arguments to use when starting the {@link Application}.
     *
     * @param arguments  the additional arguments for the {@link Application}
     *
     * @return  the {@link FluentApplicationSchema} to permit fluent-style method invocation
     */
    public S addArguments(List arguments);


    /**
     * Sets (and replaces) the arguments to use when starting the {@link Application}.
     *
     * @param arguments  the arguments for the {@link Application}
     *
     * @return  the {@link FluentApplicationSchema} to permit fluent-style method invocation
     */
    public S setArguments(String... arguments);


    /**
     * Sets (and replaces) the arguments to use when starting the {@link Application}.
     *
     * @param arguments  the arguments for the {@link Application}
     *
     * @return  the {@link FluentApplicationSchema} to permit fluent-style method invocation
     */
    public S setArguments(List arguments);


    /**
     * Sets (and replaces all of) the default {@link Option}s to use when starting the {@link Application}.
     *
     * @param options  the {@link Option}s
     *
     * @return  the {@link FluentApplicationSchema} to permit fluent-style method invocation
     */
    public S setOptions(Option... options);


    /**
     * Adds default {@link Option}s to use when starting the {@link Application}.
     * 

     * {@link Option}s that are composable (ie: implement {@link ComposableOption})
     * will be composed with existing {@link Option}s of the same type.  {@link Option}s
     * that are not composable, will replace existing {@link Option}s of the same type.
     *
     * @param options  the {@link Option}s to add/compose
     *
     * @return  the {@link FluentApplicationSchema} to permit fluent-style method invocation
     */
    public S addOptions(Option... options);


    /**
     * Adds a default {@link Option} to use when starting the {@link Application}.
     * 
     * If the {@link Option} is composable (ie: implements {@link ComposableOption})
     * it be composed with an existing {@link Option} of the same type.  If the
     * {@link Option} is not composable, will replace existing {@link Option}s of the same type.
     *
     * @param option  the {@link Option} to add/compose
     *
     * @return  the {@link FluentApplicationSchema} to permit fluent-style method invocation
     */
    public S addOption(Option option);


    /**
     * Adds a default {@link Option} to use when starting the {@link Application},
     * if an {@link Option} of the same type is not already defined.
     *
     * @param option  the {@link Option} to add
     *
     * @return  the {@link FluentApplicationSchema} to permit fluent-style method invocation
     */
    public S addOptionIfAbsent(Option option);
}