How to use doesForceEspressoRebuild method of io.appium.java_client.android.options.server.SupportsForceEspressoRebuildOption class

1/*
2 * Licensed under the Apache License, Version 2.0 (the "License");
3 * you may not use this file except in compliance with the License.
4 * See the NOTICE file distributed with this work for additional
5 * information regarding copyright ownership.
6 * You may obtain a copy of the License at
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package io.appium.java_client.android.options.server;
18
19import io.appium.java_client.remote.options.BaseOptions;
20import io.appium.java_client.remote.options.CanSetCapability;
21import org.openqa.selenium.Capabilities;
22
23import java.util.Optional;
24
25import static io.appium.java_client.internal.CapabilityHelpers.toSafeBoolean;
26
27public interface SupportsForceEspressoRebuildOption<T extends BaseOptions<T>> extends
28        Capabilities, CanSetCapability<T> {
29    String FORCE_ESPRESSO_REBUILD_OPTION = "forceEspressoRebuild";
30
31    /**
32     * Enforces Espresso server rebuild on a new session startup.
33     *
34     * @return self instance for chaining.
35     */
36    default T forceEspressoRebuild() {
37        return amend(FORCE_ESPRESSO_REBUILD_OPTION, true);
38    }
39
40    /**
41     * Whether to always enforce Espresso server rebuild (true).
42     * By default, Espresso caches the already built server apk and only rebuilds
43     * it when it is necessary, because rebuilding process needs extra time.
44     * false by default.
45     *
46     * @param value True to force Espresso server rebuild on a new session startup.
47     * @return self instance for chaining.
48     */
49    default T setForceEspressoRebuild(boolean value) {
50        return amend(FORCE_ESPRESSO_REBUILD_OPTION, value);
51    }
52
53    /**
54     * Get to force Espresso server rebuild on a new session startup.
55     *
56     * @return True or false.
57     */
58    default Optional<Boolean> doesForceEspressoRebuild() {
59        return Optional.ofNullable(
60                toSafeBoolean(getCapability(FORCE_ESPRESSO_REBUILD_OPTION))
61        );
62    }
63}
64

Source: SupportsForceEspressoRebuildOption.java

/*
 * 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.android.options.server;

import io.appium.java_client.remote.options.BaseOptions;
import io.appium.java_client.remote.options.CanSetCapability;
import org.openqa.selenium.Capabilities;

import java.util.Optional;

import static io.appium.java_client.internal.CapabilityHelpers.toSafeBoolean;

public interface SupportsForceEspressoRebuildOption<T extends BaseOptions<T>> extends
        Capabilities, CanSetCapability<T> {
    String FORCE_ESPRESSO_REBUILD_OPTION = "forceEspressoRebuild";

    /**
     * Enforces Espresso server rebuild on a new session startup.
     *
     * @return self instance for chaining.
     */
    default T forceEspressoRebuild() {
        return amend(FORCE_ESPRESSO_REBUILD_OPTION, true);
    }

    /**
     * Whether to always enforce Espresso server rebuild (true).
     * By default, Espresso caches the already built server apk and only rebuilds
     * it when it is necessary, because rebuilding process needs extra time.
     * false by default.
     *
     * @param value True to force Espresso server rebuild on a new session startup.
     * @return self instance for chaining.
     */
    default T setForceEspressoRebuild(boolean value) {
        return amend(FORCE_ESPRESSO_REBUILD_OPTION, value);
    }

    /**
     * Get to force Espresso server rebuild on a new session startup.
     *
     * @return True or false.
     */
    default Optional<Boolean> doesForceEspressoRebuild() {
        return Optional.ofNullable(
                toSafeBoolean(getCapability(FORCE_ESPRESSO_REBUILD_OPTION))
        );
    }
}