All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.fulib.fx.controller.building.ControllerBuildFactory Maven / Gradle / Ivy

    package org.fulib.fx.controller.building;

import javafx.util.Builder;
import javafx.util.BuilderFactory;
import org.fulib.fx.annotation.controller.Component;
import org.fulib.fx.annotation.controller.SubComponent;
import org.fulib.fx.util.ReflectionUtil;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;

import javax.inject.Provider;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import static org.fulib.fx.util.FrameworkUtil.error;

/**
 * A custom building-factory for instantiating controllers. If an element in an FXML file is of a class annotated with @Controller and a field providing an instance of the same class exists, the provided instance will be used as the controller for the element.
 */
@ApiStatus.Internal
public class ControllerBuildFactory implements BuilderFactory {

    private final Object instance;

    // Cache for subcontroller instances, mapped by class -> instance/provider
    private final Map, List> subControllerInstances;
    private final Map, Provider> subControllerProviders;

    public ControllerBuildFactory(@NotNull Object instance) {
        this.instance = instance;
        this.subControllerInstances = new HashMap<>();
        this.subControllerProviders = new HashMap<>();

        initSubControllers();
    }

    /**
     * Searches the controller class for fields annotated with @SubController and stores the instances.
     */
    private void initSubControllers() {
        ReflectionUtil.getAllNonPrivateFieldsOrThrow(instance.getClass(), SubComponent.class).forEach(field -> {

            // If the field is a provider, store it in the provider map
            if (field.getType() == Provider.class) {
                field.setAccessible(true);
                try {
                    Class type = ReflectionUtil.getProvidedClass(field);
                    if (type == null) {
                        throw new RuntimeException(error(6006).formatted(field.getName(), field.getClass().getName()));
                    }
                    if (subControllerProviders.containsKey(type)) {
                        throw new RuntimeException(error(6000).formatted(type.getName(), instance.getClass()));
                    }
                    subControllerProviders.put(type, (Provider) field.get(instance));
                } catch (IllegalAccessException e) {
                    throw new RuntimeException(error(6001).formatted(field.getName(), field.getClass().getName()), e);
                }
                return;
            }

            // If the field is not a provider, store the instance in the instance map

            if (!subControllerInstances.containsKey(field.getType())) {
                subControllerInstances.put(field.getType(), new ArrayList<>());
            }

            try {
                field.setAccessible(true);
                subControllerInstances.get(field.getType()).add(field.get(instance));
            } catch (IllegalAccessException e) {
                throw new RuntimeException(error(6002).formatted(field.getName(), field.getClass().getName()), e);
            }
        });
    }

    @Override
    public Builder getBuilder(Class type) {
        if (type.isAnnotationPresent(Component.class)) {
            return new ControllerProxyBuilder<>(this, type);
        } else {
            return null; // Let javafx handle the instantiation
        }
    }

    /**
     * Searches the controller class for a field annotated with @SubController that provides an instance of the given type.
     * If no matching field is found, the framework will look for a provider field annotated with @SubController.
     * If no matching provider is found, the framework will throw an exception.
     *
     * @param type The type of the subcontroller
     * @return The instance of the subcontroller
     */
    public Object getProvidedInstance(Class type) {
        if (subControllerInstances.containsKey(type)) {
            if (!subControllerInstances.get(type).isEmpty()) {
                // If there are multiple instances of the same type, use the first one and remove it from the list
                Object instance = subControllerInstances.get(type).get(0);
                subControllerInstances.get(type).remove(0);
                return instance;
            } else
                throw new RuntimeException(error(6003).formatted(type.getName(), instance.getClass()));
        } else if (subControllerProviders.containsKey(type)) {
            return subControllerProviders.get(type).get();
        } else {
            throw new RuntimeException(error(6004).formatted(type.getName(), instance.getClass()));
        }
    }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy