Spine Base Libraries Reference

website·Indexed 32 days ago

https://spine.io/docs

Technical documentation for Spine base libraries, including the model-compiler, proto-js-plugin, plugin-base, and core utilities for type URLs, reflection, and Gradle task management.

Tokens
1.7M
Snippets
13.1K
Records
17.4K
Agent score
62%

What's inside Spine

  1. Overview of the Advice class in config_change.pb

    The Advice class is a Protobuf-generated message within the config_change.pb library. It inherits from GeneratedMessage and is used to represent advice related to API configuration changes. It supports Dart null safety and provides standard Protobuf functionality for serialization, deserialization, and field management.
  2. Overview of ProjectionRepository

    The ProjectionRepository is an abstract base class used to manage Projection instances. It extends EventDispatchingRepository and provides the core infrastructure for maintaining projection states. Its primary purpose is to handle the lifecycle of projections and facilitate the 'catch-up' process, where projection states are rebuilt by replaying historical events from the Bounded Context's EventStore.
    public abstract class ProjectionRepository<I, P extends Projection<I, S, ? extends Object>, S extends EntityState> 
        extends EventDispatchingRepository<I, E, S>
  3. Overview of Spine base library packages

    The Spine base library provides a set of foundational JVM packages for building applications, including utilities for data handling, networking, and validation. Key packages include:

    • io.spine.annotation: Common annotation types for Java code and Proto type generated classes.
    • io.spine.base: Base data classes for commands, events, errors, and rejections.
    • io.spine.environment: Environment checking classes and interfaces.
    • io.spine.io: I/O operation utility classes.
    • io.spine.json: JSON utility classes.
    • io.spine.logging: SLF4J-based logging utilities.
    • io.spine.net & io.spine.net.string: Internet data types and their stringifiers.
    • io.spine.protobuf: Utilities for Google Protobuf Java implementation.
    • io.spine.reflect: Java Reflection utilities.
    • io.spine.string: Object-to-string conversion and parsing interfaces.
    • io.spine.type: Basic types for framework value objects.
    • io.spine.util: General utilities for client, server, and business model compiler code.
    • io.spine.validate.diags: Classes for explaining validation constraint violations.
    • io.spine.validate.option: Options and factories for message validation.
    • io.spine.value: Base classes for value objects.