Package ghidra.trace.model.target.schema

Class SchemaBuilder

java.lang.Object

ghidra.trace.model.target.schema.SchemaBuilder

public class SchemaBuilder
extends Object

A builder for a TraceObjectSchema.

Field Summary

Fields

Modifier and Type	Field	Description
static final TraceObjectSchema.AttributeSchema	DEFAULT_ATTRIBUTE_SCHEMA
static final TraceObjectSchema.SchemaName	DEFAULT_ELEMENT_SCHEMA

Constructor Summary

Constructors

Constructor	Description
SchemaBuilder(DefaultSchemaContext context, TraceObjectSchema schema)
SchemaBuilder(DefaultSchemaContext context, TraceObjectSchema.SchemaName name)

Method Summary

Modifier and Type	Method	Description
SchemaBuilder	addAttributeAlias(String from, String to, Object origin)
SchemaBuilder	addAttributeSchema(TraceObjectSchema.AttributeSchema schema, Object origin)	Define the schema for a child attribute.
SchemaBuilder	addElementSchema(String index, TraceObjectSchema.SchemaName schema, Object origin)	Define the schema for a child element
SchemaBuilder	addInterface(Class<? extends TraceObjectInterface> iface)
TraceObjectSchema	build()
TraceObjectSchema	buildAndAdd()
TraceObjectSchema	buildAndReplace()
TraceObjectSchema.AttributeSchema	getAttributeSchema(String name)
Map<String,TraceObjectSchema.AttributeSchema>	getAttributeSchemas()
TraceObjectSchema.AttributeSchema	getDefaultAttributeSchema()
TraceObjectSchema.SchemaName	getDefaultElementSchema()
Map<String,TraceObjectSchema.SchemaName>	getElementSchemas()
Set<Class<? extends TraceObjectInterface>>	getInterfaces()
Class<?>	getType()
boolean	isCanonicalContaineration()
SchemaBuilder	removeAttributeSchema(String name)
SchemaBuilder	removeElementSchema(String index)
SchemaBuilder	removeInterface(Class<? extends TraceObjectInterface> iface)
SchemaBuilder	replaceAttributeAlias(String from, String to, Object origin)
SchemaBuilder	replaceAttributeSchema(TraceObjectSchema.AttributeSchema schema, Object origin)
SchemaBuilder	setCanonicalContainer(boolean isCanonicalContainer)
SchemaBuilder	setDefaultAttributeSchema(TraceObjectSchema.AttributeSchema defaultAttributeSchema)
SchemaBuilder	setDefaultElementSchema(TraceObjectSchema.SchemaName defaultElementSchema)
SchemaBuilder	setInterfaces(Set<Class<? extends TraceObjectInterface>> interfaces)
SchemaBuilder	setType(Class<?> type)
protected void	validateAlias(String from, String to)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_ELEMENT_SCHEMA

public static final TraceObjectSchema.SchemaName DEFAULT_ELEMENT_SCHEMA

DEFAULT_ATTRIBUTE_SCHEMA

public static final TraceObjectSchema.AttributeSchema DEFAULT_ATTRIBUTE_SCHEMA

Constructor Details

SchemaBuilder

public SchemaBuilder(DefaultSchemaContext context,
 TraceObjectSchema.SchemaName name)

SchemaBuilder

public SchemaBuilder(DefaultSchemaContext context,
 TraceObjectSchema schema)

Method Details

setType

public SchemaBuilder setType(Class<?> type)

getType

public Class<?> getType()

setInterfaces

public SchemaBuilder setInterfaces(Set<Class<? extends TraceObjectInterface>> interfaces)

getInterfaces

public Set<Class<? extends TraceObjectInterface>> getInterfaces()

addInterface

public SchemaBuilder addInterface(Class<? extends TraceObjectInterface> iface)

removeInterface

public SchemaBuilder removeInterface(Class<? extends TraceObjectInterface> iface)

setCanonicalContainer

public SchemaBuilder setCanonicalContainer(boolean isCanonicalContainer)

isCanonicalContaineration

public boolean isCanonicalContaineration()

addElementSchema

public SchemaBuilder addElementSchema(String index,
 TraceObjectSchema.SchemaName schema,
 Object origin)

Define the schema for a child element

Parameters:

index - the index whose schema to define, or "" for the default

schema - the schema defining the element

origin - optional, for diagnostics, an object describing the element schema's origin

Returns:

this builder

removeElementSchema

public SchemaBuilder removeElementSchema(String index)

getElementSchemas

public Map<String,TraceObjectSchema.SchemaName> getElementSchemas()

setDefaultElementSchema

public SchemaBuilder setDefaultElementSchema(TraceObjectSchema.SchemaName defaultElementSchema)

getDefaultElementSchema

public TraceObjectSchema.SchemaName getDefaultElementSchema()

addAttributeSchema

public SchemaBuilder addAttributeSchema(TraceObjectSchema.AttributeSchema schema,
 Object origin)

Define the schema for a child attribute.

If the attribute schema's name is empty, the given schema becomes the default attribute schema.

Parameters:

schema - the attribute schema to add to the definition

origin - optional, for diagnostics, an object describing the attribute schema's origin

Returns:

this builder

removeAttributeSchema

public SchemaBuilder removeAttributeSchema(String name)

getAttributeSchemas

public Map<String,TraceObjectSchema.AttributeSchema> getAttributeSchemas()

getAttributeSchema

public TraceObjectSchema.AttributeSchema getAttributeSchema(String name)

replaceAttributeSchema

public SchemaBuilder replaceAttributeSchema(TraceObjectSchema.AttributeSchema schema,
 Object origin)

validateAlias

protected void validateAlias(String from,
 String to)

addAttributeAlias

public SchemaBuilder addAttributeAlias(String from,
 String to,
 Object origin)

replaceAttributeAlias

public SchemaBuilder replaceAttributeAlias(String from,
 String to,
 Object origin)

setDefaultAttributeSchema

public SchemaBuilder setDefaultAttributeSchema(TraceObjectSchema.AttributeSchema defaultAttributeSchema)

getDefaultAttributeSchema

public TraceObjectSchema.AttributeSchema getDefaultAttributeSchema()

buildAndAdd

public TraceObjectSchema buildAndAdd()

buildAndReplace

public TraceObjectSchema buildAndReplace()

build

public TraceObjectSchema build()