Skip to content

Commit 8da60d5

Browse files
hankemcodecholeric
authored andcommitted
hide empty fields & methods of class diagrams
Signed-off-by: Manfred Hanke <[email protected]>
1 parent 3489966 commit 8da60d5

File tree

3 files changed

+36
-4
lines changed

3 files changed

+36
-4
lines changed

docs/userguide/004_What_to_Check.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ classes().that().resideInAPackage("..foo..")
4949

5050
[plantuml, "class-naming-deps", svg, opts=interactive]
5151
----
52+
@startuml
53+
hide empty members
5254
skinparam componentStyle uml2
5355
5456
skinparam component {
@@ -69,6 +71,7 @@ note top on link #crimson: forbidden
6971
7072
Bar --> FooBar #green
7173
note left on link #green: allowed
74+
@enduml
7275
----
7376

7477
[source,java]
@@ -81,6 +84,8 @@ classes().that().haveNameMatching(".*Bar")
8184

8285
[plantuml, "class-package-contain", svg, opts=interactive]
8386
----
87+
@startuml
88+
hide empty members
8489
skinparam componentStyle uml2
8590
8691
skinparam component {
@@ -103,6 +108,7 @@ package com.wrong {
103108
104109
note "resides in wrong package" as WrongPackage #crimson
105110
FooController .. WrongPackage
111+
@enduml
106112
----
107113

108114
[source,java]
@@ -115,6 +121,8 @@ classes().that().haveSimpleNameStartingWith("Foo")
115121

116122
[plantuml, "inheritance-naming-check", svg, opts=interactive]
117123
----
124+
@startuml
125+
hide empty members
118126
skinparam componentStyle uml2
119127
120128
skinparam component {
@@ -137,6 +145,7 @@ FtpConnection --|> Connection #green
137145
SshThing --|> Connection #crimson
138146
139147
note right on link #crimson: Has wrong name
148+
@enduml
140149
----
141150

142151
[source,java]
@@ -147,6 +156,8 @@ classes().that().implement(Connection.class)
147156

148157
[plantuml, "inheritance-access-check", svg, opts=interactive]
149158
----
159+
@startuml
160+
hide empty members
150161
skinparam componentStyle uml2
151162
152163
skinparam component {
@@ -173,6 +184,7 @@ ValidPersistenceUser --> EntityManager #green
173184
IllegalPersistenceUser --> EntityManager #crimson
174185
175186
note right on link #crimson: Accessor resides in wrong package
187+
@enduml
176188
----
177189

178190
[source,java]
@@ -185,6 +197,8 @@ classes().that().areAssignableTo(EntityManager.class)
185197

186198
[plantuml, "inheritance-annotation-check", svg, opts=interactive]
187199
----
200+
@startuml
201+
hide empty members
188202
skinparam componentStyle uml2
189203
190204
skinparam component {
@@ -206,6 +220,7 @@ ValidPersistenceUser --> EntityManager #green
206220
IllegalPersistenceUser --> EntityManager #crimson
207221
208222
note right on link #crimson: Accessor is not annotated with @Transactional
223+
@enduml
209224
----
210225

211226
[source,java]
@@ -218,6 +233,8 @@ classes().that().areAssignableTo(EntityManager.class)
218233

219234
[plantuml, "layer-check", svg, opts=interactive]
220235
----
236+
@startuml
237+
hide empty members
221238
skinparam componentStyle uml2
222239
223240
skinparam component {
@@ -253,6 +270,7 @@ note right on link #crimson: Access goes against layers
253270
254271
SomePersistenceManager -up--> SomeServiceOne #crimson
255272
note right on link #crimson: Access goes against layers
273+
@enduml
256274
----
257275

258276
[source,java]
@@ -272,6 +290,8 @@ layeredArchitecture()
272290

273291
[plantuml, "cycle-check", svg, opts=interactive]
274292
----
293+
@startuml
294+
hide empty members
275295
skinparam componentStyle uml2
276296
277297
skinparam component {
@@ -301,6 +321,7 @@ ClassOneInModuleOne --> ClassTwoInModuleTwo #crimson
301321
ClassOneInModuleTwo --> ClassOneInModuleThree #crimson
302322
ClassTwoInModuleThree --> ClassOneInModuleOne #crimson
303323
note right on link #crimson: Combination of accesses forms cycle
324+
@enduml
304325
----
305326

306327
[source,java]

docs/userguide/006_The_Core_API.adoc

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,8 @@ inheritance is not completely straight forward. Consider for example
209209

210210
[plantuml, "resolution-example", svg, opts=interactive]
211211
----
212+
@startuml
213+
hide empty members
212214
skinparam componentStyle uml2
213215
214216
skinparam component {
@@ -232,7 +234,7 @@ class SuperclassBeingAccessed {
232234
233235
SuperclassBeingAccessed <|-- ClassBeingAccessed
234236
ClassAccessing o-- ClassBeingAccessed
235-
237+
@enduml
236238
----
237239

238240
The bytecode will record a field access from `ClassAccessing.accessField()` to
@@ -246,6 +248,8 @@ The situation looks roughly like
246248

247249
[plantuml, "resolution-overview", svg, opts=interactive]
248250
----
251+
@startuml
252+
hide empty members
249253
skinparam componentStyle uml2
250254
251255
skinparam component {
@@ -276,6 +280,7 @@ MethodCallTarget "1" -- "0..*" JavaMethod : resolves to
276280
277281
JavaConstructorCall "1" *-- "1" ConstructorCallTarget : has
278282
ConstructorCallTarget "1" -- "0..1" JavaConstructor : resolves to
283+
@enduml
279284
----
280285

281286
Two things might seem strange at the first look.
@@ -292,6 +297,8 @@ cases, for example:
292297

293298
[plantuml, "diamond-example", svg, opts=interactive]
294299
----
300+
@startuml
301+
hide empty members
295302
skinparam componentStyle uml2
296303
297304
skinparam component {
@@ -304,13 +311,13 @@ skinparam class {
304311
BackgroundColor #white
305312
}
306313
307-
class A <<interface>> {
314+
interface A <<interface>> {
308315
void targetMethod()
309316
}
310-
class B <<interface>> {
317+
interface B <<interface>> {
311318
void targetMethod()
312319
}
313-
class C <<abstract>> {
320+
abstract class C <<abstract>> {
314321
}
315322
class D {
316323
void callTargetMethod()
@@ -319,6 +326,7 @@ class D {
319326
A <|-- C : implements
320327
B <|-- C : implements
321328
D -right- C : calls targetMethod()
329+
@enduml
322330
----
323331

324332
While this situation will always be resolved in a specified way for a real program,

docs/userguide/008_The_Library_API.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ More precisely, the following holds:
5757

5858
[plantuml, "onion-architecture-check", svg, opts=interactive]
5959
----
60+
@startuml
61+
hide empty members
6062
skinparam componentStyle uml2
6163
6264
skinparam class {
@@ -112,6 +114,7 @@ note right on link #crimson: application services must not\nknow about any adapt
112114
113115
Cli --> RestController #crimson
114116
note right on link #crimson: one adapter must not know\nabout any other adapter
117+
@enduml
115118
----
116119

117120

0 commit comments

Comments
 (0)