# Licensed to the Software Freedom Conservancy (SFC) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The SFC licenses this file
# to you 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.

from typing import Optional

from appium.options.common.supports_capabilities import SupportsCapabilities

RESET_ON_SESSION_START_ONLY = 'resetOnSessionStartOnly'


class ResetOnSessionStartOnlyOption(SupportsCapabilities):
    @property
    def reset_on_session_start_only(self) -> Optional[bool]:
        """
        Whether to perform Simulator reset on test session finish (false) or not (true).
        """
        return self.get_capability(RESET_ON_SESSION_START_ONLY)

    @reset_on_session_start_only.setter
    def reset_on_session_start_only(self, value: bool) -> None:
        """
        Whether to perform reset on test session finish (false) or not (true).
        Keeping this variable set to true and Simulator running (the default
        behaviour since version 1.6.4) may significantly shorten the duration of
        test session initialization.
        """
        self.set_capability(RESET_ON_SESSION_START_ONLY, value)
