Package org.openjdk.jmc.flightrecorder.writer

Class TypesImpl

java.lang.Object

org.openjdk.jmc.flightrecorder.writer.api.Types

org.openjdk.jmc.flightrecorder.writer.TypesImpl

public final class TypesImpl
extends Types

An access class for various Type related operations

Nested Class Summary

Nested classes/interfaces inherited from class org.openjdk.jmc.flightrecorder.writer.api.Types

Types.Builtin, Types.JDK, Types.Predefined

Method Summary

Modifier and Type	Method	Description
TypedFieldBuilder	fieldBuilder(String fieldName, Type fieldType)
TypedFieldBuilder	fieldBuilder(String fieldName, Types.Builtin fieldType)
TypeImpl	getOrAdd(String name, boolean withConstantPool, Consumer<TypeStructureBuilder> builderCallback)	Retrieve the given type or create it a-new if it hasn't been added yet.
TypeImpl	getOrAdd(String name, String supertype, boolean withConstantPool, Consumer<TypeStructureBuilder> builderCallback)	Retrieve the given type or create it a-new if it hasn't been added yet.
TypeImpl	getOrAdd(String name, String supertype, boolean withConstantPool, TypeStructure typeStructure)	Retrieve the given type or create it a-new if it hasn't been added yet.
TypeImpl	getOrAdd(String name, String supertype, Consumer<TypeStructureBuilder> builderCallback)	Retrieve the given type or create it a-new if it hasn't been added yet.
TypeImpl	getOrAdd(String name, String supertype, TypeStructure typeStructure)	Retrieve the given type or create it a-new if it hasn't been added yet.
TypeImpl	getOrAdd(String name, Consumer<TypeStructureBuilder> builderCallback)	Retrieve the given type or create it a-new if it hasn't been added yet.
TypeImpl	getOrAdd(Types.Predefined type, String supertype, Consumer<TypeStructureBuilder> builderCallback)	Retrieve the given type or create it a-new if it hasn't been added yet.
TypeImpl	getOrAdd(Types.Predefined type, Consumer<TypeStructureBuilder> builderCallback)	Retrieve the given type or create it a-new if it hasn't been added yet.
TypeImpl	getType(String name)	Retrieve the type by its name.
TypeImpl	getType(String name, boolean asResolvable)	Retrieve the type by its name.
TypeImpl	getType(Types.Predefined type)	A convenience shortcut to get a Type instance corresponding to the Types.Predefined type
void	resolveAll()	Resolve all unresolved types.
TypeStructureBuilder	typeStructureBuilder()	A convenience accessor to TypeStructureBuilder instance outside of the type configuration callback

Methods inherited from class java.lang.Object

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

Method Detail

getOrAdd

public TypeImpl getOrAdd(Types.Predefined type,
                         Consumer<TypeStructureBuilder> builderCallback)

Description copied from class: Types

Retrieve the given type or create it a-new if it hasn't been added yet. The type values will be stored in an associated constant pool.

Specified by:

getOrAdd in class Types

Parameters:

type - the type to retrieve

builderCallback - will be called lazily when the type is about to be initialized

Returns:

the corresponding type instance

getOrAdd

public TypeImpl getOrAdd(String name,
                         boolean withConstantPool,
                         Consumer<TypeStructureBuilder> builderCallback)

Description copied from class: Types

Retrieve the given type or create it a-new if it hasn't been added yet.

Specified by:

getOrAdd in class Types

Parameters:

name - the name of the type to retrieve

withConstantPool - should the type values use an associated constant pool

builderCallback - will be called lazily when the type is about to be initialized

Returns:

the corresponding type instance

getOrAdd

public TypeImpl getOrAdd(Types.Predefined type,
                         String supertype,
                         Consumer<TypeStructureBuilder> builderCallback)

Description copied from class: Types

Retrieve the given type or create it a-new if it hasn't been added yet.

Specified by:

getOrAdd in class Types

Parameters:

type - the type to retrieve

supertype - the super type name

builderCallback - will be called lazily when the type is about to be initialized

Returns:

the corresponding type instance

getOrAdd

public TypeImpl getOrAdd(String name,
                         String supertype,
                         boolean withConstantPool,
                         Consumer<TypeStructureBuilder> builderCallback)

Description copied from class: Types

Retrieve the given type or create it a-new if it hasn't been added yet.

Specified by:

getOrAdd in class Types

Parameters:

name - the name of the type to retrieve

supertype - the super type name

withConstantPool - should the type values use an associated constant pool

builderCallback - will be called lazily when the type is about to be initialized

Returns:

the corresponding type instance

getOrAdd

public TypeImpl getOrAdd(String name,
                         String supertype,
                         boolean withConstantPool,
                         TypeStructure typeStructure)

Description copied from class: Types

Retrieve the given type or create it a-new if it hasn't been added yet.

Specified by:

getOrAdd in class Types

Parameters:

name - the name of the type to retrieve

supertype - the super type name

withConstantPool - should the type values use an associated constant pool

typeStructure - the type structure definition

Returns:

the corresponding type instance

getOrAdd

public TypeImpl getOrAdd(String name,
                         Consumer<TypeStructureBuilder> builderCallback)

Description copied from class: Types

Retrieve the given type or create it a-new if it hasn't been added yet.

Specified by:

getOrAdd in class Types

Parameters:

name - the name of the type to retrieve

builderCallback - will be called lazily when the type is about to be initialized

Returns:

the corresponding type instance

getOrAdd

public TypeImpl getOrAdd(String name,
                         String supertype,
                         Consumer<TypeStructureBuilder> builderCallback)

Description copied from class: Types

Retrieve the given type or create it a-new if it hasn't been added yet. The type values will be stored in an associated constant pool.

Specified by:

getOrAdd in class Types

Parameters:

name - the name of the type to retrieve

supertype - the super type name

builderCallback - will be called lazily when the type is about to be initialized

Returns:

the corresponding type instance

getOrAdd

public TypeImpl getOrAdd(String name,
                         String supertype,
                         TypeStructure typeStructure)

Description copied from class: Types

Retrieve the given type or create it a-new if it hasn't been added yet. The type values will be stored in an associated constant pool.

Specified by:

getOrAdd in class Types

Parameters:

name - the name of the type to retrieve

supertype - the super type name

typeStructure - the type structure definition

Returns:

the corresponding type instance

getType

public TypeImpl getType(String name)

Description copied from class: Types

Retrieve the type by its name.

Specified by:

getType in class Types

Parameters:

name - the type name

Returns:

the registered type or null

getType

public TypeImpl getType(String name,
                        boolean asResolvable)

Description copied from class: Types

Retrieve the type by its name. If the type hasn't been added yet a ResolvableType wrapper may be returned.

Specified by:

getType in class Types

Parameters:

name - the type name

asResolvable - if true a ResolvableType wrapper will be returned instead of null for non-existent type

Returns:

an existing Type type, null or a ResolvableType wrapper

getType

public TypeImpl getType(Types.Predefined type)

Description copied from class: Types

A convenience shortcut to get a Type instance corresponding to the Types.Predefined type

Specified by:

getType in class Types

Parameters:

type - the predefined/enum type

Returns:

the registered Type instance or a ResolvableType wrapper

typeStructureBuilder

public TypeStructureBuilder typeStructureBuilder()

Description copied from class: Types

A convenience accessor to TypeStructureBuilder instance outside of the type configuration callback

Specified by:

typeStructureBuilder in class Types

Returns:

a new TypeStructureBuilder instance

fieldBuilder

public TypedFieldBuilder fieldBuilder(String fieldName,
                                      Type fieldType)

Specified by:

fieldBuilder in class Types

Parameters:

fieldName - field name

fieldType - field type

Returns:

a new TypedFieldBuilder instance for a named field of the given type

fieldBuilder

public TypedFieldBuilder fieldBuilder(String fieldName,
                                      Types.Builtin fieldType)

Specified by:

fieldBuilder in class Types

Parameters:

fieldName - field name

fieldType - field type

Returns:

a new TypedFieldBuilder instance for a named field of the given type

resolveAll

public void resolveAll()

Resolve all unresolved types. After this method had been called all calls to ResolvableType.isResolved() will return true if the target type was properly registered