umbrello  2.34.3
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
javaclassifiercodedocument.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 <thomas@mail630.gsfc.nasa.gov>
5  SPDX-FileCopyrightText: 2004-2021 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
6 */
7 
8 #ifndef JAVACLASSIFIERCODEDOCUMENT_H
9 #define JAVACLASSIFIERCODEDOCUMENT_H
10 
11 #include "codeclassfieldlist.h"
12 #include "classifiercodedocument.h"
13 #include "classifier.h"
14 #include "hierarchicalcodeblock.h"
15 #include "javacodeclassfield.h"
16 #include "javacodeoperation.h"
17 
18 #include <QString>
19 
22 
29 {
30  Q_OBJECT
31 public:
32 
36  explicit JavaClassifierCodeDocument (UMLClassifier * classifier);
37 
41  virtual ~JavaClassifierCodeDocument ();
42 
47  //CodeDocumentDialog getDialog ();
48 
49  // Make it easier on ourselves
51 
52  QString getJavaClassName (const QString &name) const;
53 
54  QString getPath() const;
55 
60  bool addCodeOperation (CodeOperation * op);
61 
62  void updateContent();
63 
64 protected:
65 
66  // reset/clear our inventory of textblocks in this document
67  void resetTextBlocks();
68 
73  virtual void loadChildTextBlocksFromNode (QDomElement & root);
74 
76 
77  bool forceDoc ();
78 
79 private:
80 
84 
85  void init ();
87 };
88 
89 #endif // JAVACLASSIFIERCODEDOCUMENT_H
CodeClassField::Composition
@ Composition
Definition: codeclassfield.h:30
DEBUG_REGISTER
#define DEBUG_REGISTER(src)
Definition: debug_utils.h:129
ClassifierCodeDocument::getParentClassifier
UMLClassifier * getParentClassifier() const
Definition: classifiercodedocument.cpp:278
javacodecomment.h
CodeDocument::resetTextBlocks
void resetTextBlocks()
Definition: codedocument.cpp:335
logDebug1
#define logDebug1(s, a)
Definition: uml.h:539
CodeDocument::newHierarchicalCodeBlock
virtual HierarchicalCodeBlock * newHierarchicalCodeBlock()
Definition: codedocument.cpp:474
JavaCodeGenerationPolicy::getAutoGenerateAssocAccessors
bool getAutoGenerateAssocAccessors()
Definition: javacodegenerationpolicy.cpp:80
JavaCodeComment
Definition: javacodecomment.h:21
CodeGenObjectWithTextBlocks::addOrUpdateTaggedCodeBlockWithComments
CodeBlockWithComments * addOrUpdateTaggedCodeBlockWithComments(const QString &tag, const QString &text, const QString &ctext, int indentLevel, bool forceUserBlockUpdate)
Definition: codegenobjectwithtextblocks.cpp:279
UMLObject::name
QString name() const
Definition: umlobject.cpp:207
UMLObject::package
QString package(const QString &separator=QString(), bool includeRoot=false) const
Definition: umlobject.cpp:582
codeclassfieldlist.h
CodeClassField::parentIsAttribute
bool parentIsAttribute() const
Definition: codeclassfield.cpp:124
CodeGenerator::cleanName
static QString cleanName(const QString &name)
Definition: codegenerator.cpp:548
hierarchicalcodeblock.h
UMLOperation::isLifeOperation
bool isLifeOperation() const
Definition: operation.cpp:414
javacodeclassfielddeclarationblock.h
ClassifierCodeDocument::hasObjectVectorClassFields
bool hasObjectVectorClassFields() const
Definition: classifiercodedocument.cpp:127
CodeComment
Definition: codecomment.h:19
TextBlock::setWriteOutText
void setWriteOutText(bool write)
Definition: textblock.cpp:127
logError0
#define logError0(s)
Definition: uml.h:537
UniqueID::init
void init()
Definition: uniqueid.cpp:32
CodeDocument::setFileExtension
void setFileExtension(const QString &new_var)
Definition: codedocument.cpp:69
CodeGenerator::findObjectsRelated
static void findObjectsRelated(UMLClassifier *c, UMLPackageList &cList)
Definition: codegenerator.cpp:621
UMLApp::commonPolicy
CodeGenerationPolicy * commonPolicy() const
Definition: uml.cpp:2383
CodeGenObjectWithTextBlocks::addTextBlock
virtual bool addTextBlock(TextBlock *add_object)
Definition: codegenobjectwithtextblocks.cpp:56
JavaClassifierCodeDocument::~JavaClassifierCodeDocument
virtual ~JavaClassifierCodeDocument()
Definition: javaclassifiercodedocument.cpp:42
ClassifierCodeDocument::declareClassFields
void declareClassFields(CodeClassFieldList &list, CodeGenObjectWithTextBlocks *parent)
Definition: classifiercodedocument.cpp:381
CodeClassField::Aggregation
@ Aggregation
Definition: codeclassfield.h:30
UMLPackageListIt
QListIterator< UMLPackage * > UMLPackageListIt
Definition: umlpackagelist.h:14
CodeClassField::PlainAssociation
@ PlainAssociation
Definition: codeclassfield.h:30
javaclassdeclarationblock.h
CodeClassField::Attribute
@ Attribute
Definition: codeclassfield.h:30
CodeBlockWithComments::getComment
CodeComment * getComment() const
Definition: codeblockwithcomments.cpp:46
TextBlock::setTag
void setTag(const QString &value)
Definition: textblock.cpp:117
CodeClassField
Definition: codeclassfield.h:25
javaclassifiercodedocument.h
CodeGenPolicyExt
Definition: codegenpolicyext.h:22
JavaClassifierCodeDocument::constructorBlock
HierarchicalCodeBlock * constructorBlock
Definition: javaclassifiercodedocument.h:82
UMLObject
The base class for UML objects.
Definition: umlobject.h:69
JavaClassifierCodeDocument::getJavaClassName
QString getJavaClassName(const QString &name) const
Definition: javaclassifiercodedocument.cpp:86
JavaClassifierCodeDocument::resetTextBlocks
void resetTextBlocks()
Definition: javaclassifiercodedocument.cpp:251
UMLObject::asUMLOperation
UMLOperation * asUMLOperation()
Definition: umlobject.cpp:1435
CodeOperation::loadFromXMI
virtual void loadFromXMI(QDomElement &root)
Definition: codeoperation.cpp:82
CodeBlock
Definition: codeblock.h:16
ClassifierCodeDocument
Definition: classifiercodedocument.h:28
CodeDocument::getPackage
QString getPackage() const
Definition: codedocument.cpp:120
HierarchicalCodeBlock::addCodeClassFieldMethods
void addCodeClassFieldMethods(CodeClassFieldList &list)
Definition: hierarchicalcodeblock.cpp:213
JavaClassifierCodeDocument::JavaClassifierCodeDocument
JavaClassifierCodeDocument(UMLClassifier *classifier)
Definition: javaclassifiercodedocument.cpp:36
Uml::ID::fromString
ID::Type fromString(const QString &id)
Definition: basictypes.cpp:1311
Codegen_Utils::capitalizeFirstLetter
QString capitalizeFirstLetter(const QString &string)
Definition: codegen_utils.cpp:425
javacodeoperation.h
JavaClassifierCodeDocument::updateContent
void updateContent()
Definition: javaclassifiercodedocument.cpp:269
JavaClassifierCodeDocument::addOrUpdateCodeClassFieldMethodsInCodeBlock
void addOrUpdateCodeClassFieldMethodsInCodeBlock(CodeClassFieldList &list, JavaClassDeclarationBlock *codeBlock)
CodeBlock::loadFromXMI
virtual void loadFromXMI(QDomElement &root)
Definition: codeblock.cpp:85
JavaClassDeclarationBlock::updateContent
void updateContent()
Definition: javaclassdeclarationblock.cpp:47
it
and that you know you can do these things To protect your we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights These restrictions translate to certain responsibilities for you if you distribute copies of the or if you modify it For if you distribute copies of such a whether gratis or for a you must give the recipients all the rights that you have You must make sure that receive or can get the source code And you must show them these terms so they know their rights We protect your rights with two distribute and or modify the software for each author s protection and we want to make certain that everyone understands that there is no warranty for this free software If the software is modified by someone else and passed we want its recipients to know that what they have is not the so that any problems introduced by others will not reflect on the original authors reputations any free program is threatened constantly by software patents We wish to avoid the danger that redistributors of a free program will individually obtain patent in effect making the program proprietary To prevent we have made it clear that any patent must be licensed for everyone s free use or not licensed at all The precise terms and conditions for distribution and modification follow TERMS AND CONDITIONS FOR DISTRIBUTION AND MODIFICATION This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License The refers to any such program or and a work based on the Program means either the Program or any derivative work under copyright a work containing the Program or a portion of it
Definition: GPL-2.0-only.txt:64
UMLDoc::findObjectById
UMLObject * findObjectById(Uml::ID::Type id)
Definition: umldoc.cpp:1051
ClassifierCodeDocument::findCodeClassFieldTextBlockByTag
TextBlock * findCodeClassFieldTextBlockByTag(const QString &tag)
Definition: classifiercodedocument.cpp:773
javacodeclassfield.h
HierarchicalCodeBlock::loadFromXMI
virtual void loadFromXMI(QDomElement &root)
Definition: hierarchicalcodeblock.cpp:267
JavaClassifierCodeDocument::classDeclCodeBlock
JavaClassDeclarationBlock * classDeclCodeBlock
Definition: javaclassifiercodedocument.h:81
classifiercodedocument.h
ClassifierCodeDocument::synchronize
virtual void synchronize()
Definition: classifiercodedocument.cpp:482
JavaClassifierCodeDocument::addCodeOperation
bool addCodeOperation(CodeOperation *op)
Definition: javaclassifiercodedocument.cpp:113
JavaCodeOperation
Definition: javacodeoperation.h:17
JavaClassifierCodeDocument::getJavaPolicy
JavaCodeGenerationPolicy * getJavaPolicy() const
Definition: javaclassifiercodedocument.cpp:47
codegenerationpolicy.h
JavaClassifierCodeDocument::operationsBlock
HierarchicalCodeBlock * operationsBlock
Definition: javaclassifiercodedocument.h:83
CodeGenerationPolicy
Definition: codegenerationpolicy.h:25
ClassifierCodeDocument::parentIsInterface
bool parentIsInterface() const
Definition: classifiercodedocument.cpp:421
CodeGenerationPolicy::getCodeVerboseDocumentComments
bool getCodeVerboseDocumentComments() const
Definition: codegenerationpolicy.cpp:148
ClassifierCodeDocument::parentIsClass
bool parentIsClass() const
Definition: classifiercodedocument.cpp:413
HierarchicalCodeBlock::addTextBlock
bool addTextBlock(TextBlock *add_object)
Definition: hierarchicalcodeblock.cpp:92
CodeClassField::setWriteOutMethods
void setWriteOutMethods(bool val)
Definition: codeclassfield.cpp:208
logWarn1
#define logWarn1(s, a)
Definition: uml.h:542
ClassifierCodeDocument::getCodeClassFieldList
CodeClassFieldList * getCodeClassFieldList()
Definition: classifiercodedocument.cpp:269
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
CodeBlockWithComments
Definition: codeblockwithcomments.h:19
UMLApp::app
static UMLApp * app()
Definition: uml.cpp:276
CodeBlockWithComments::loadFromXMI
virtual void loadFromXMI(QDomElement &root)
Definition: codeblockwithcomments.cpp:96
UMLObject::isUMLDatatype
bool isUMLDatatype() const
Definition: umlobject.h:204
JavaClassifierCodeDocument::loadChildTextBlocksFromNode
virtual void loadChildTextBlocksFromNode(QDomElement &root)
Definition: javaclassifiercodedocument.cpp:126
UMLPackageList
QList< UMLPackage * > UMLPackageList
Definition: umlpackagelist.h:11
CodeDocument::newCodeBlock
virtual CodeBlock * newCodeBlock()
Definition: codedocument.cpp:456
CodeBlock::contentType
ContentType contentType() const
Definition: codeblock.cpp:50
CodeBlock::AutoGenerated
@ AutoGenerated
the content was generated by code generation itself
Definition: codeblock.h:24
CodeGenObjectWithTextBlocks::getHierarchicalCodeBlock
virtual HierarchicalCodeBlock * getHierarchicalCodeBlock(const QString &tag, const QString &comment, int indentLevel)
Definition: codegenobjectwithtextblocks.cpp:176
javacodegenerator.h
JavaClassifierCodeDocument
Definition: javaclassifiercodedocument.h:28
HierarchicalCodeBlock
Definition: hierarchicalcodeblock.h:20
ClassifierCodeDocument::hasClassFields
bool hasClassFields() const
Definition: classifiercodedocument.cpp:154
classifier.h
CodeOperation::getParentOperation
UMLOperation * getParentOperation()
Definition: codeoperation.cpp:63
JavaClassifierCodeDocument::getClassDecl
JavaClassDeclarationBlock * getClassDecl()
Definition: javaclassifiercodedocument.cpp:241
UMLOperation
Definition: operation.h:19
CodeOperation
Definition: codeoperation.h:19
CodeDocument::getFileName
QString getFileName() const
Definition: codedocument.cpp:60
UMLApp::policyExt
CodeGenPolicyExt * policyExt() const
Definition: uml.cpp:2399
uml.h
JavaCodeGenerationPolicy::getAutoGenerateAttribAccessors
bool getAutoGenerateAttribAccessors()
Definition: javacodegenerationpolicy.cpp:71
CodeGenerationPolicy::getNewLineEndingChars
QString getNewLineEndingChars() const
Definition: codegenerationpolicy.cpp:249
UMLClassifier
Information for a non-graphical Concept/Class.
Definition: classifier.h:34
debug_utils.h
JavaClassDeclarationBlock::loadFromXMI
virtual void loadFromXMI(QDomElement &root)
Definition: javaclassdeclarationblock.cpp:39
CodeDocument::newCodeBlockWithComments
virtual CodeBlockWithComments * newCodeBlockWithComments()
Definition: codedocument.cpp:465
ClassifierCodeDocument::getSpecificClassFields
CodeClassFieldList getSpecificClassFields(CodeClassField::ClassFieldType cfType) const
Definition: classifiercodedocument.cpp:52
CodeClassFieldList
QList< CodeClassField * > CodeClassFieldList
Definition: codeclassfieldlist.h:12
TextBlock
Definition: textblock.h:22
JavaClassifierCodeDocument::forceDoc
bool forceDoc()
Definition: javaclassifiercodedocument.cpp:64
JavaClassDeclarationBlock
Definition: javaclassdeclarationblock.h:16
JavaClassifierCodeDocument::init
void init()
Definition: javaclassifiercodedocument.cpp:92
CodeGenerationPolicy::getAutoGenerateConstructors
bool getAutoGenerateConstructors()
Definition: codegenerationpolicy.cpp:361
UMLOperationList
QList< UMLOperation * > UMLOperationList
Definition: umloperationlist.h:12
JavaClassifierCodeDocument::getPath
QString getPath() const
Definition: javaclassifiercodedocument.cpp:70
UMLApp::document
UMLDoc * document() const
Definition: uml.cpp:1063
JavaCodeGenerationPolicy
Definition: javacodegenerationpolicy.h:18
codegen_utils.h
UMLPackage
Non-graphical information for a Package.
Definition: package.h:27
CodeComment::loadFromXMI
virtual void loadFromXMI(QDomElement &root)
Definition: codecomment.cpp:38