zserio.runtime.typeinfo

Interface TypeInfo

All Known Implementing Classes:

TypeInfo.BitmaskTypeInfo, TypeInfo.BuiltinTypeInfo, TypeInfo.ChoiceTypeInfo, TypeInfo.CompoundTypeInfoBase, TypeInfo.EnumTypeInfo, TypeInfo.FixedSizeBuiltinTypeInfo, TypeInfo.PubsubTypeInfo, TypeInfo.RecursiveTypeInfo, TypeInfo.ServiceTypeInfo, TypeInfo.SqlDatabaseTypeInfo, TypeInfo.SqlTableTypeInfo, TypeInfo.StructTypeInfo, TypeInfo.TemplatableTypeInfoBase, TypeInfo.TypeInfoBase, TypeInfo.TypeInfoWithUnderlyingTypeBase, TypeInfo.UnionTypeInfo

public interface TypeInfo

Type information interface which is returned from the generated zserio objects. This interface provides additional schema information of the corresponded zserio object, like schema name, schema type, etc... Not all methods are implemented for all zserio objects. For example, the method getFields() is implemented for compound types only.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TypeInfo.BitmaskTypeInfo Type information class for bitmask types.
static class	TypeInfo.BuiltinTypeInfo Type information abstract base class for builtin types.
static class	TypeInfo.ChoiceTypeInfo Type information class for choice types.
static class	TypeInfo.CompoundTypeInfoBase Type information abstract base class for compound types.
static class	TypeInfo.EnumTypeInfo Type information class for enumeration types.
static class	TypeInfo.FixedSizeBuiltinTypeInfo Type information abstract base class for fixed size builtin types.
static class	TypeInfo.PubsubTypeInfo Type information class for pubsub types.
static class	TypeInfo.RecursiveTypeInfo Type info for recursive types used as a wrapper around generated static typeInfo method to prevent infinite recursion in type info definition.
static class	TypeInfo.ServiceTypeInfo Type information class for service types.
static class	TypeInfo.SqlDatabaseTypeInfo Type information class for SQL database types.
static class	TypeInfo.SqlTableTypeInfo Type information class for SQL table types.
static class	TypeInfo.StructTypeInfo Type information class for structure types.
static class	TypeInfo.TemplatableTypeInfoBase Type information abstract base class for templatable types.
static class	TypeInfo.TypeInfoBase Type information abstract base class.
static class	TypeInfo.TypeInfoWithUnderlyingTypeBase Type information abstract base class for enumeration and bitmask types.
static class	TypeInfo.UnionTypeInfo Type information class for union types.

Method Summary

Modifier and Type	Method and Description
java.util.List<ItemInfo>	getBitmaskValues() Gets the type information for bitmask type values.
byte	getBitSize() Gets the bit size of the fixed size integral schema type.
java.util.List<CaseInfo>	getCases() Gets the type information for choice type cases.
java.util.List<ColumnInfo>	getColumns() Gets the type information for SQL table columns.
java.util.List<ItemInfo>	getEnumItems() Gets the type information for enumeration type items.
java.util.List<FieldInfo>	getFields() Gets the type information for compound type fields.
java.util.List<FunctionInfo>	getFunctions() Gets the type information for compound type functions.
java.lang.Class<?>	getJavaClass() Gets the Java Class object.
JavaType	getJavaType() Gets the Java type.
java.util.List<MessageInfo>	getMessages() Gets the type information for pubsub messages.
java.util.List<MethodInfo>	getMethods() Gets the type information for service methods.
java.util.List<ParameterInfo>	getParameters() Gets the type information for compound type parameters.
java.lang.String	getSchemaName() Gets the schema name.
SchemaType	getSchemaType() Gets the schema type.
java.lang.String	getSelector() Gets the selector for choice type.
java.lang.String	getSqlConstraint() Gets the SQL table constraint.
java.util.List<TableInfo>	getTables() Gets the type information for SQL database tables.
java.util.List<TypeInfo>	getTemplateArguments() Gets the type information for template arguments.
java.lang.String	getTemplateName() Gets the full schema template name.
TypeInfo	getUnderlyingType() Gets the reference to type information of underlying zserio type.
java.util.List<java.util.function.Supplier<java.lang.Object>>	getUnderlyingTypeArguments() Gets the reference to type information of underlying zserio type arguments.
java.lang.String	getVirtualTableUsing() Gets the SQL table using specification.
boolean	isWithoutRowId() Checks if SQL table is without row id table.

Method Detail

getSchemaName

java.lang.String getSchemaName()

Gets the schema name.

Returns:

The zserio full name stored in schema.

getSchemaType

SchemaType getSchemaType()

Gets the schema type.

Returns:

The zserio type stored in schema.

getJavaType

JavaType getJavaType()

Gets the Java type.

Returns:

The Java type to which zserio type is mapped.

getJavaClass

java.lang.Class<?> getJavaClass()

Gets the Java Class object.

Returns:

The Java Class object.

getBitSize

byte getBitSize()

Gets the bit size of the fixed size integral schema type.

Returns:

The bit size of zserio type.

Throws:

ZserioError - If the zserio type is not fixed size integral (e.g. varint).

getFields

java.util.List<FieldInfo> getFields()

Gets the type information for compound type fields.

Returns:

Sequence of type informations for fields.

Throws:

ZserioError - If the zserio type is not compound type.

getParameters

java.util.List<ParameterInfo> getParameters()

Gets the type information for compound type parameters.

Returns:

Sequence of type informations for parameters.

Throws:

ZserioError - If the zserio type is not compound type.

getFunctions

java.util.List<FunctionInfo> getFunctions()

Gets the type information for compound type functions.

Returns:

Sequence of type informations for functions.

Throws:

ZserioError - If the zserio type is not compound type.

getSelector

java.lang.String getSelector()

Gets the selector for choice type.

Returns:

Selector expression of choice type.

Throws:

ZserioError - If the zserio type is not choice type.

getCases

java.util.List<CaseInfo> getCases()

Gets the type information for choice type cases.

Returns:

Sequence of type informations for choice type cases.

Throws:

ZserioError - If the zserio type is not choice type.

getUnderlyingType

TypeInfo getUnderlyingType()

Gets the reference to type information of underlying zserio type.

Returns:

Reference to type information of underlying zserio type.

Throws:

ZserioError - If the zserio type is not enumeration or bitmask type.

getUnderlyingTypeArguments

java.util.List<java.util.function.Supplier<java.lang.Object>> getUnderlyingTypeArguments()

Gets the reference to type information of underlying zserio type arguments.

Returns:

Underlying zserio type arguments.

Throws:

ZserioError - If the zserio type is not enumeration or bitmask type.

getEnumItems

java.util.List<ItemInfo> getEnumItems()

Gets the type information for enumeration type items.

Returns:

Sequence of type informations for enumeration type items.

Throws:

ZserioError - If the zserio type is not enumeration type.

getBitmaskValues

java.util.List<ItemInfo> getBitmaskValues()

Gets the type information for bitmask type values.

Returns:

Sequence of type informations for bitmask type values.

Throws:

ZserioError - If the zserio type is not bitmask type.

getColumns

java.util.List<ColumnInfo> getColumns()

Gets the type information for SQL table columns.

Returns:

Sequence of type informations for SQL table columns.

Throws:

ZserioError - If the zserio type is not SQL table type.

getSqlConstraint

java.lang.String getSqlConstraint()

Gets the SQL table constraint.

Returns:

The SQL table constraint.

Throws:

ZserioError - If the zserio type is not SQL table type.

getVirtualTableUsing

java.lang.String getVirtualTableUsing()

Gets the SQL table using specification.

Returns:

The SQL table using specification.

Throws:

ZserioError - If the zserio type is not SQL table type.

isWithoutRowId

boolean isWithoutRowId()

Checks if SQL table is without row id table.

Returns:

true if SQL table is without row id table, otherwise false.

Throws:

ZserioError - If the zserio type is not SQL table type.

getTables

java.util.List<TableInfo> getTables()

Gets the type information for SQL database tables.

Returns:

Sequence of type informations for SQL database tables.

Throws:

ZserioError - If the zserio type is not SQL database type.

getTemplateName

java.lang.String getTemplateName()

Gets the full schema template name.

Returns:

The full schema template name.

Throws:

ZserioError - If the zserio type is not templatable.

getTemplateArguments

java.util.List<TypeInfo> getTemplateArguments()

Gets the type information for template arguments.

Returns:

Sequence of type informations for template arguments.

Throws:

ZserioError - If the zserio type is not templatable.

getMessages

java.util.List<MessageInfo> getMessages()

Gets the type information for pubsub messages.

Returns:

Sequence of type informations for pubsub messages.

Throws:

ZserioError - If the zserio type is not pubsub type.

getMethods

java.util.List<MethodInfo> getMethods()

Gets the type information for service methods.

Returns:

Sequence of type informations for service methods.

Throws:

ZserioError - If the zserio type is not service type.