net.sourceforge.plantuml.classdiagram.ClassDiagram Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-gplv2 Show documentation
Show all versions of plantuml-gplv2 Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | PlantUML : a free UML diagram generator
* |
* +=======================================================================
*
* (C) Copyright 2009-2024, Arnaud Roques
*
* Project Info: https://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* https://plantuml.com/patreon (only 1$ per month!)
* https://plantuml.com/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License V2.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [GNU General Public License V2]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this GPL v2 license.
*
* The generated images can then be used without any reference to the GPL v2 license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.classdiagram;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Map;
import net.sourceforge.plantuml.FileFormatOption;
import net.sourceforge.plantuml.abel.Entity;
import net.sourceforge.plantuml.abel.Link;
import net.sourceforge.plantuml.command.CommandExecutionResult;
import net.sourceforge.plantuml.core.ImageData;
import net.sourceforge.plantuml.core.UmlSource;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.objectdiagram.AbstractClassOrObjectDiagram;
import net.sourceforge.plantuml.plasma.Quark;
import net.sourceforge.plantuml.skin.UmlDiagramType;
import net.sourceforge.plantuml.svek.image.EntityImageClass;
public class ClassDiagram extends AbstractClassOrObjectDiagram {
public ClassDiagram(UmlSource source, Map skinParam) {
super(source, UmlDiagramType.CLASS, skinParam);
}
private boolean allowMixing;
public void setAllowMixing(boolean allowMixing) {
this.allowMixing = allowMixing;
}
public boolean isAllowMixing() {
return allowMixing;
}
private int useLayoutExplicit = 0;
public void layoutNewLine() {
useLayoutExplicit++;
incRawLayout();
}
@Override
final protected ImageData exportDiagramInternal(OutputStream os, int index, FileFormatOption fileFormatOption)
throws IOException {
if (useLayoutExplicit != 0)
return exportLayoutExplicit(os, index, fileFormatOption);
return super.exportDiagramInternal(os, index, fileFormatOption);
}
final protected ImageData exportLayoutExplicit(OutputStream os, int index, FileFormatOption fileFormatOption)
throws IOException {
final FullLayout fullLayout = new FullLayout();
for (int i = 0; i <= useLayoutExplicit; i++) {
final RowLayout rawLayout = getRawLayout(i);
fullLayout.addRowLayout(rawLayout);
}
return createImageBuilder(fileFormatOption).annotations(false) // Backwards compatibility - this only applies
// when "layout_new_line" is used
.drawable(fullLayout).write(os);
}
private RowLayout getRawLayout(int raw) {
final RowLayout rawLayout = new RowLayout();
for (Entity leaf : entityFactory.leafs())
if (leaf.getRawLayout() == raw)
rawLayout.addLeaf(getEntityImageClass(leaf));
return rawLayout;
}
private TextBlock getEntityImageClass(Entity entity) {
return new EntityImageClass(entity, getSkinParam(), this);
}
@Override
public String checkFinalError() {
for (Link link : this.getLinks()) {
final int len = link.getLength();
if (len == 1)
for (Link link2 : this.getLinks())
if (link2.sameConnections(link) && link2.getLength() != 1)
link2.setLength(1);
}
if (getPragma().useIntermediatePackages() == false)
packSomePackage();
this.applySingleStrategy();
return super.checkFinalError();
}
private void packSomePackage() {
String separator = getNamespaceSeparator();
if (separator == null)
separator = ".";
while (true) {
boolean changed = false;
for (Entity group : this.entityFactory.groups()) {
if (group.canBePacked()) {
final Entity child = group.groups().iterator().next();
final String appended = group.getDisplay().get(0) + separator;
final Display newDisplay = child.getDisplay().appendFirstLine(appended);
child.setDisplay(newDisplay);
group.setPacked(true);
changed = true;
}
}
if (changed == false)
return;
}
}
public CommandExecutionResult checkIfPackageHierarchyIfOk(Entity entity) {
Quark current = entity.getQuark().getParent();
while (current.isRoot() == false) {
if (current.getData() != null && current.getData().isGroup() == false)
return CommandExecutionResult.error("Bad hierarchy for class " + entity.getQuark().getQualifiedName());
current = current.getParent();
}
return CommandExecutionResult.ok();
}
}