How to use doesKeepKeyChains method of io.appium.java_client.ios.options.simulator.SupportsKeepKeyChainsOption 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.ios.options.simulator;
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 SupportsKeepKeyChainsOption<T extends BaseOptions<T>> extends
28        Capabilities, CanSetCapability<T> {
29    String KEEP_KEY_CHAINS_OPTION = "keepKeyChains";
30
31    /**
32     * Enforce preservation of Simulator keychains folder after full reset.
33     *
34     * @return self instance for chaining.
35     */
36    default T keepKeyChains() {
37        return amend(KEEP_KEY_CHAINS_OPTION, true);
38    }
39
40    /**
41     * Set the capability to true in order to preserve Simulator keychains folder after
42     * full reset. This feature has no effect on real devices. Defaults to false.
43     *
44     * @param value Whether to preserve Simulator keychains after full reset.
45     * @return self instance for chaining.
46     */
47    default T setKeepKeyChains(boolean value) {
48        return amend(KEEP_KEY_CHAINS_OPTION, value);
49    }
50
51    /**
52     * Get whether to preserve Simulator keychains after full reset.
53     *
54     * @return True or false.
55     */
56    default Optional<Boolean> doesKeepKeyChains() {
57        return Optional.ofNullable(toSafeBoolean(getCapability(KEEP_KEY_CHAINS_OPTION)));
58    }
59}
60

Source: SupportsKeepKeyChainsOption.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.ios.options.simulator;

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 SupportsKeepKeyChainsOption<T extends BaseOptions<T>> extends
        Capabilities, CanSetCapability<T> {
    String KEEP_KEY_CHAINS_OPTION = "keepKeyChains";

    /**
     * Enforce preservation of Simulator keychains folder after full reset.
     *
     * @return self instance for chaining.
     */
    default T keepKeyChains() {
        return amend(KEEP_KEY_CHAINS_OPTION, true);
    }

    /**
     * Set the capability to true in order to preserve Simulator keychains folder after
     * full reset. This feature has no effect on real devices. Defaults to false.
     *
     * @param value Whether to preserve Simulator keychains after full reset.
     * @return self instance for chaining.
     */
    default T setKeepKeyChains(boolean value) {
        return amend(KEEP_KEY_CHAINS_OPTION, value);
    }

    /**
     * Get whether to preserve Simulator keychains after full reset.
     *
     * @return True or false.
     */
    default Optional<Boolean> doesKeepKeyChains() {
        return Optional.ofNullable(toSafeBoolean(getCapability(KEEP_KEY_CHAINS_OPTION)));
    }
}