Package ghidra.trace.model.target.schema

Interface TraceObjectSchema.AttributeSchema

All Known Implementing Classes:

DefaultTraceObjectSchema.DefaultAttributeSchema

Enclosing interface:

TraceObjectSchema

public static interface TraceObjectSchema.AttributeSchema

Schema descriptor for a child attribute.

Field Summary

Fields

Modifier and Type	Field	Description
static final TraceObjectSchema.AttributeSchema	DEFAULT_ANY	A descriptor suitable as a default that imposes no restrictions.
static final TraceObjectSchema.AttributeSchema	DEFAULT_OBJECT	A descriptor suitable as a default that requires an object
static final TraceObjectSchema.AttributeSchema	DEFAULT_VOID	A descriptor suitable as a default that forbids an attribute name

Method Summary

Modifier and Type	Method	Description
TraceObjectSchema.Hidden	getHidden()
String	getName()	Get the name of the attribute
TraceObjectSchema.SchemaName	getSchema()	Get the schema name for the named attribute
boolean	isFixed()	Check if the named attribute can be modified
default boolean	isHidden(String name)	Check if the named attribute should be displayed be default
boolean	isRequired()	Check if the named attribute must always be present

Field Details

DEFAULT_ANY

static final TraceObjectSchema.AttributeSchema DEFAULT_ANY

A descriptor suitable as a default that imposes no restrictions.

DEFAULT_OBJECT

static final TraceObjectSchema.AttributeSchema DEFAULT_OBJECT

A descriptor suitable as a default that requires an object

DEFAULT_VOID

static final TraceObjectSchema.AttributeSchema DEFAULT_VOID

A descriptor suitable as a default that forbids an attribute name

Method Details

getName

String getName()

Get the name of the attribute

Returns:

the name of the attribute

getSchema

TraceObjectSchema.SchemaName getSchema()

Get the schema name for the named attribute

Returns:

the schema name

isRequired

boolean isRequired()

Check if the named attribute must always be present

Returns:

true if required, false if optional

isFixed

boolean isFixed()

Check if the named attribute can be modified

Returns:

true if immutable, false if mutable

isHidden

default boolean isHidden(String name)

Check if the named attribute should be displayed be default

This is purely a UI hint. It has no other semantic consequence.

Parameters:

name - the actual name of the attribute, in case this is the default attribute

Returns:

true if hidden, false if visible

getHidden

TraceObjectSchema.Hidden getHidden()