com.oracle.bedrock.ComposableOption Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bedrock-core Show documentation

Core interfaces, classes and resources for the Bedrock modules.

There is a newer version: 7.0.5

/*
 * File: ComposableOption.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.bedrock;

/**
 * An {@link Option} that may be composed with another {@link Option}
 * of the same type to produce a new {@link Option}.
 * 
 * Copyright (c) 2014. All Rights Reserved. Oracle Corporation.

 * Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
 *
 * @author Brian Oliver
 */
public interface ComposableOption> extends Option
{
    /**
     * Composes an {@link Option} with this {@link Option} to produce a
     * new {@link Option} instance of the same type.
     *
     * @param other  the other {@link Option} to compose with this {@link Option}
     *
     * @return  the new composed {@link Option} instance
     */
    public T compose(T other);
}