Modifier and Type	Class and Description
public static class	ClassBuilderInfo.AnnotationInfo Contains information about annotation to place on classes, members or methods.
public static class	ClassBuilderInfo.ClassConstructor Pojo which represents a class constructor.
public static class	ClassBuilderInfo.ClassMethod Pojo which represents a class method.
public static enum	ClassBuilderInfo.ClassType Enum to define either the `ClassBuilderInfo` is for a CLASS or an INTERFACE.
public static class	ClassBuilderInfo.MemberOrArgument Pojo which represents a class member/field or argument.

Field Summary

Modifier and Type	Field and Description
private final List<ClassBuilderInfo.AnnotationInfo>	annotations Annotations of this class.
private final String	argumentPrefix Prefix to prepend to method/constructor arguments.
private String	className Name of this class.
private ClassBuilderInfo.ClassType	classType Type of this class (interface or class).
private final List<ClassBuilderInfo.ClassConstructor>	constructors Constructors for this class.
private String	dbusPackageName Package name used by DBus.
private static final String	DEFAULT_INDENT
private String	extendClass Class which this class may extend.
private final Set<String>	implementedInterfaces Interfaces implemented by this class.
private final Set<String>	imports Imported files for this class.
private final List<ClassBuilderInfo>	innerClasses Inner classes inside of this class.
private final List<ClassBuilderInfo.MemberOrArgument>	members Members/Fields of this class.
private final List<ClassBuilderInfo.ClassMethod>	methods Methods provided by this class.
private String	packageName Package of this class.

Constructor Summary

Access	Constructor and Description
public	ClassBuilderInfo() Create new instance without argument prefix.
public	ClassBuilderInfo(String prepend given prefix to all method/constructor arguments _argumentPrefix) Create new instance.

Method Summary

Modifier and Type	Method and Description
private static void	addEmptyLineIfNeeded(List<String> _content)
public String	Returns: String createClassFileContent() Create the Java source for the class information provided.
private List<String>	createClassFileContent(boolean this is static inner class _staticClass, Set<String> this class needs additional imports (e.g. due to inner class) _otherImports) Create the Java source for the class information provided.
public List<ClassBuilderInfo.AnnotationInfo>	getAnnotations()
public String	getClassName()
pack-priv static String	Returns: classname, null if input was null getClassName(String fqcn to analyze _fqcn) Extract the class name from a given FQCN (fully qualified classname).
public ClassBuilderInfo.ClassType	getClassType()
public List<ClassBuilderInfo.ClassConstructor>	getConstructors()
public String	getDbusPackageName()
public String	getExtendClass()
public String	Returns: String, null if class name was null getFileName() Create the filename with path this java class should use.
public String	Returns: String getFqcn() Creates the fully qualified classname based on the provided classname and package.
public Set<String>	getImplementedInterfaces()
public Set<String>	getImports()
pack-priv static Set<String>	Returns: set of classes required for imports getImportsForType(String type described in the string format _type) Get all classes that should be imported for the input type, this method works fine with generic types.
public List<ClassBuilderInfo>	getInnerClasses()
public List<ClassBuilderInfo.MemberOrArgument>	getMembers()
public List<ClassBuilderInfo.ClassMethod>	getMethods()
public String	getPackageName()
pack-priv static String	Returns: type with simplified class names getSimpleTypeClasses(String type described in the string format _type) Simplify class names in the type.
private static String	maybePrefix(String _arg, String _prefix)
public void	setClassName(String _className)
public void	setClassType(ClassBuilderInfo.ClassType _classType)
public void	setDbusPackageName(String _dbusPackageName)
public void	setExtendClass(String _extendClass)
public void	setPackageName(String _packageName)
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

annotations	back to summary
private final List<ClassBuilderInfo.AnnotationInfo> annotations Annotations of this class.

argumentPrefix	back to summary
private final String argumentPrefix Prefix to prepend to method/constructor arguments.

className	back to summary
private String className Name of this class.

classType	back to summary
private ClassBuilderInfo.ClassType classType Type of this class (interface or class).

constructors	back to summary
private final List<ClassBuilderInfo.ClassConstructor> constructors Constructors for this class.

dbusPackageName	back to summary
private String dbusPackageName Package name used by DBus.

DEFAULT_INDENT	back to summary
private static final String DEFAULT_INDENT

extendClass	back to summary
private String extendClass Class which this class may extend.

implementedInterfaces	back to summary
private final Set<String> implementedInterfaces Interfaces implemented by this class.

imports	back to summary
private final Set<String> imports Imported files for this class.

innerClasses	back to summary
private final List<ClassBuilderInfo> innerClasses Inner classes inside of this class.

members	back to summary
private final List<ClassBuilderInfo.MemberOrArgument> members Members/Fields of this class.

methods	back to summary
private final List<ClassBuilderInfo.ClassMethod> methods Methods provided by this class.

packageName	back to summary
private String packageName Package of this class.

Constructor Detail

ClassBuilderInfo	back to summary
public ClassBuilderInfo() Create new instance without argument prefix.

ClassBuilderInfo	back to summary
public ClassBuilderInfo(String _argumentPrefix) Create new instance. Parameters _argumentPrefix:String prepend given prefix to all method/constructor arguments

ClassBuilderInfo

back to summary

public ClassBuilderInfo(String _argumentPrefix)

Create new instance.

Parameters

_argumentPrefix:String: prepend given prefix to all method/constructor arguments

Method Detail

addEmptyLineIfNeeded	back to summary
private static void addEmptyLineIfNeeded(List<String> _content)

createClassFileContent	back to summary
public String createClassFileContent() Create the Java source for the class information provided. Returns:String String

createClassFileContent

back to summary

public String createClassFileContent()

Create the Java source for the class information provided.

Returns:String: String

createClassFileContent	back to summary
private List<String> createClassFileContent(boolean _staticClass, Set<String> _otherImports) Create the Java source for the class information provided. Parameters _staticClass:boolean this is static inner class _otherImports:Set<String> this class needs additional imports (e.g. due to inner class)

createClassFileContent

back to summary

private List<String> createClassFileContent(boolean _staticClass, Set<String> _otherImports)

Create the Java source for the class information provided.

Parameters

_staticClass:boolean: this is static inner class
_otherImports:Set<String>: this class needs additional imports (e.g. due to inner class)

getAnnotations	back to summary
public List<ClassBuilderInfo.AnnotationInfo> getAnnotations()

getClassName	back to summary
public String getClassName()

getClassName	back to summary
pack-priv static String getClassName(String _fqcn) Extract the class name from a given FQCN (fully qualified classname). Parameters _fqcn:String fqcn to analyze Returns:String classname, null if input was null

getClassName

back to summary

pack-priv static String getClassName(String _fqcn)

Extract the class name from a given FQCN (fully qualified classname).

Parameters

_fqcn:String: fqcn to analyze

Returns:String

classname, null if input was null

getClassType	back to summary
public ClassBuilderInfo.ClassType getClassType()

getConstructors	back to summary
public List<ClassBuilderInfo.ClassConstructor> getConstructors()

getDbusPackageName	back to summary
public String getDbusPackageName()

getExtendClass	back to summary
public String getExtendClass()

getFileName	back to summary
public String getFileName() Create the filename with path this java class should use. Returns:String String, null if class name was null

getFileName

back to summary

public String getFileName()

Create the filename with path this java class should use.

Returns:String: String, null if class name was null

getFqcn	back to summary
public String getFqcn() Creates the fully qualified classname based on the provided classname and package. Returns:String String

getFqcn

back to summary

public String getFqcn()

Creates the fully qualified classname based on the provided classname and package.

Returns:String: String

getImplementedInterfaces	back to summary
public Set<String> getImplementedInterfaces()

getImports	back to summary
public Set<String> getImports()

getImportsForType	back to summary
pack-priv static Set<String> getImportsForType(String _type) Get all classes that should be imported for the input type, this method works fine with generic types. Please go to unit tests for usage examples. Parameters _type:String type described in the string format Returns:Set<String> set of classes required for imports

getImportsForType

back to summary

pack-priv static Set<String> getImportsForType(String _type)

Get all classes that should be imported for the input type, this method works fine with generic types. Please go to unit tests for usage examples.

Parameters

_type:String: type described in the string format

Returns:Set<String>

set of classes required for imports

getInnerClasses	back to summary
public List<ClassBuilderInfo> getInnerClasses()

getMembers	back to summary
public List<ClassBuilderInfo.MemberOrArgument> getMembers()

getMethods	back to summary
public List<ClassBuilderInfo.ClassMethod> getMethods()

getPackageName	back to summary
public String getPackageName()

getSimpleTypeClasses	back to summary
pack-priv static String getSimpleTypeClasses(String _type) Simplify class names in the type. Please go to unit tests for usage examples. Parameters _type:String type described in the string format Returns:String type with simplified class names

getSimpleTypeClasses

back to summary

pack-priv static String getSimpleTypeClasses(String _type)

Simplify class names in the type. Please go to unit tests for usage examples.

Parameters

_type:String: type described in the string format

Returns:String

type with simplified class names

maybePrefix	back to summary
private static String maybePrefix(String _arg, String _prefix)

setClassName	back to summary
public void setClassName(String _className)

setClassType	back to summary
public void setClassType(ClassBuilderInfo.ClassType _classType)

setDbusPackageName	back to summary
public void setDbusPackageName(String _dbusPackageName)

setExtendClass	back to summary
public void setExtendClass(String _extendClass)

setPackageName	back to summary
public void setPackageName(String _packageName)

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

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

public Class ClassBuilderInfo.AnnotationInfo

Class Inheritance

extends Object

java.lang.Object
org.freedesktop.dbus.utils.generator.ClassBuilderInfo.AnnotationInfo

Contains information about annotation to place on classes, members or methods.

Author: hypfvieh
Since: v3.2.1 - 2019-11-13

Field Summary

Modifier and Type	Field and Description
private final Class<? extends Annotation>	annotationClass Annotation class.
private final String	annotationParams Annotation params (e.g. value = "foo", key = "bar").

Constructor Summary

Access	Constructor and Description
public	AnnotationInfo(Class<? extends Annotation> _annotationClass, String _annotationParams)

Method Summary

Modifier and Type	Method and Description
public Class<? extends Annotation>	getAnnotationClass()
public String	getAnnotationParams()

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

Field Detail

annotationClass	back to summary
private final Class<? extends Annotation> annotationClass Annotation class.

annotationParams	back to summary
private final String annotationParams Annotation params (e.g. value = "foo", key = "bar").

Constructor Detail

AnnotationInfo	back to summary
public AnnotationInfo(Class<? extends Annotation> _annotationClass, String _annotationParams)

Method Detail

getAnnotationClass	back to summary
public Class<? extends Annotation> getAnnotationClass()

getAnnotationParams	back to summary
public String getAnnotationParams()

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

public Class ClassBuilderInfo.ClassConstructor

Class Inheritance

extends Object

java.lang.Object
org.freedesktop.dbus.utils.generator.ClassBuilderInfo.ClassConstructor

Pojo which represents a class constructor.

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

Field Summary

Modifier and Type	Field and Description
private final List<ClassBuilderInfo.MemberOrArgument>	arguments Map of arguments for the constructor.
private static final String	CONSTRUCTOR_TEMPL
private final List<ClassBuilderInfo.MemberOrArgument>	superArguments Map of arguments for the super-constructor.
private final List<String>	throwArguments List of throws arguments.

Constructor Summary

Access	Constructor and Description
public	ClassConstructor()

Method Summary

Modifier and Type	Method and Description
public String	argumentsAsString(Set<String> _allImports, String _prefix)
public List<String>	generatedCode(String _indent, String _className, String _argumentPrefix, Set<String> _allImports)
public List<ClassBuilderInfo.MemberOrArgument>	getArguments()
public List<ClassBuilderInfo.MemberOrArgument>	getSuperArguments()
public List<String>	getThrowArguments()
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

arguments	back to summary
private final List<ClassBuilderInfo.MemberOrArgument> arguments Map of arguments for the constructor. Key is argument name, value is argument type.

CONSTRUCTOR_TEMPL	back to summary
private static final String CONSTRUCTOR_TEMPL

superArguments	back to summary
private final List<ClassBuilderInfo.MemberOrArgument> superArguments Map of arguments for the super-constructor. Key is argument name, value is argument type.

throwArguments	back to summary
private final List<String> throwArguments List of throws arguments.

Constructor Detail

ClassConstructor	back to summary
public ClassConstructor()

Method Detail

argumentsAsString	back to summary
public String argumentsAsString(Set<String> _allImports, String _prefix)

generatedCode	back to summary
public List<String> generatedCode(String _indent, String _className, String _argumentPrefix, Set<String> _allImports)

getArguments	back to summary
public List<ClassBuilderInfo.MemberOrArgument> getArguments()

getSuperArguments	back to summary
public List<ClassBuilderInfo.MemberOrArgument> getSuperArguments()

getThrowArguments	back to summary
public List<String> getThrowArguments()

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

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

public Class ClassBuilderInfo.ClassMethod

Class Inheritance

extends Object

java.lang.Object
org.freedesktop.dbus.utils.generator.ClassBuilderInfo.ClassMethod

Pojo which represents a class method.

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

Field Summary

Modifier and Type	Field and Description
private final List<String>	annotations List of annotations for this method.
private final List<ClassBuilderInfo.MemberOrArgument>	arguments Arguments for this method, key is argument name, value is argument type.
private final boolean	finalMethod True if method should be final, false otherwise.
private static final String	METHOD_TEMPL
private final String	name Name of this method.
private final String	returnType Return value of the method.

Constructor Summary

Access	Constructor and Description
public	ClassMethod(String _name, String _returnType, boolean _finalMethod)

Method Summary

Modifier and Type	Method and Description
public List<String>	generateCode(boolean _isInterface, String _argumentPrefix, String _indent, Set<String> _allImports)
public List<String>	getAnnotations()
public List<ClassBuilderInfo.MemberOrArgument>	getArguments()
public String	getName()
public String	getReturnType()
public boolean	isFinalMethod()

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

Field Detail

annotations	back to summary
private final List<String> annotations List of annotations for this method.

arguments	back to summary
private final List<ClassBuilderInfo.MemberOrArgument> arguments Arguments for this method, key is argument name, value is argument type.

finalMethod	back to summary
private final boolean finalMethod True if method should be final, false otherwise.

METHOD_TEMPL	back to summary
private static final String METHOD_TEMPL

name	back to summary
private final String name Name of this method.

returnType	back to summary
private final String returnType Return value of the method.

Constructor Detail

ClassMethod	back to summary
public ClassMethod(String _name, String _returnType, boolean _finalMethod)

Method Detail

generateCode	back to summary
public List<String> generateCode(boolean _isInterface, String _argumentPrefix, String _indent, Set<String> _allImports)

getAnnotations	back to summary
public List<String> getAnnotations()

getArguments	back to summary
public List<ClassBuilderInfo.MemberOrArgument> getArguments()

getName	back to summary
public String getName()

getReturnType	back to summary
public String getReturnType()

isFinalMethod	back to summary
public boolean isFinalMethod()

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

public final Enum ClassBuilderInfo.ClassType

Class Inheritance

extends Enum<ClassBuilderInfo.ClassType>

java.lang.Object
java.lang.Enum
org.freedesktop.dbus.utils.generator.ClassBuilderInfo.ClassType

Enum to define either the ClassBuilderInfo is for a CLASS or an INTERFACE.

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

Field Summary

Modifier and Type	Field and Description
public static final ClassBuilderInfo.ClassType	CLASS
public static final ClassBuilderInfo.ClassType	INTERFACE

Constructor Summary

Access	Constructor and Description
private	ClassType()

Method Summary

Modifier and Type	Method and Description
public static ClassBuilderInfo.ClassType	valueOf(String name)
public static ClassBuilderInfo.ClassType[]	values()

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

Field Detail

CLASS	back to summary
public static final ClassBuilderInfo.ClassType CLASS

INTERFACE	back to summary
public static final ClassBuilderInfo.ClassType INTERFACE

Constructor Detail

ClassType	back to summary
private ClassType()

Method Detail

valueOf	back to summary
public static ClassBuilderInfo.ClassType valueOf(String name)

values	back to summary
public static ClassBuilderInfo.ClassType[] values()

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

public Class ClassBuilderInfo.MemberOrArgument

Class Inheritance

extends Object

java.lang.Object
org.freedesktop.dbus.utils.generator.ClassBuilderInfo.MemberOrArgument

Pojo which represents a class member/field or argument.

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

Field Summary

Modifier and Type	Field and Description
private final List<String>	annotations List of annotations for this member.
private final boolean	finalArg True to force this member to be final, false otherwise.
private final List<String>	generics List of classes/types or placeholders put into diamond operators to use as generics.
private static final String	GETTER_TEMPL
private final String	name Name of member/field.
private static final String	SETTER_TEMPL
private final String	type Type of member/field (e.g. String, int...).

Constructor Summary

Access	Constructor and Description
public	MemberOrArgument(String _name, String _type, boolean _finalMember)
public	MemberOrArgument(String _name, String _type)

Method Summary

Modifier and Type	Method and Description
public String	asOneLineString(Set<String> _allImports, String _prefix, boolean _includeAnnotations)
public List<String>	generateCode(String _indent, String _prefix, Set<String> _allImports)
public List<String>	getAnnotations()
public String	getFullType(Set<String> _allImports)
public List<String>	getGenerics()
public String	getName()
public String	getType()
public boolean	isFinalArg()
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

annotations	back to summary
private final List<String> annotations List of annotations for this member.

finalArg	back to summary
private final boolean finalArg True to force this member to be final, false otherwise.

generics	back to summary
private final List<String> generics List of classes/types or placeholders put into diamond operators to use as generics.

GETTER_TEMPL	back to summary
private static final String GETTER_TEMPL

name	back to summary
private final String name Name of member/field.

SETTER_TEMPL	back to summary
private static final String SETTER_TEMPL

type	back to summary
private final String type Type of member/field (e.g. String, int...).

Constructor Detail

MemberOrArgument	back to summary
public MemberOrArgument(String _name, String _type, boolean _finalMember)

MemberOrArgument	back to summary
public MemberOrArgument(String _name, String _type)

Method Detail

asOneLineString	back to summary
public String asOneLineString(Set<String> _allImports, String _prefix, boolean _includeAnnotations)

generateCode	back to summary
public List<String> generateCode(String _indent, String _prefix, Set<String> _allImports)

getAnnotations	back to summary
public List<String> getAnnotations()

getFullType	back to summary
public String getFullType(Set<String> _allImports)

getGenerics	back to summary
public List<String> getGenerics()

getName	back to summary
public String getName()

getType	back to summary
public String getType()

isFinalArg	back to summary
public boolean isFinalArg()

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 Class ClassBuilderInfo

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ClassBuilderInfo.AnnotationInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ClassBuilderInfo.ClassConstructor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ClassBuilderInfo.ClassMethod

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ClassBuilderInfo.ClassType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ClassBuilderInfo.MemberOrArgument

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail