org.testifyproject.ClientInstance Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
A module that provides Testify's annotations
There is a newer version: 1.0.6
/*
 * Copyright 2016-2017 Testify Project.
 *
 * Licensed 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.testifyproject;

import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.BiFunction;

import org.testifyproject.annotation.Application;
import org.testifyproject.trait.PropertiesReader;

/**
 * A contract that defines methods for retrieving information about a client and communicating
 * with the application under test.
 *
 * @author saden
 * @param  the client type
 * @param  the client supplier type
 */
public interface ClientInstance extends PropertiesReader {

    /**
     * Get a unique fully qualified name associated with the virtual resource.
     *
     * @return the virtual resource's fully qualified name
     */
    String getFqn();

    /**
     * Get the application annotation associated with the client instance.
     *
     * @return the application annotation
     */
    Application getApplication();

    /**
     * Get client instance.
     *
     * @return the client instance
     */
    Instance getClient();

    /**
     * Get the client supplier instance.
     *
     * @return optional with the client supplier, empty optional otherwise
     */
    Optional> getClientSupplier();

    /**
     * Execute the given function with the {@link #getClient()} value and
     * {@link #getClientSupplier()} value as its parameters. If client supplier is not present
     * {@code null} will passed in as client supplier value.
     *
     * @param  function return type
     * @param function the function
     * @return the result of executing the function
     */
    default  R query(BiFunction function) {
        return function.apply(
                getClient().getValue(),
                getClientSupplier().map(Instance::getValue).orElse(null)
        );
    }

    /**
     * Execute the given consumer function with the {@link #getClient()} value and
     * {@link #getClientSupplier()} value as its parameters. If client supplier is not present
     * {@code null} will passed in as client supplier value.
     *
     * @param consumer the consumer function
     */
    default void command(BiConsumer consumer) {
        consumer.accept(
                getClient().getValue(),
                getClientSupplier().map(Instance::getValue).orElse(null)
        );
    }
}