How bjornbakke/solid works
Project Overview
• The entire repository is structured as a multi-module Maven project. The top-level project (named “SOLID”) serves as the container, and each subdirectory (e.g., decoratorPattern, dependencyInversionPrinciple, finiteStateMachinePattern, etc.) represents an independent module showcasing a specific design pattern or principle.
• The primary purpose is educational: to provide example implementations of key design concepts (such as the Decorator Pattern, Dependency Inversion Principle, Finite State Machine Pattern, Liskov Substitution Principle, Open/Closed Principle, Specification Pattern, Strategy Pattern using Enums, Tell-Don’t Ask, Template Pattern, and usage of Generics).
Main Components
• Parent Container: Represent the overall SOLID project as the high-level container or “umbrella” project.
• Individual Modules: Each module should be illustrated as a separate component/block:
• decoratorPattern
• dependencyInversionPrinciple
• finiteStateMachinePattern
• liskovsSubstitutionPrinciple
• openClosedPrinciple
• specificationPattern
• strategyPatternUsingEnums
• tellDontAsk
• templatePattern
• generics
• Each module contains its own source packages, mostly organized under standard Maven directories (src/main/java). Though you do not need to detail every class, note a couple of the sub-packages (e.g., “com/eniro/productmaster” in the decoratorPattern module) can be mentioned as examples if needed.
Relationships and Interactions
• Since these modules are designed to be standalone demonstrations of different patterns, emphasize their independence. They are not necessarily interacting with one another directly; instead, the common relationship is with the parent project.
• However, you might want to show the shared dependencies such as the Maven build system and the common usage of Java (JDK 11+).
• That each module’s functionality (e.g., order entry, customer data, state management) is encapsulated and illustrates a particular design principle.
Architectural Patterns and Technologies
• Use of design patterns: for instance, how the decoratorPattern module uses both base classes and decorator classes, and similarly how specificationPattern features abstract and composite specifications.
• Clear segregation of concerns in each module which aligns with SOLID principles.
• Mention that the project uses Maven for build management, ensuring that each module is correctly compiled, tested, and executed independently.
• Fact that the project is structured following standard Java package conventions along with a proper modular design that adheres to clean code principles (as encouraged by the SOLID principles).