Package ghidra.trace.model.target.schema

Enum Class PrimitiveTraceObjectSchema

java.lang.Object

java.lang.Enum<PrimitiveTraceObjectSchema>

ghidra.trace.model.target.schema.PrimitiveTraceObjectSchema

All Implemented Interfaces:

TraceObjectSchema, Serializable, Comparable<PrimitiveTraceObjectSchema>, Constable

public enum PrimitiveTraceObjectSchema
extends Enum<PrimitiveTraceObjectSchema>
implements TraceObjectSchema

The schemas common to all contexts, as they describe the primitive and built-in types.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PrimitiveTraceObjectSchema.MinimalSchemaContext

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface ghidra.trace.model.target.schema.TraceObjectSchema

TraceObjectSchema.AttributeSchema, TraceObjectSchema.Hidden, TraceObjectSchema.Private, TraceObjectSchema.SchemaName

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADDRESS
ANY	The top-most type descriptor
BOOL
BOOL_ARR
BYTE
BYTE_ARR
CHAR
CHAR_ARR
EXECUTION_STATE
INT
INT_ARR
LONG
LONG_ARR
MAP_PARAMETERS
OBJECT	The least restrictive, but least informative object schema.
RANGE
SHORT
SHORT_ARR
STRING
STRING_ARR
TYPE
VOID	A type so restrictive nothing can satisfy it.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getAttributeAliases()	Get the map of attribute name aliases
Map<String,TraceObjectSchema.AttributeSchema>	getAttributeSchemas()	Get the map of attribute names to named schemas
SchemaContext	getContext()	Get the context of which this schema is a member
TraceObjectSchema.AttributeSchema	getDefaultAttributeSchema()	Get the default schema for attributes
TraceObjectSchema.SchemaName	getDefaultElementSchema()	Get the default schema for elements
Map<String,TraceObjectSchema.SchemaName>	getElementSchemas()	Get the map of element indices to named schemas
Set<Class<? extends TraceObjectInterface>>	getInterfaces()	Get the minimum interfaces supported by a conforming object
TraceObjectSchema.SchemaName	getName()	Get the name of this schema
Class<?>	getType()	Get the Java class that best represents this type.
List<Class<?>>	getTypes()
boolean	isCanonicalContainer()	Check if this object is the canonical container for its elements
static TraceObjectSchema.SchemaName	nameForPrimitive(Class<?> cls)	Get the name of a suitable enumerable schema for a given Java class
static PrimitiveTraceObjectSchema	schemaForPrimitive(Class<?> cls)	Get a suitable schema for a given Java primitive class
PathFilter	searchFor(Class<? extends TraceObjectInterface> type, boolean requireCanonical)	Do the same as TraceObjectSchema.searchFor(Class, KeyPath, boolean) with an empty prefix
KeyPath	searchForCanonicalContainer(Class<? extends TraceObjectInterface> type)	Find the (sub) path to the canonical container for objects implementing a given interface
KeyPath	searchForSuitable(Class<? extends TraceObjectInterface> type, KeyPath path)	Search for a suitable object with this schema at the given path
static PrimitiveTraceObjectSchema	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PrimitiveTraceObjectSchema[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ghidra.trace.model.target.schema.TraceObjectSchema

checkAliasedAttribute, computeFrameLevel, filterForSuitable, getAttributeSchema, getChildSchema, getChildSchemaName, getElementSchema, getSuccessorSchema, getSuccessorSchemas, isAssignableFrom, isHidden, searchFor, searchForAncestor, searchForAncestorContainer, searchForRegisterContainer, searchForSuitable, searchForSuitableContainer, validateRequiredAttributes, validateTypeAndInterfaces

Enum Constant Details

ANY

public static final PrimitiveTraceObjectSchema ANY

The top-most type descriptor

The described value can be any primitive or a TraceObject.

OBJECT

public static final PrimitiveTraceObjectSchema OBJECT

The least restrictive, but least informative object schema.

This requires nothing more than the described value to be a TraceObject.

TYPE

public static final PrimitiveTraceObjectSchema TYPE

VOID

public static final PrimitiveTraceObjectSchema VOID

A type so restrictive nothing can satisfy it.

This is how a schema specifies that a particular key is not allowed. It is commonly used as the default attribute when only certain enumerated attributes are allowed. It is also used as the type for the children of primitives, since primitives cannot have successors.

BOOL

public static final PrimitiveTraceObjectSchema BOOL

BYTE

public static final PrimitiveTraceObjectSchema BYTE

SHORT

public static final PrimitiveTraceObjectSchema SHORT

INT

public static final PrimitiveTraceObjectSchema INT

LONG

public static final PrimitiveTraceObjectSchema LONG

STRING

public static final PrimitiveTraceObjectSchema STRING

ADDRESS

public static final PrimitiveTraceObjectSchema ADDRESS

RANGE

public static final PrimitiveTraceObjectSchema RANGE

EXECUTION_STATE

public static final PrimitiveTraceObjectSchema EXECUTION_STATE

MAP_PARAMETERS

public static final PrimitiveTraceObjectSchema MAP_PARAMETERS

CHAR

public static final PrimitiveTraceObjectSchema CHAR

BOOL_ARR

public static final PrimitiveTraceObjectSchema BOOL_ARR

BYTE_ARR

public static final PrimitiveTraceObjectSchema BYTE_ARR

CHAR_ARR

public static final PrimitiveTraceObjectSchema CHAR_ARR

SHORT_ARR

public static final PrimitiveTraceObjectSchema SHORT_ARR

INT_ARR

public static final PrimitiveTraceObjectSchema INT_ARR

LONG_ARR

public static final PrimitiveTraceObjectSchema LONG_ARR

STRING_ARR

public static final PrimitiveTraceObjectSchema STRING_ARR

Method Details

values

public static PrimitiveTraceObjectSchema[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PrimitiveTraceObjectSchema valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

schemaForPrimitive

public static PrimitiveTraceObjectSchema schemaForPrimitive(Class<?> cls)

Get a suitable schema for a given Java primitive class

The term "primitive" here is used in terms of object schemas, not in terms of Java types.

Parameters:

cls - the class, which may or may not be the boxed form

Returns:

the schema or null if no schema is suitable

nameForPrimitive

public static TraceObjectSchema.SchemaName nameForPrimitive(Class<?> cls)

Get the name of a suitable enumerable schema for a given Java class

Parameters:

cls - the class, which may or may no be the boxed form

Returns:

the name or null if no schema is suitable

See Also:

• schemaForPrimitive(Class)

getContext

public SchemaContext getContext()

Description copied from interface: TraceObjectSchema

Get the context of which this schema is a member

All schema names are resolved in this same context

Specified by:

getContext in interface TraceObjectSchema

Returns:

the context

getName

public TraceObjectSchema.SchemaName getName()

Description copied from interface: TraceObjectSchema

Get the name of this schema

Specified by:

getName in interface TraceObjectSchema

Returns:

the name

getType

public Class<?> getType()

Description copied from interface: TraceObjectSchema

Get the Java class that best represents this type.

Note that this is either a primitive, or TraceObject. Even though an object implementation is necessarily a sub-type of TraceObject, for any object schema, this return TraceObject. Information about a "sub-type" of object is communicated via interfaces, element schemas, and attribute schemas.

Specified by:

getType in interface TraceObjectSchema

Returns:

the Java class for this type

getTypes

public List<Class<?>> getTypes()

getInterfaces

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

Description copied from interface: TraceObjectSchema

Get the minimum interfaces supported by a conforming object

Specified by:

getInterfaces in interface TraceObjectSchema

Returns:

the set of required interfaces

isCanonicalContainer

public boolean isCanonicalContainer()

Description copied from interface: TraceObjectSchema

Check if this object is the canonical container for its elements

This is generally in reference to the default type of this object's elements. For example, if elements of this object are all expected to support the "Process" interface, then this is the canonical Process container. Any Process ought to have a (canonical) path in this container. Any other path referring to such a Process ought to be a link.

NOTE: the concept of links is still in incubation, as some native debugging APIs seem to have made it difficult to detect object identity. Additionally, it's possible a caller's first encounter with an object is not via its canonical path, and it may be difficult to assign a path having only the native-API-given object in hand.

Specified by:

isCanonicalContainer in interface TraceObjectSchema

Returns:

true if this is a canonical container, false otherwise

getElementSchemas

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

Description copied from interface: TraceObjectSchema

Get the map of element indices to named schemas

It is uncommon for this map to be populated, since the elements of a given container are typically uniform in type. Nevertheless, there can be restrictions imposed on -- and information provided for -- specific indices.

Specified by:

getElementSchemas in interface TraceObjectSchema

Returns:

the map

getDefaultElementSchema

public TraceObjectSchema.SchemaName getDefaultElementSchema()

Description copied from interface: TraceObjectSchema

Get the default schema for elements

Since elements of a given container are typically uniform in type, this is the primary means of specifying element schemas.

Specified by:

getDefaultElementSchema in interface TraceObjectSchema

Returns:

the default named schema

getAttributeSchemas

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

Description copied from interface: TraceObjectSchema

Get the map of attribute names to named schemas

The returned map will include aliases. To determine whether or not an attribute key is an alias, check whether the entry's key matches the name of the attribute (see TraceObjectSchema.AttributeSchema.getName()). It is possible the schema's name is empty, i.e., the default schema. This indicates an alias to a key that was not named in the schema. Use TraceObjectSchema.getAttributeAliases() to determine the name of that key.

Specified by:

getAttributeSchemas in interface TraceObjectSchema

Returns:

the map

getAttributeAliases

public Map<String,String> getAttributeAliases()

Description copied from interface: TraceObjectSchema

Get the map of attribute name aliases

The returned map must provide the direct alias names. For any given key, the client need only query the map once to determine the name of the attribute to which the alias refers. Consequently, the map also cannot indicate a cycle.

An aliased attribute takes the value of its target implicitly.

Specified by:

getAttributeAliases in interface TraceObjectSchema

Returns:

the map

getDefaultAttributeSchema

public TraceObjectSchema.AttributeSchema getDefaultAttributeSchema()

Description copied from interface: TraceObjectSchema

Get the default schema for attributes

Since the expected attributes and their respective schemas are generally enumerated, this most commonly returns TraceObjectSchema.AttributeSchema.DEFAULT_ANY, to allow unrestricted use of additional attributes, or TraceObjectSchema.AttributeSchema.DEFAULT_VOID, to forbid any additional attributes.

Specified by:

getDefaultAttributeSchema in interface TraceObjectSchema

Returns:

the default attribute schema

searchFor

public PathFilter searchFor(Class<? extends TraceObjectInterface> type,
 boolean requireCanonical)

Description copied from interface: TraceObjectSchema

Do the same as TraceObjectSchema.searchFor(Class, KeyPath, boolean) with an empty prefix

Specified by:

searchFor in interface TraceObjectSchema

Parameters:

type - the sub-type of TraceObjectInterface to search for

requireCanonical - only return patterns matching a canonical location for the type

Returns:

a set of patterns where such objects could be found

searchForCanonicalContainer

public KeyPath searchForCanonicalContainer(Class<? extends TraceObjectInterface> type)

Description copied from interface: TraceObjectSchema

Find the (sub) path to the canonical container for objects implementing a given interface

If more than one container is found having the shortest path, then null is returned.

Specified by:

searchForCanonicalContainer in interface TraceObjectSchema

Parameters:

type - the sub-type of TraceObjectInterface to search for

Returns:

the single path to that container

searchForSuitable

public KeyPath searchForSuitable(Class<? extends TraceObjectInterface> type,
 KeyPath path)

Description copied from interface: TraceObjectSchema

Search for a suitable object with this schema at the given path

Specified by:

searchForSuitable in interface TraceObjectSchema

Parameters:

type - the type of object sought

path - the path of a seed object

Returns:

the expected path of the suitable object, or null