Source code for ooodev.adapter.lang.multi_service_factory_partial

from __future__ import annotations
from typing import Any, TYPE_CHECKING, Tuple
import uno

from com.sun.star.lang import XMultiServiceFactory
from ooo.dyn.beans.property_value import PropertyValue
from ooodev.utils.builder.default_builder import DefaultBuilder

from ooodev.exceptions import ex as mEx
from ooodev.loader import lo as mLo

if TYPE_CHECKING:
    from ooodev.utils.type_var import UnoInterface


[docs]class MultiServiceFactoryPartial: """ Partial class for ``XMultiServiceFactory``. """
[docs] def __init__(self, component: XMultiServiceFactory, interface: UnoInterface | None = XMultiServiceFactory) -> None: """ Constructor Args: component (XMultiServiceFactory): UNO Component that implements ``com.sun.star.lang.XMultiServiceFactory`` interface. interface (UnoInterface, optional): The interface to be validated. Defaults to ``XMultiServiceFactory``. """ def validate(comp: Any, obj_type: Any) -> None: if obj_type is None: return if not mLo.Lo.is_uno_interfaces(comp, obj_type): raise mEx.MissingInterfaceError(obj_type) validate(component, interface) self.__component = component
# region XMultiServiceFactory
[docs] def create_instance(self, service_name: str) -> Any: """ Creates an instance classified by the specified name. Raises: com.sun.star.uno.Exception: ``Exception`` """ return self.__component.createInstance(service_name)
[docs] def create_instance_with_arguments( self, *args: Any, service_name: str, ) -> Any: """ Creates an instance classified by the specified name and passes the arguments to that instance. Raises: com.sun.star.uno.Exception: ``Exception`` """ return self.__component.createInstanceWithArguments(service_name, args)
[docs] def create_instance_with_prop_args(self, service_name: str, **kwargs: Any) -> Any: """ Creates an instance of a service implementation initialized with some arguments. Each Key, Value pair is converted to a ``PropertyValue`` before adding to the service arguments. Args: service_name (str): The name of the service to create. kwargs (Any): One or more arguments to initialize the service. Raises: com.sun.star.uno.Exception: ``Exception`` """ # convert args to tuple pvs = [] for key, value in kwargs.items(): pv = PropertyValue(Name=key, Value=value) pvs.append(pv) if not pvs: return return self.__component.createInstanceWithArguments(service_name, tuple(pvs))
[docs] def get_available_service_names(self) -> Tuple[str, ...]: """ Provides the available names of the factory to be used to create instances. """ return self.__component.getAvailableServiceNames()
# endregion XMultiServiceFactory
[docs]def get_builder(component: Any) -> DefaultBuilder: """ Get the builder for the component. Args: component (Any): The component. Returns: DefaultBuilder: Builder instance. """ builder = DefaultBuilder(component) builder.auto_add_interface("com.sun.star.lang.XMultiServiceFactory", False) return builder