#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF 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
#
#     https://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 abc import abstractmethod
from typing import Type

from plc4py.api.PlcDriver import PlcDriver


class PlcDriverLoader:
    """
    Abstract class for Plc Driver Loaders.
    Each method should use the @hookimpl decorator to indicate it is a driver loader
    """

    @staticmethod
    @abstractmethod
    def get_driver() -> Type[PlcDriver]:
        """
        :return Type[PlcDriver]: Returns the PlcDriver class that is used to instantiate the driver
        """
        pass

    @staticmethod
    @abstractmethod
    def key() -> str:
        """
        :return str: Unique key to identify the driver
        """
        pass
