umbrello  2.35.1
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
javawriter.h
Go to the documentation of this file.
1 /*
2  SPDX-License-Identifier: GPL-2.0-or-later
3 
4  SPDX-FileCopyrightText: 2003 Brian Thomas
5  <brian.thomas@gsfc.nasa.gov>
6  SPDX-FileCopyrightText: 2004-2022 Umbrello UML Modeller Authors
7  <umbrello-devel@kde.org>
8 */
9 
10 #ifndef JAVAWRITER_H
11 #define JAVAWRITER_H
12 
13 #include "simplecodegenerator.h"
14 #include "umloperationlist.h"
15 #include "umlattributelist.h"
16 #include "umlassociationlist.h"
17 
18 class UMLOperation;
19 
30 {
31 public:
32  JavaWriter();
33  virtual ~JavaWriter();
34 
35  virtual void writeClass(UMLClassifier *c);
36 
38 
39  QStringList defaultDatatypes() const;
40 
41 private:
42  void writeClassDecl(UMLClassifier *c, QTextStream &java);
43 
44  void writeConstructor(UMLClassifier *c, QTextStream &java);
45 
46  static bool compareJavaMethod(UMLOperation *op1, UMLOperation *op2);
47 
48  static bool javaMethodInList(UMLOperation *umlOp, UMLOperationList &opl);
49 
50  void getSuperImplementedOperations(UMLClassifier *c, UMLOperationList &yetImplementedOpList, UMLOperationList &toBeImplementedOpList, bool noClassInPath = true);
51 
53 
54  void writeOperations(UMLClassifier *c, QTextStream &j);
55 
56  void writeOperations(UMLOperationList &oplist, QTextStream &j);
57 
59  UMLAttributeList &atpriv, QTextStream &java);
60 
61  void writeAssociationDecls(UMLAssociationList associations, Uml::ID::Type id, QTextStream &java);
62 
63  void writeAssociationRoleDecl(QString fieldClassName, QString roleName, QString multi,
64  QString doc, Uml::Visibility::Enum visib, QTextStream &java);
65 
67 
68  void writeAssociationMethods(UMLAssociationList associations, UMLClassifier *thisClass,
69  QTextStream &java);
70 
71  void writeAssociationRoleMethod(QString fieldClassName, QString roleName, QString multi,
73  QTextStream &java);
74 
75  void writeSingleAttributeAccessorMethods(QString fieldClassName, QString fieldVarName,
76  QString fieldName, QString description,
78  bool isFinal, QTextStream &java);
79 
80  void writeVectorAttributeAccessorMethods(QString fieldClassName, QString fieldVarName,
81  QString fieldName, QString description,
83  QTextStream &java);
84 
85  void writeComment(const QString &text, const QString &indent, QTextStream &java, bool javaDocStyle=false);
86 
87  void writeDocumentation(QString header, QString body, QString end, QString indent, QTextStream &java);
88 
89  QString getUMLObjectName(UMLObject *obj);
90 
91  QString fixTypeName(const QString& string);
92 
93  QString fixInitialStringDeclValue(const QString& val, const QString& type);
94 
95  void writeBlankLine(QTextStream& java);
96 
97  QString m_startline;
99 
100 };
101 
102 #endif // JAVAWRITER_H
UMLObject::id
virtual Uml::ID::Type id() const
Definition: umlobject.cpp:421
umlattributelist.h
JavaWriter::fixInitialStringDeclValue
QString fixInitialStringDeclValue(const QString &val, const QString &type)
Definition: javawriter.cpp:977
template.h
JavaWriter::~JavaWriter
virtual ~JavaWriter()
Definition: javawriter.cpp:40
UMLAttributeListIt
QListIterator< UMLAttribute * > UMLAttributeListIt
Definition: umlattributelist.h:14
JavaWriter::fixTypeName
QString fixTypeName(const QString &string)
Definition: javawriter.cpp:720
SimpleCodeGenerator::m_indentation
QString m_indentation
Definition: simplecodegenerator.h:72
javawriter.h
Uml::ProgrammingLanguage::Enum
Enum
Definition: basictypes.h:291
UMLClassifier::isInterface
bool isInterface() const
Definition: classifier.cpp:116
UMLAttributeList
Definition: umlattributelist.h:20
UMLObject::name
QString name() const
Definition: umlobject.cpp:207
umloperationlist.h
CodeGenerator::getHeadingFile
virtual QString getHeadingFile(const QString &file)
Definition: codegenerator.cpp:406
UMLObject::package
QString package(const QString &separator=QString(), bool includeRoot=false) const
Definition: umlobject.cpp:582
UMLOperation::getParmList
UMLAttributeList getParmList() const
Definition: operation.cpp:177
UMLTemplate::getTypeName
virtual QString getTypeName() const
Definition: template.cpp:77
CodeGenerator::cleanName
static QString cleanName(const QString &name)
Definition: codegenerator.cpp:548
Uml::Changeability::Changeable
@ Changeable
Definition: basictypes.h:203
JavaWriter::writeSingleAttributeAccessorMethods
void writeSingleAttributeAccessorMethods(QString fieldClassName, QString fieldVarName, QString fieldName, QString description, Uml::Visibility::Enum visibility, Uml::Changeability::Enum change, bool isFinal, QTextStream &java)
Definition: javawriter.cpp:671
JavaWriter::writeAssociationDecls
void writeAssociationDecls(UMLAssociationList associations, Uml::ID::Type id, QTextStream &java)
Definition: javawriter.cpp:489
Uml::ProgrammingLanguage::Java
@ Java
Definition: basictypes.h:298
operation.h
UMLAttribute::getInitialValue
QString getInitialValue() const
Definition: attribute.cpp:100
UMLClassifierListItem::getTypeName
virtual QString getTypeName() const
Definition: classifierlistitem.cpp:108
UMLClassifier::INTERFACE
@ INTERFACE
Definition: classifier.h:42
Uml::RoleType::A
@ A
Definition: basictypes.h:237
JavaWriter::getSuperImplementedOperations
void getSuperImplementedOperations(UMLClassifier *c, UMLOperationList &yetImplementedOpList, UMLOperationList &toBeImplementedOpList, bool noClassInPath=true)
Definition: javawriter.cpp:810
CodeGenerator::findObjectsRelated
static void findObjectsRelated(UMLClassifier *c, UMLPackageList &cList)
Definition: codegenerator.cpp:621
JavaWriter::JavaWriter
JavaWriter()
Definition: javawriter.cpp:31
JavaWriter::writeConstructor
void writeConstructor(UMLClassifier *c, QTextStream &java)
Definition: javawriter.cpp:699
JavaWriter::compareJavaMethod
static bool compareJavaMethod(UMLOperation *op1, UMLOperation *op2)
Definition: javawriter.cpp:765
UMLClassifier::getOpList
UMLOperationList getOpList(bool includeInherited=false, UMLClassifierSet *alreadyTraversed=0) const
Definition: classifier.cpp:939
association.h
UMLObject::isStatic
bool isStatic() const
Definition: umlobject.cpp:362
Model_Utils::hasAssociations
bool hasAssociations(UMLObject::ObjectType type)
Definition: model_utils.cpp:2364
UMLClassifierList
QList< UMLClassifier * > UMLClassifierList
Definition: umlclassifierlist.h:12
Uml::ID::Type
std::string Type
Definition: basictypes.h:371
JavaWriter::writeClassDecl
void writeClassDecl(UMLClassifier *c, QTextStream &java)
Definition: javawriter.cpp:268
JavaWriter::m_startline
QString m_startline
a , used at the end of each line
Definition: javawriter.h:97
JavaWriter::getUMLObjectName
QString getUMLObjectName(UMLObject *obj)
Definition: javawriter.cpp:993
UMLObject
The base class for UML objects.
Definition: umlobject.h:69
SimpleCodeGenerator::indent
QString indent()
Definition: simplecodegenerator.cpp:72
UMLObject::isAbstract
bool isAbstract() const
Definition: umlobject.cpp:344
JavaWriter::defaultDatatypes
QStringList defaultDatatypes() const
Definition: javawriter.cpp:735
JavaWriter::language
virtual Uml::ProgrammingLanguage::Enum language() const
Definition: javawriter.cpp:48
CodeGenerator::forceDoc
bool forceDoc() const
Definition: codegenerator.cpp:764
JavaWriter::m_isInterface
bool m_isInterface
whether or not this concept is an interface
Definition: javawriter.h:98
CodeGenerator::formatSourceCode
static QString formatSourceCode(const QString &code, const QString &indentation)
Definition: codegenerator.cpp:742
Uml::Changeability::Enum
Enum
Definition: basictypes.h:202
JavaWriter::getInterfacesOperationsToBeImplemented
void getInterfacesOperationsToBeImplemented(UMLClassifier *c, UMLOperationList &opl)
Definition: javawriter.cpp:838
Uml::Visibility::Public
@ Public
Definition: basictypes.h:46
Uml::Changeability::Frozen
@ Frozen
Definition: basictypes.h:204
Codegen_Utils::capitalizeFirstLetter
QString capitalizeFirstLetter(const QString &string)
Definition: codegen_utils.cpp:425
JavaWriter::writeOperations
void writeOperations(UMLClassifier *c, QTextStream &j)
Definition: javawriter.cpp:855
UMLObject::visibility
Uml::Visibility::Enum visibility() const
Definition: umlobject.cpp:462
attribute.h
JavaWriter
Definition: javawriter.h:29
a
QString a
Definition: petalnode.cpp:13
SimpleCodeGenerator::m_endl
QString m_endl
Definition: simplecodegenerator.h:74
Uml::Visibility::toString
QString toString(Enum item, bool mnemonic)
Definition: basictypes.cpp:93
Uml::AssociationType::Association
@ Association
Definition: basictypes.h:96
CodeGenerator::formatDoc
static QString formatDoc(const QString &text, const QString &linePrefix=QLatin1String(" *"), int lineWidth=80)
Definition: codegenerator.cpp:711
SimpleCodeGenerator
Definition: simplecodegenerator.h:29
JavaWriter::writeAttributeMethods
void writeAttributeMethods(UMLAttributeList &atpub, Uml::Visibility::Enum visibility, QTextStream &java)
Definition: javawriter.cpp:409
Uml::RoleType::B
@ B
Definition: basictypes.h:238
JavaWriter::writeDocumentation
void writeDocumentation(QString header, QString body, QString end, QString indent, QTextStream &java)
Definition: javawriter.cpp:469
JavaWriter::writeAttributeDecls
void writeAttributeDecls(UMLAttributeList &atpub, UMLAttributeList &atprot, UMLAttributeList &atpriv, QTextStream &java)
Definition: javawriter.cpp:368
c
type show c for details The hypothetical commands show w and show c should show the appropriate parts of the General Public License Of the commands you use may be called something other than show w and show c
Definition: GPL-2.0-only.txt:301
UMLObject::doc
QString doc() const
Definition: umlobject.cpp:431
visibility
Definition: visibility.py:1
UMLAttribute
Sets up attribute information.
Definition: attribute.h:22
UMLObject::isUMLDatatype
bool isUMLDatatype() const
Definition: umlobject.h:204
UMLPackageList
QList< UMLPackage * > UMLPackageList
Definition: umlpackagelist.h:11
logWarn0
#define logWarn0(s)
Definition: uml.h:538
Uml::Visibility::Enum
Enum
Definition: basictypes.h:45
JavaWriter::writeAssociationRoleDecl
void writeAssociationRoleDecl(QString fieldClassName, QString roleName, QString multi, QString doc, Uml::Visibility::Enum visib, QTextStream &java)
Definition: javawriter.cpp:527
CodeGenerator::codeGenerated
void codeGenerated(UMLClassifier *concept, bool generated)
Definition: moc_codegenerator.cpp:167
JavaWriter::writeClass
virtual void writeClass(UMLClassifier *c)
Definition: javawriter.cpp:57
JavaWriter::writeVectorAttributeAccessorMethods
void writeVectorAttributeAccessorMethods(QString fieldClassName, QString fieldVarName, QString fieldName, QString description, Uml::Visibility::Enum visibility, Uml::Changeability::Enum change, QTextStream &java)
Definition: javawriter.cpp:630
classifier.h
UMLOperation
Definition: operation.h:19
uml.h
JavaWriter::writeComment
void writeComment(const QString &text, const QString &indent, QTextStream &java, bool javaDocStyle=false)
Definition: javawriter.cpp:429
JavaWriter::javaMethodInList
static bool javaMethodInList(UMLOperation *umlOp, UMLOperationList &opl)
Definition: javawriter.cpp:792
UMLTemplateListIt
QListIterator< UMLTemplate * > UMLTemplateListIt
Definition: umltemplatelist.h:16
UMLClassifier
Information for a non-graphical Concept/Class.
Definition: classifier.h:34
debug_utils.h
umlassociationlist.h
UMLAssociation
Sets up association information.
Definition: association.h:28
UMLClassifier::CLASS
@ CLASS
Definition: classifier.h:42
UMLTemplateList
QList< UMLTemplate * > UMLTemplateList
Definition: umltemplatelist.h:13
UMLTemplate
Sets up template information.
Definition: template.h:21
simplecodegenerator.h
Uml::Visibility::Private
@ Private
Definition: basictypes.h:47
CodeGenerator::forceSections
bool forceSections() const
Definition: codegenerator.cpp:774
Uml::Visibility::Protected
@ Protected
Definition: basictypes.h:48
UMLOperationList
QList< UMLOperation * > UMLOperationList
Definition: umloperationlist.h:12
umltemplatelist.h
JavaWriter::writeAssociationMethods
void writeAssociationMethods(UMLAssociationList associations, UMLClassifier *thisClass, QTextStream &java)
Definition: javawriter.cpp:565
UMLAssociationList
QList< UMLAssociation * > UMLAssociationList
Definition: umlassociationlist.h:12
JavaWriter::writeAssociationRoleMethod
void writeAssociationRoleMethod(QString fieldClassName, QString roleName, QString multi, QString description, Uml::Visibility::Enum visib, Uml::Changeability::Enum change, QTextStream &java)
Definition: javawriter.cpp:609
SimpleCodeGenerator::findFileName
QString findFileName(UMLPackage *concept, const QString &ext)
Definition: simplecodegenerator.cpp:87
codegen_utils.h
umldoc.h
CodeGenerator::openFile
bool openFile(QFile &file, const QString &name)
Definition: codegenerator.cpp:522
UMLOperation::getSourceCode
QString getSourceCode() const
Definition: operation.cpp:523
JavaWriter::writeBlankLine
void writeBlankLine(QTextStream &java)
Definition: javawriter.cpp:1002
UMLPackage
Non-graphical information for a Package.
Definition: package.h:27
description
static const char description[]
Definition: main.cpp:32