Index (Metaschema XML and JSON Schema Generator 3.0.0.M2 API)

A C D F G H I J M N P S T V X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractGenerationState<WRITER,DATATYPE_MANAGER extends dev.metaschema.schemagen.datatype.IDatatypeManager> - Class in dev.metaschema.schemagen: Provides a common base implementation for schema generation state management.
AbstractGenerationState(IModule, WRITER, IConfiguration<SchemaGenerationFeature<?>>, DATATYPE_MANAGER) - Constructor for class dev.metaschema.schemagen.AbstractGenerationState: Construct a new generation state instance.
AbstractGenerationState.AllowedValueCollection - Class in dev.metaschema.schemagen: Represents a collection of allowed values with a flag indicating whether the value set is closed (no other values allowed) or open.
AbstractSchemaGenerator<T extends AutoCloseable,D extends dev.metaschema.schemagen.datatype.IDatatypeManager,S extends AbstractGenerationState<T,D>> - Class in dev.metaschema.schemagen: Thsi abstract class provides a common implementation shared by all schema generators.
AbstractSchemaGenerator() - Constructor for class dev.metaschema.schemagen.AbstractSchemaGenerator
addReference(INamedInstance) - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Adds a reference to this definition from the specified instance.
AllowedValueCollection(boolean, List<IAllowedValue>) - Constructor for class dev.metaschema.schemagen.AbstractGenerationState.AllowedValueCollection: Construct a new allowed value collection.
analyzeDefinitions(S, BiConsumer<ModuleIndex.DefinitionEntry, IDefinition>) - Method in class dev.metaschema.schemagen.AbstractSchemaGenerator: Determine the collection of root definitions.

C

CHOICE_NOT_INLINE - Static variable in interface dev.metaschema.schemagen.IInlineStrategy: A strategy that inlines definitions unless they are used in a choice group.
ChoiceNotInlineStrategy - Class in dev.metaschema.schemagen: An inline strategy that inlines definitions unless they are contained within a choice block.
ChoiceNotInlineStrategy() - Constructor for class dev.metaschema.schemagen.ChoiceNotInlineStrategy

D

DEFINED_AS_INLINE - Static variable in interface dev.metaschema.schemagen.IInlineStrategy: A strategy that inlines definitions based on their IDefinition.isInline() property.
DefinitionEntry(IDefinition) - Constructor for class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Constructs a new definition entry for the specified definition.
dev.metaschema.schemagen - module dev.metaschema.schemagen: Modules used by the Metaschema schema generator.
dev.metaschema.schemagen - package dev.metaschema.schemagen: Provides schema generation capabilities for Metaschema modules.
dev.metaschema.schemagen.json - package dev.metaschema.schemagen.json: Provides JSON Schema generation from Metaschema modules.
dev.metaschema.schemagen.xml - package dev.metaschema.schemagen.xml: Provides XML Schema (XSD) generation from Metaschema modules.

F

filterFlags(Collection<? extends IFlagInstance>, IFlagInstance) - Static method in class dev.metaschema.schemagen.FlagInstanceFilter: Filters flag instances by excluding the specified JSON key flag.
filterFlags(Collection<? extends IFlagInstance>, IFlagInstance, IFlagInstance) - Static method in class dev.metaschema.schemagen.FlagInstanceFilter: Filters flag instances by excluding both the JSON key flag and JSON value key flag.
FlagInstanceFilter - Class in dev.metaschema.schemagen: A utility class for filtering flag instances during schema generation.
flushWriter() - Method in interface dev.metaschema.schemagen.IGenerationState: Flush any buffered content to the underlying writer.

G

generateFromModule(IModule, Writer, IConfiguration<SchemaGenerationFeature<?>>) - Method in class dev.metaschema.schemagen.AbstractSchemaGenerator
generateFromModule(IModule, Writer, IConfiguration<SchemaGenerationFeature<?>>) - Method in interface dev.metaschema.schemagen.ISchemaGenerator: Generate and write a schema for the provided metaschema to the Writer provided by writer using the provided configuration.
generateSchema(IModule, Writer, ISchemaGenerator.SchemaFormat, IConfiguration<SchemaGenerationFeature<?>>) - Static method in interface dev.metaschema.schemagen.ISchemaGenerator: Generate a schema for the provided module and write it to the specified writer.
generateSchema(IModule, Path, ISchemaGenerator.SchemaFormat, IConfiguration<SchemaGenerationFeature<?>>) - Static method in interface dev.metaschema.schemagen.ISchemaGenerator: Generate a schema for the provided module and write it to the specified file path.
generateSchema(JsonGenerationState) - Method in class dev.metaschema.schemagen.json.JsonSchemaGenerator
generateSchema(XmlGenerationState) - Method in class dev.metaschema.schemagen.xml.XmlSchemaGenerator
generateSchema(S) - Method in class dev.metaschema.schemagen.AbstractSchemaGenerator: Called to generate the actual schema content.
generateSchemaMetadata(IModule, XmlGenerationState) - Static method in class dev.metaschema.schemagen.xml.XmlSchemaGenerator: Generates the schema metadata annotation containing module information.
getContextIndependentEnumeratedValues(IValuedDefinition) - Static method in class dev.metaschema.schemagen.AbstractGenerationState: Retrieve any allowed values that are context independent, meaning they always apply regardless of the location of the node in the larger graph.
getDatatypeManager() - Method in class dev.metaschema.schemagen.AbstractGenerationState: Get the datatype manager used for type name resolution.
getDefinition() - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Retrieves the definition associated with this entry.
getDefinitions() - Method in class dev.metaschema.schemagen.ModuleIndex: Retrieves all definition entries in this index.
getEntry(IDefinition) - Method in class dev.metaschema.schemagen.ModuleIndex: Retrieves or creates the entry for the specified definition.
getJsonFactory() - Method in class dev.metaschema.schemagen.json.JsonSchemaGenerator: Retrieves the JSON factory used by this generator.
getMetaschemaIndex() - Method in class dev.metaschema.schemagen.AbstractGenerationState: Get the module index containing indexed definitions from the module.
getModule() - Method in class dev.metaschema.schemagen.AbstractGenerationState
getModule() - Method in interface dev.metaschema.schemagen.IGenerationState: Get the Metaschema module being processed for schema generation.
getReferences() - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Retrieves all instances that reference this definition.
getRootDefinitions() - Method in interface dev.metaschema.schemagen.IGenerationState: Get the collection of root assembly definitions exported by the module.
getSchemaGenerator() - Method in enum dev.metaschema.schemagen.ISchemaGenerator.SchemaFormat: Get the schema generator implementation for this format.
getTypeNameForDefinition(IDefinition, String) - Method in class dev.metaschema.schemagen.AbstractGenerationState
getTypeNameForDefinition(IDefinition, String) - Method in interface dev.metaschema.schemagen.IGenerationState: Generate a type name for the provided definition with an optional suffix.
getValues() - Method in class dev.metaschema.schemagen.AbstractGenerationState.AllowedValueCollection: Get the list of allowed values.
getWriter() - Method in class dev.metaschema.schemagen.AbstractGenerationState
getWriter() - Method in interface dev.metaschema.schemagen.IGenerationState: Get the writer used for schema output.
getXmlOutputFactory() - Method in class dev.metaschema.schemagen.xml.XmlSchemaGenerator: Retrieves the XML output factory used by this generator.

H

hasEntry(IDefinition) - Method in class dev.metaschema.schemagen.ModuleIndex: Checks if an entry exists in this index for the specified definition.

I

IGenerationState<WRITER> - Interface in dev.metaschema.schemagen: Represents the state information used during schema generation.
IInlineStrategy - Interface in dev.metaschema.schemagen: A strategy for determining whether a definition should be inlined in the generated schema or referenced as a separate type definition.
indexDefinitions(IModule, IInlineStrategy) - Static method in class dev.metaschema.schemagen.ModuleIndex: Creates an index of all definitions reachable from the module's root assembly definitions.
INLINE_CHOICE_DEFINITIONS - Static variable in class dev.metaschema.schemagen.SchemaGenerationFeature: If enabled, child definitions of a choice that are defined inline will be generated as inline types.
INLINE_DEFINITIONS - Static variable in class dev.metaschema.schemagen.SchemaGenerationFeature: If enabled, definitions that are defined inline will be generated as inline types.
ISchemaGenerator - Interface in dev.metaschema.schemagen: Provides the capability to generate a schema from a Metaschema module.
ISchemaGenerator.SchemaFormat - Enum in dev.metaschema.schemagen: Identifies the supported schema generation formats.
isChoiceGroupMember() - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Checks if this definition is a member of a choice group.
isChoiceSibling() - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Checks if this definition has sibling elements in a choice group.
isClosed() - Method in class dev.metaschema.schemagen.AbstractGenerationState.AllowedValueCollection: Determine if the allowed value set is closed.
isInline() - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Checks if this definition should be inlined in the generated schema.
isInline(IDefinition) - Method in class dev.metaschema.schemagen.AbstractGenerationState
isInline(IDefinition) - Method in interface dev.metaschema.schemagen.IGenerationState: Determine if the provided definition should be inlined in the generated schema.
isInline(IDefinition, ModuleIndex) - Method in class dev.metaschema.schemagen.ChoiceNotInlineStrategy
isInline(IDefinition, ModuleIndex) - Method in interface dev.metaschema.schemagen.IInlineStrategy: Determine if the provided definition should be inlined in the generated schema.
isReferenced() - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Checks if this definition is referenced by any instance or is a root definition.
isRoot() - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Checks if this definition is a root assembly definition.
isUsedAsChoice() - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Checks if this definition is used within a choice group.
isUsedAsJsonKey() - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Checks if any reference to this definition uses a JSON key flag.
isUsedWithoutJsonKey() - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Checks if this definition is used without a JSON key flag or is a flag definition.
isVisited() - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Checks if this definition has been visited during indexing.

J

JSON - Enum constant in enum dev.metaschema.schemagen.ISchemaGenerator.SchemaFormat: a JSON Schema.
JsonSchemaGenerator - Class in dev.metaschema.schemagen.json: Generates JSON Schema documents from Metaschema modules.
JsonSchemaGenerator() - Constructor for class dev.metaschema.schemagen.json.JsonSchemaGenerator: Constructs a new JSON schema generator using a default JSON factory.
JsonSchemaGenerator(JsonFactory) - Constructor for class dev.metaschema.schemagen.json.JsonSchemaGenerator: Constructs a new JSON schema generator using the specified JSON factory.

M

markAsChoiceSibling() - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Marks this definition as having sibling elements in a choice group.
markInline() - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Marks this definition as being inlined in the generated schema.
markUsedAsChoice() - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Marks this definition as being used within a choice group.
markVisited() - Method in class dev.metaschema.schemagen.ModuleIndex.DefinitionEntry: Marks this definition as having been visited during indexing.
ModuleIndex - Class in dev.metaschema.schemagen: Indexes definitions from a Metaschema module for use in schema generation.
ModuleIndex() - Constructor for class dev.metaschema.schemagen.ModuleIndex
ModuleIndex.DefinitionEntry - Class in dev.metaschema.schemagen: Represents an entry in the module index for a single definition.

N

newGenerationState(IModule, JsonGenerator, IConfiguration<SchemaGenerationFeature<?>>) - Method in class dev.metaschema.schemagen.json.JsonSchemaGenerator
newGenerationState(IModule, AutoCloser<XMLStreamWriter2, SchemaGenerationException>, IConfiguration<SchemaGenerationFeature<?>>) - Method in class dev.metaschema.schemagen.xml.XmlSchemaGenerator
newGenerationState(IModule, T, IConfiguration<SchemaGenerationFeature<?>>) - Method in class dev.metaschema.schemagen.AbstractSchemaGenerator: Create a new schema generation state object.
newInlineStrategy(IConfiguration<SchemaGenerationFeature<?>>) - Static method in interface dev.metaschema.schemagen.IInlineStrategy: Create a new inline strategy based on the provided configuration.
newWriter(Writer) - Method in class dev.metaschema.schemagen.AbstractSchemaGenerator: Create a new writer to use to write the schema.
newWriter(Writer) - Method in class dev.metaschema.schemagen.json.JsonSchemaGenerator
newWriter(Writer) - Method in class dev.metaschema.schemagen.xml.XmlSchemaGenerator
NONE_INLINE - Static variable in interface dev.metaschema.schemagen.IInlineStrategy: A strategy that never inlines any definition.
NS_XHTML - Static variable in class dev.metaschema.schemagen.xml.XmlSchemaGenerator: The XHTML namespace URI used for documentation content.
NS_XML_SCHEMA - Static variable in class dev.metaschema.schemagen.xml.XmlSchemaGenerator: The XML Schema namespace URI.

P

PREFIX_XML_SCHEMA - Static variable in class dev.metaschema.schemagen.xml.XmlSchemaGenerator: The namespace prefix for XML Schema elements.

S

SchemaGenerationException - Exception in dev.metaschema.schemagen: Indicates an unrecoverable error occurred during schema generation.
SchemaGenerationException() - Constructor for exception dev.metaschema.schemagen.SchemaGenerationException: Constructs a new schema generation exception with no detail message.
SchemaGenerationException(String) - Constructor for exception dev.metaschema.schemagen.SchemaGenerationException: Constructs a new schema generation exception with the specified detail message.
SchemaGenerationException(String, Throwable) - Constructor for exception dev.metaschema.schemagen.SchemaGenerationException: Constructs a new schema generation exception with the specified detail message and cause.
SchemaGenerationException(Throwable) - Constructor for exception dev.metaschema.schemagen.SchemaGenerationException: Constructs a new schema generation exception with the specified cause.
SchemaGenerationFeature<V> - Class in dev.metaschema.schemagen: Configuration options for schema generation.

T

toCamelCase(String) - Static method in interface dev.metaschema.schemagen.IGenerationState: Convert a text string to camel case by splitting on punctuation and capitalizing each segment.

V

valueOf(String) - Static method in enum dev.metaschema.schemagen.ISchemaGenerator.SchemaFormat: Returns the enum constant of this type with the specified name.
values() - Static method in enum dev.metaschema.schemagen.ISchemaGenerator.SchemaFormat: Returns an array containing the constants of this enum type, in the order they are declared.

X

XML - Enum constant in enum dev.metaschema.schemagen.ISchemaGenerator.SchemaFormat: an XML Schema.
XmlSchemaGenerator - Class in dev.metaschema.schemagen.xml: Generates XML Schema (XSD) documents from Metaschema modules.
XmlSchemaGenerator() - Constructor for class dev.metaschema.schemagen.xml.XmlSchemaGenerator: Constructs a new XML schema generator using the default XML output factory.
XmlSchemaGenerator(XMLOutputFactory2) - Constructor for class dev.metaschema.schemagen.xml.XmlSchemaGenerator: Constructs a new XML schema generator using the specified XML output factory.

A C D F G H I J M N P S T V X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form