Package org.freedesktop.dbus.utils.generator

Class ClassBuilderInfo

java.lang.Object

org.freedesktop.dbus.utils.generator.ClassBuilderInfo

public class ClassBuilderInfo
extends java.lang.Object

Helper to create Java class/interface files with proper formatting.

Since:

v3.0.1 - 2018-12-22

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ClassBuilderInfo()

Method Summary

Modifier and Type	Method	Description
java.lang.String	createClassFileContent()	Create the Java source for the class information provided.
private java.util.List<java.lang.String>	createClassFileContent(boolean _staticClass, java.util.Set<java.lang.String> _otherImports)	Create the Java source for the class information provided.
java.util.List<ClassBuilderInfo.AnnotationInfo>	getAnnotations()
java.lang.String	getClassName()
(package private) static java.lang.String	getClassName(java.lang.String _fqcn)	Extract the class name from a given FQCN (fully qualified classname).
ClassBuilderInfo.ClassType	getClassType()
java.util.List<ClassBuilderInfo.ClassConstructor>	getConstructors()
java.lang.String	getDbusPackageName()
java.lang.String	getExtendClass()
java.lang.String	getFileName()	Create the filename with path this java class should use.
java.lang.String	getFqcn()	Creates the fully qualified classname based on the provided classname and package.
java.util.Set<java.lang.String>	getImplementedInterfaces()
java.util.Set<java.lang.String>	getImports()
(package private) static java.util.Set<java.lang.String>	getImportsForType(java.lang.String _type)	Get all classes that should be imported for the input type, this method works fine with generic types.
java.util.List<ClassBuilderInfo>	getInnerClasses()
java.util.List<ClassBuilderInfo.MemberOrArgument>	getMembers()
java.util.List<ClassBuilderInfo.ClassMethod>	getMethods()
java.lang.String	getPackageName()
(package private) static java.lang.String	getSimpleTypeClasses(java.lang.String _type)	Simplify class names in the type.
void	setClassName(java.lang.String _className)
void	setClassType(ClassBuilderInfo.ClassType _classType)
void	setDbusPackageName(java.lang.String _dbusPackageName)
void	setExtendClass(java.lang.String _extendClass)
void	setPackageName(java.lang.String _packageName)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

imports

private final java.util.Set<java.lang.String> imports

Imported files for this class.

annotations

private final java.util.List<ClassBuilderInfo.AnnotationInfo> annotations

Annotations of this class.

members

private final java.util.List<ClassBuilderInfo.MemberOrArgument> members

Members/Fields of this class.

implementedInterfaces

private final java.util.Set<java.lang.String> implementedInterfaces

Interfaces implemented by this class.

methods

private final java.util.List<ClassBuilderInfo.ClassMethod> methods

Methods provided by this class.

innerClasses

private final java.util.List<ClassBuilderInfo> innerClasses

Inner classes inside of this class.

constructors

private final java.util.List<ClassBuilderInfo.ClassConstructor> constructors

Constructors for this class.

className

private java.lang.String className

Name of this class.

packageName

private java.lang.String packageName

Package of this class.

dbusPackageName

private java.lang.String dbusPackageName

Package name used by DBus.

classType

private ClassBuilderInfo.ClassType classType

Type of this class (interface or class).

extendClass

private java.lang.String extendClass

Class which this class may extend.

Constructor Detail

ClassBuilderInfo

public ClassBuilderInfo()

Method Detail

getImports

public java.util.Set<java.lang.String> getImports()

getPackageName

public java.lang.String getPackageName()

setPackageName

public void setPackageName(java.lang.String _packageName)

getDbusPackageName

public java.lang.String getDbusPackageName()

setDbusPackageName

public void setDbusPackageName(java.lang.String _dbusPackageName)

getClassName

public java.lang.String getClassName()

setClassName

public void setClassName(java.lang.String _className)

getClassType

public ClassBuilderInfo.ClassType getClassType()

setClassType

public void setClassType(ClassBuilderInfo.ClassType _classType)

getAnnotations

public java.util.List<ClassBuilderInfo.AnnotationInfo> getAnnotations()

getImplementedInterfaces

public java.util.Set<java.lang.String> getImplementedInterfaces()

getExtendClass

public java.lang.String getExtendClass()

setExtendClass

public void setExtendClass(java.lang.String _extendClass)

getMethods

public java.util.List<ClassBuilderInfo.ClassMethod> getMethods()

getMembers

public java.util.List<ClassBuilderInfo.MemberOrArgument> getMembers()

getInnerClasses

public java.util.List<ClassBuilderInfo> getInnerClasses()

getConstructors

public java.util.List<ClassBuilderInfo.ClassConstructor> getConstructors()

createClassFileContent

public java.lang.String createClassFileContent()

Create the Java source for the class information provided.

Returns:

String

createClassFileContent

private java.util.List<java.lang.String> createClassFileContent(boolean _staticClass,
                                                                java.util.Set<java.lang.String> _otherImports)

Create the Java source for the class information provided.

Parameters:

_staticClass - this is static inner class

_otherImports - this class needs additional imports (e.g. due to inner class)

Returns:

getFileName

public java.lang.String getFileName()

Create the filename with path this java class should use.

Returns:

String, null if class name was null

getFqcn

public java.lang.String getFqcn()

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

Returns:

String

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getClassName

static java.lang.String getClassName(java.lang.String _fqcn)

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

Parameters:

_fqcn - fqcn to analyze

Returns:

classname, null if input was null

getSimpleTypeClasses

static java.lang.String getSimpleTypeClasses(java.lang.String _type)

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

Parameters:

_type - type described in the string format

Returns:

type with simplified class names

getImportsForType

static java.util.Set<java.lang.String> getImportsForType(java.lang.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 - type described in the string format

Returns:

set of classes required for imports