io.appium.java_client.ws.CanHandleMessages Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation

Java client for Appium Mobile Webdriver

There is a newer version: 9.3.0

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 * 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 io.appium.java_client.ws;

import java.util.List;
import java.util.function.Consumer;

public interface CanHandleMessages {
    /**
     * Returns a list of all registered web socket messages handlers.
     *
     * @return The list of web socket message handlers.
     */
    List> getMessageHandlers();

    /**
     * Register a new message handler.
     *
     * @param handler a callback function, which accepts the received message as a parameter
     */
    default void addMessageHandler(Consumer handler) {
        getMessageHandlers().add(handler);
    }

    /**
     * Removes existing message handlers.
     */
    default void removeMessageHandlers() {
        getMessageHandlers().clear();
    }
}