Modifier and Type	Class and Description
pack-priv static class	StructTreeBuilder.StructTree Class to represent a tree structure.

Modifier and Type	Field and Description
private final String	argumentPrefix

Access	Constructor and Description
pack-priv	StructTreeBuilder(String _argumentPrefix)
pack-priv	StructTreeBuilder()

Method Summary

Modifier and Type	Method and Description
public String	Returns: Struct class name or Collection type name buildStructClasses(String dbus Type string _dbusSig, String name the struct should have _structName, ClassBuilderInfo class builder with the class where the struct was first seen _clzBldr, List<ClassBuilderInfo> a list, this will contain additional struct classes created, if any. Should never be null! _generatedClasses) Builds the struct(s) found in _dbusSig.
private List<StructTreeBuilder.StructTree>	Returns: List with tree structure, maybe empty - never null buildTree(String DBus type string _dbusTypeStr) Builds a tree of types based on the given DBus type definition string.
private List<StructTreeBuilder.StructTree>	Returns: List of tree elements, maybe empty, never null buildTree(ParameterizedType `ParameterizedType` object _pType) Create tree from `ParameterizedType`.
private ClassBuilderInfo	Returns: last created struct or null createNested(List<StructTreeBuilder.StructTree> List of struct tree elements _list, ClassBuilderInfo root class of this struct (maybe other struct) _root, List<ClassBuilderInfo> a list, this will contain additional struct classes created, if any. Should never be null! _classes) Create nested Struct class.
pack-priv static void	printTree(List<StructTreeBuilder.StructTree> tree to print _buildTree, int indention level (usually 0) _indent) Helper to print a StructTree to STDOUT (for debugging purposes).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

argumentPrefix	back to summary
private final String argumentPrefix

Constructor Detail

StructTreeBuilder	back to summary
pack-priv StructTreeBuilder(String _argumentPrefix)

StructTreeBuilder	back to summary
pack-priv StructTreeBuilder()

Method Detail

buildStructClasses back to summary

buildStructClasses	back to summary
public String buildStructClasses(String _dbusSig, String _structName, ClassBuilderInfo _clzBldr, List<ClassBuilderInfo> _generatedClasses) throws DBusException Builds the struct(s) found in _dbusSig. If the struct is wrapped in a `Collection`, it will be unwrapped. The resulting String will return the parent class name. This can be the Structs classname or e.g. List/Set class if the struct was wrapped in a `Collection`. Structs which are inside of another struct will get the appendix 'Struct' for each iteration. This may lead to classes with names like FooStructStructStruct (FooStruct->(InnerStruct->InnerInnerStruct)). Parameters _dbusSig:String dbus Type string _structName:String name the struct should have _clzBldr:ClassBuilderInfo class builder with the class where the struct was first seen _generatedClasses:List<ClassBuilderInfo> a list, this will contain additional struct classes created, if any. Should never be null! Returns:String Struct class name or Collection type name Exceptions DBusException: on DBus Error

public String buildStructClasses(String _dbusSig, String _structName, ClassBuilderInfo _clzBldr, List<ClassBuilderInfo> _generatedClasses) throws DBusException

Builds the struct(s) found in _dbusSig. If the struct is wrapped in a Collection, it will be unwrapped.

The resulting String will return the parent class name. This can be the Structs classname or e.g. List/Set class if the struct was wrapped in a Collection.

Structs which are inside of another struct will get the appendix 'Struct' for each iteration. This may lead to classes with names like FooStructStructStruct (FooStruct->(InnerStruct->InnerInnerStruct)).

Parameters

_dbusSig:String: dbus Type string
_structName:String: name the struct should have
_clzBldr:ClassBuilderInfo: class builder with the class where the struct was first seen
_generatedClasses:List<ClassBuilderInfo>: a list, this will contain additional struct classes created, if any. Should never be null!

Returns:String

Struct class name or Collection type name

Exceptions

DBusException:: on DBus Error

buildTree	back to summary
private List<StructTreeBuilder.StructTree> buildTree(String _dbusTypeStr) throws DBusException Builds a tree of types based on the given DBus type definition string. Parameters _dbusTypeStr:String DBus type string Returns:List<StructTreeBuilder.StructTree> List with tree structure, maybe empty - never null Exceptions DBusException: on Error

buildTree

back to summary

private List<StructTreeBuilder.StructTree> buildTree(String _dbusTypeStr) throws DBusException

Builds a tree of types based on the given DBus type definition string.

Parameters

_dbusTypeStr:String: DBus type string

Returns:List<StructTreeBuilder.StructTree>

List with tree structure, maybe empty - never null

Exceptions

DBusException:: on Error

buildTree back to summary

buildTree	back to summary
private List<StructTreeBuilder.StructTree> buildTree(ParameterizedType _pType) throws DBusException Create tree from `ParameterizedType`. Parameters _pType:ParameterizedType `ParameterizedType` object Returns:List<StructTreeBuilder.StructTree> List of tree elements, maybe empty, never null Exceptions DBusException: on error

private List<StructTreeBuilder.StructTree> buildTree(ParameterizedType _pType) throws DBusException

Create tree from ParameterizedType.

Parameters

_pType:ParameterizedType: ParameterizedType object

Returns:List<StructTreeBuilder.StructTree>

List of tree elements, maybe empty, never null

Exceptions

DBusException:: on error

createNested	back to summary
private ClassBuilderInfo createNested(List<StructTreeBuilder.StructTree> _list, ClassBuilderInfo _root, List<ClassBuilderInfo> _classes) Create nested Struct class. Parameters _list:List<StructTreeBuilder.StructTree> List of struct tree elements _root:ClassBuilderInfo root class of this struct (maybe other struct) _classes:List<ClassBuilderInfo> a list, this will contain additional struct classes created, if any. Should never be null! Returns:ClassBuilderInfo last created struct or null

createNested

back to summary

private ClassBuilderInfo createNested(List<StructTreeBuilder.StructTree> _list, ClassBuilderInfo _root, List<ClassBuilderInfo> _classes)

Create nested Struct class.

Parameters

_list:List<StructTreeBuilder.StructTree>: List of struct tree elements
_root:ClassBuilderInfo: root class of this struct (maybe other struct)
_classes:List<ClassBuilderInfo>: a list, this will contain additional struct classes created, if any. Should never be null!

Returns:ClassBuilderInfo

last created struct or null

printTree	back to summary
pack-priv static void printTree(List<StructTreeBuilder.StructTree> _buildTree, int _indent) Helper to print a StructTree to STDOUT (for debugging purposes). Parameters _buildTree:List<StructTreeBuilder.StructTree> tree to print _indent:int indention level (usually 0)

printTree

back to summary

pack-priv static void printTree(List<StructTreeBuilder.StructTree> _buildTree, int _indent)

Helper to print a StructTree to STDOUT (for debugging purposes).

Parameters

_buildTree:List<StructTreeBuilder.StructTree>: tree to print
_indent:int: indention level (usually 0)

org.freedesktop.dbus.utils.generator back to summary

pack-priv Class StructTreeBuilder.StructTree

Class Inheritance

extends Object

java.lang.Object
org.freedesktop.dbus.utils.generator.StructTreeBuilder.StructTree

Class to represent a tree structure.

Author: hypfvieh
Since: v3.0.1 - 2018-12-22

Field Summary

Modifier and Type	Field and Description
private final Class<?>	dataType
private final List<StructTreeBuilder.StructTree>	subType

Constructor Summary

Access	Constructor and Description
pack-priv	StructTree(String _dataType)

Method Summary

Modifier and Type	Method and Description
public Class<?>	getDataType()
public List<StructTreeBuilder.StructTree>	getSubType()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

dataType	back to summary
private final Class<?> dataType

subType	back to summary
private final List<StructTreeBuilder.StructTree> subType

Constructor Detail

StructTree	back to summary
pack-priv StructTree(String _dataType)

Method Detail

getDataType	back to summary
public Class<?> getDataType()

getSubType	back to summary
public List<StructTreeBuilder.StructTree> getSubType()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class StructTreeBuilder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class StructTreeBuilder.StructTree

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail