Package org.refcodes.schema

package org.refcodes.schema

Provides a canonical model for representing structured runtime diagnostics within the REFCODES.ORG toolkit.

This artifact defines the Schema type as a hierarchical representation of runtime state. It is used to describe the internal structure of objects in a uniform and introspectable way, supporting debugging, documentation and specification.

Types implementing the Schemable interface expose their internal structure as a Schema tree. This representation is intentionally generic and independent of concrete domains, allowing it to be reused across different layers and components.

A Schema may be rendered in various forms, for example as a human-readable, JSON-like representation via Schema.toString(), or processed using visitor-based approaches for generating alternative formats such as JSON, XML or diagrammatic representations.

The schema model is designed to be lightweight and composable, enabling consistent diagnostics across the toolkit without coupling components to specific output formats or tooling.

Please refer to the refcodes-schema: Canonical runtime diagnostics and visitor-based reports documentation for an up-to-date and detailed description on the usage of this artifact.

Class	Description
JsonVisitor	The JsonVisitor is a SchemaVisitor producing a JSON String when visiting a Schema structure.
JsonVisitor.JsonMode	The mode of operation for the JsonVisitor.
PlantUmlVisitor	The PlantUmlVisitor is a SchemaVisitor producing a PlantUML object diagram when visiting a Schema structure.
Schema	A Schema is a lightweight, recursive description of an object graph.
Schema.Builder	Builder for creating Schema instances.
Schemable<OPTS>	The Schemable mixin provides means for a data structure to describe itself as a Schema.
SchemaNotation	Predefined schema notations backed by SchemaVisitor implementations.
SchemaOntology	The SchemaOntology describes the terms used for Schema generation.
SchemaVisitor<T>	A SchemaVisitor traverses a Schema tree and produces a consolidated result.
XmlVisitor	The XmlVisitor is a SchemaVisitor producing an XML String when visiting a Schema structure.