Modifier and Type	Class and Description
pack-priv static enum	InterfaceCodeGenerator.DbusInterfaceToFqcn

Modifier and Type	Field and Description
private final String	argumentPrefix
private final String	busName
private final boolean	disableFilter
private final DocumentBuilderFactory	docFac
private final String	forcePackageName
private final Set<String>	generatedStructClassNames
private final String	introspectionData
private final Logger	logger
private final String	nodeName
private final boolean	propertyMethods

Access	Constructor and Description
public	InterfaceCodeGenerator(boolean _disableFilter, String _introspectionData, String _objectPath, String _busName, String _packageName, boolean _propertyMethods, String _argumentPrefix)

Method Summary

Modifier and Type	Method and Description
public Map<File, String>	Returns: List of Filenames and contents for the files analyze(boolean true to disable dtd-validation, false otherwise _ignoreDtd) Analyze the DBus interface given in constructor by parsing the introspection data.
private String	Returns: FQCN of the created struct class buildStructClass(String Dbus Type definition string _dbusTypeStr, String name of the struct to create _structName, ClassBuilderInfo package name for the struct class _packageName, List<ClassBuilderInfo> list of `ClassCastException`, other struct classes which may be created during struct creation will be added here _structClasses) Creates a class for a DBus Struct-Object.
pack-priv static List<Element>	Returns: List of Element, maybe empty convertToElementList(NodeList NodeList to convert _nodeList) Converts a NodeList to List<Element>.
private String	Returns: FQCN of the newly created tuple based class createTuple(List<ClassBuilderInfo.MemberOrArgument> Map with return arguments (key) and their types (value) _outputArgs, String name the tuple class should get _className, ClassBuilderInfo parent class where the tuple was required in _parentClzBldr, List<ClassBuilderInfo> list where the new created tuple class will be added to _additionalClasses, List<String> Dbus argument names and data types _dbusOutputArgTypes) Creates a Tuple extending class to encapsulate a multi-value return (which is not supported by Java natively).
private Map<File, String>	Returns: Map of files and their contents extractAll(Element interface element _ife) Extract all methods/signals etc. from the given interface element.
private List<ClassBuilderInfo>	Returns: List of `ClassBuilderInfo` which have been created (maybe empty, never null) extractMethods(Element method XML element _methodElement, ClassBuilderInfo `ClassBuilderInfo` object _clzBldr) Extract <method> elements properties.
private List<ClassBuilderInfo>	Returns: List of `ClassBuilderInfo` which have been created (maybe empty, never null) extractProperties(Element method XML element _propertyElement, ClassBuilderInfo `ClassBuilderInfo` object _clzBldr) Extract <property> elements properties.
private List<ClassBuilderInfo>	Returns: List of `ClassBuilderInfo` which have been created (maybe empty, never null) extractSignals(Element signal xml element _signalElement, ClassBuilderInfo `ClassBuilderInfo` object _clzBldr) Extract <signal> element properties.
public static void	main(String[] _args)
private static void	printHelp()
private static void	version()
pack-priv static void	writeToFile(String directory to put output files to _outputDir, Map<File, String> map of files and contents which should be created _filesToGenerate) Creates all files in the given map with the given content in the given directory.

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

busName	back to summary
private final String busName

disableFilter	back to summary
private final boolean disableFilter

docFac	back to summary
private final DocumentBuilderFactory docFac

forcePackageName	back to summary
private final String forcePackageName

generatedStructClassNames	back to summary
private final Set<String> generatedStructClassNames

introspectionData	back to summary
private final String introspectionData

logger	back to summary
private final Logger logger

nodeName	back to summary
private final String nodeName

propertyMethods	back to summary
private final boolean propertyMethods

Constructor Detail

InterfaceCodeGenerator	back to summary
public InterfaceCodeGenerator(boolean _disableFilter, String _introspectionData, String _objectPath, String _busName, String _packageName, boolean _propertyMethods, String _argumentPrefix)

Method Detail

analyze	back to summary
public Map<File, String> analyze(boolean _ignoreDtd) throws Exception Analyze the DBus interface given in constructor by parsing the introspection data. Parameters _ignoreDtd:boolean true to disable dtd-validation, false otherwise Returns:Map<File, String> List of Filenames and contents for the files Exceptions Exception: on DBUS or IO errors

analyze

back to summary

public Map<File, String> analyze(boolean _ignoreDtd) throws Exception

Analyze the DBus interface given in constructor by parsing the introspection data.

Parameters

_ignoreDtd:boolean: true to disable dtd-validation, false otherwise

Returns:Map<File, String>

List of Filenames and contents for the files

Exceptions

Exception:: on DBUS or IO errors

buildStructClass back to summary

buildStructClass	back to summary
private String buildStructClass(String _dbusTypeStr, String _structName, ClassBuilderInfo _packageName, List<ClassBuilderInfo> _structClasses) throws DBusException Creates a class for a DBus Struct-Object. Parameters _dbusTypeStr:String Dbus Type definition string _structName:String name of the struct to create _packageName:ClassBuilderInfo package name for the struct class _structClasses:List<ClassBuilderInfo> list of `ClassCastException`, other struct classes which may be created during struct creation will be added here Returns:String FQCN of the created struct class Exceptions DBusException: on Error

private String buildStructClass(String _dbusTypeStr, String _structName, ClassBuilderInfo _packageName, List<ClassBuilderInfo> _structClasses) throws DBusException

Creates a class for a DBus Struct-Object.

Parameters

_dbusTypeStr:String: Dbus Type definition string
_structName:String: name of the struct to create
_packageName:ClassBuilderInfo: package name for the struct class
_structClasses:List<ClassBuilderInfo>: list of ClassCastException, other struct classes which may be created during struct creation will be added here

Returns:String

FQCN of the created struct class

Exceptions

DBusException:: on Error

convertToElementList	back to summary
pack-priv static List<Element> convertToElementList(NodeList _nodeList) Converts a NodeList to List<Element>. Will skip all NodeList entries not compatible with Element type. Parameters _nodeList:NodeList NodeList to convert Returns:List<Element> List of Element, maybe empty

convertToElementList

back to summary

pack-priv static List<Element> convertToElementList(NodeList _nodeList)

Converts a NodeList to List<Element>. Will skip all NodeList entries not compatible with Element type.

Parameters

_nodeList:NodeList: NodeList to convert

Returns:List<Element>

List of Element, maybe empty

createTuple	back to summary
private String createTuple(List<ClassBuilderInfo.MemberOrArgument> _outputArgs, String _className, ClassBuilderInfo _parentClzBldr, List<ClassBuilderInfo> _additionalClasses, List<String> _dbusOutputArgTypes) Creates a Tuple extending class to encapsulate a multi-value return (which is not supported by Java natively). Parameters _outputArgs:List<ClassBuilderInfo.MemberOrArgument> Map with return arguments (key) and their types (value) _className:String name the tuple class should get _parentClzBldr:ClassBuilderInfo parent class where the tuple was required in _additionalClasses:List<ClassBuilderInfo> list where the new created tuple class will be added to _dbusOutputArgTypes:List<String> Dbus argument names and data types Returns:String FQCN of the newly created tuple based class

createTuple

back to summary

private String createTuple(List<ClassBuilderInfo.MemberOrArgument> _outputArgs, String _className, ClassBuilderInfo _parentClzBldr, List<ClassBuilderInfo> _additionalClasses, List<String> _dbusOutputArgTypes)

Creates a Tuple extending class to encapsulate a multi-value return (which is not supported by Java natively).

Parameters

_outputArgs:List<ClassBuilderInfo.MemberOrArgument>: Map with return arguments (key) and their types (value)
_className:String: name the tuple class should get
_parentClzBldr:ClassBuilderInfo: parent class where the tuple was required in
_additionalClasses:List<ClassBuilderInfo>: list where the new created tuple class will be added to
_dbusOutputArgTypes:List<String>: Dbus argument names and data types

Returns:String

FQCN of the newly created tuple based class

extractAll	back to summary
private Map<File, String> extractAll(Element _ife) throws IOException, DBusException Extract all methods/signals etc. from the given interface element. Parameters _ife:Element interface element Returns:Map<File, String> Map of files and their contents Exceptions IOException: when reading xml fails DBusException: when DBus fails

extractAll

back to summary

private Map<File, String> extractAll(Element _ife) throws IOException, DBusException

Extract all methods/signals etc. from the given interface element.

Parameters

_ife:Element: interface element

Returns:Map<File, String>

Map of files and their contents

Exceptions

IOException:: when reading xml fails
DBusException:: when DBus fails

extractMethods back to summary

extractMethods	back to summary
private List<ClassBuilderInfo> extractMethods(Element _methodElement, ClassBuilderInfo _clzBldr) throws IOException, DBusException Extract <method> elements properties. Parameters _methodElement:Element method XML element _clzBldr:ClassBuilderInfo `ClassBuilderInfo` object Returns:List<ClassBuilderInfo> List of `ClassBuilderInfo` which have been created (maybe empty, never null) Exceptions IOException: on IO Error DBusException: on DBus Error

private List<ClassBuilderInfo> extractMethods(Element _methodElement, ClassBuilderInfo _clzBldr) throws IOException, DBusException

Extract <method> elements properties.

Parameters

_methodElement:Element: method XML element
_clzBldr:ClassBuilderInfo: ClassBuilderInfo object

Returns:List<ClassBuilderInfo>

List of ClassBuilderInfo which have been created (maybe empty, never null)

Exceptions

IOException:: on IO Error
DBusException:: on DBus Error

extractProperties back to summary

extractProperties	back to summary
private List<ClassBuilderInfo> extractProperties(Element _propertyElement, ClassBuilderInfo _clzBldr) throws DBusException Extract <property> elements properties. Parameters _propertyElement:Element method XML element _clzBldr:ClassBuilderInfo `ClassBuilderInfo` object Returns:List<ClassBuilderInfo> List of `ClassBuilderInfo` which have been created (maybe empty, never null) Exceptions DBusException: on DBus Error

private List<ClassBuilderInfo> extractProperties(Element _propertyElement, ClassBuilderInfo _clzBldr) throws DBusException

Extract <property> elements properties.

Parameters

_propertyElement:Element: method XML element
_clzBldr:ClassBuilderInfo: ClassBuilderInfo object

Returns:List<ClassBuilderInfo>

List of ClassBuilderInfo which have been created (maybe empty, never null)

Exceptions

DBusException:: on DBus Error

extractSignals back to summary

extractSignals	back to summary
private List<ClassBuilderInfo> extractSignals(Element _signalElement, ClassBuilderInfo _clzBldr) throws IOException, DBusException Extract <signal> element properties. Parameters _signalElement:Element signal xml element _clzBldr:ClassBuilderInfo `ClassBuilderInfo` object Returns:List<ClassBuilderInfo> List of `ClassBuilderInfo` which have been created (maybe empty, never null) Exceptions IOException: on IO Error DBusException: on DBus Error

private List<ClassBuilderInfo> extractSignals(Element _signalElement, ClassBuilderInfo _clzBldr) throws IOException, DBusException

Extract <signal> element properties.

Parameters

_signalElement:Element: signal xml element
_clzBldr:ClassBuilderInfo: ClassBuilderInfo object

Returns:List<ClassBuilderInfo>

List of ClassBuilderInfo which have been created (maybe empty, never null)

Exceptions

IOException:: on IO Error
DBusException:: on DBus Error

main	back to summary
public static void main(String[] _args)

printHelp	back to summary
private static void printHelp()

version	back to summary
private static void version()

writeToFile	back to summary
pack-priv static void writeToFile(String _outputDir, Map<File, String> _filesToGenerate) Creates all files in the given map with the given content in the given directory. Parameters _outputDir:String directory to put output files to _filesToGenerate:Map<File, String> map of files and contents which should be created

writeToFile

back to summary

pack-priv static void writeToFile(String _outputDir, Map<File, String> _filesToGenerate)

Creates all files in the given map with the given content in the given directory.

Parameters

_outputDir:String: directory to put output files to
_filesToGenerate:Map<File, String>: map of files and contents which should be created

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

pack-priv final Enum InterfaceCodeGenerator.DbusInterfaceToFqcn

Class Inheritance

extends Enum<InterfaceCodeGenerator.DbusInterfaceToFqcn>

java.lang.Object
java.lang.Enum
org.freedesktop.dbus.utils.generator.InterfaceCodeGenerator.DbusInterfaceToFqcn

Field Summary

Modifier and Type	Field and Description
public static final InterfaceCodeGenerator.DbusInterfaceToFqcn	CLASSNAME
public static final InterfaceCodeGenerator.DbusInterfaceToFqcn	DBUS_INTERFACE_NAME
public static final InterfaceCodeGenerator.DbusInterfaceToFqcn	ORIG_PKGNAME
public static final InterfaceCodeGenerator.DbusInterfaceToFqcn	PACKAGENAME

Constructor Summary

Access	Constructor and Description
private	DbusInterfaceToFqcn()

Method Summary

Modifier and Type	Method and Description
public static Map<InterfaceCodeGenerator.DbusInterfaceToFqcn, String>	toFqcn(String _interfaceName)
public static InterfaceCodeGenerator.DbusInterfaceToFqcn	valueOf(String name)
public static InterfaceCodeGenerator.DbusInterfaceToFqcn[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CLASSNAME	back to summary
public static final InterfaceCodeGenerator.DbusInterfaceToFqcn CLASSNAME

DBUS_INTERFACE_NAME	back to summary
public static final InterfaceCodeGenerator.DbusInterfaceToFqcn DBUS_INTERFACE_NAME

ORIG_PKGNAME	back to summary
public static final InterfaceCodeGenerator.DbusInterfaceToFqcn ORIG_PKGNAME

PACKAGENAME	back to summary
public static final InterfaceCodeGenerator.DbusInterfaceToFqcn PACKAGENAME

Constructor Detail

DbusInterfaceToFqcn	back to summary
private DbusInterfaceToFqcn()

Method Detail

toFqcn	back to summary
public static Map<InterfaceCodeGenerator.DbusInterfaceToFqcn, String> toFqcn(String _interfaceName)

valueOf	back to summary
public static InterfaceCodeGenerator.DbusInterfaceToFqcn valueOf(String name)

values	back to summary
public static InterfaceCodeGenerator.DbusInterfaceToFqcn[] values()

public Class InterfaceCodeGenerator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum InterfaceCodeGenerator.DbusInterfaceToFqcn

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail