net.sourceforge.plantuml.activitydiagram3.InstructionIf Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-mit Show documentation
Show all versions of plantuml-mit 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 MIT License.
*
* See http://opensource.org/licenses/MIT
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
* IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* 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 MIT license.
*
* The generated images can then be used without any reference to the MIT 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.activitydiagram3;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Objects;
import java.util.Set;
import net.sourceforge.plantuml.activitydiagram3.ftile.Ftile;
import net.sourceforge.plantuml.activitydiagram3.ftile.FtileDecorateWelding;
import net.sourceforge.plantuml.activitydiagram3.ftile.FtileFactory;
import net.sourceforge.plantuml.activitydiagram3.ftile.Swimlane;
import net.sourceforge.plantuml.activitydiagram3.ftile.WeldingPoint;
import net.sourceforge.plantuml.activitydiagram3.gtile.Gtile;
import net.sourceforge.plantuml.activitydiagram3.gtile.GtileIfAlone;
import net.sourceforge.plantuml.activitydiagram3.gtile.GtileIfHexagon;
import net.sourceforge.plantuml.command.CommandExecutionResult;
import net.sourceforge.plantuml.klimt.color.Colors;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.sequencediagram.NotePosition;
import net.sourceforge.plantuml.sequencediagram.NoteType;
import net.sourceforge.plantuml.stereo.Stereotype;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.StyleBuilder;
import net.sourceforge.plantuml.url.Url;
public class InstructionIf extends WithNote implements Instruction, InstructionCollection {
private final List thens = new ArrayList<>();
private Branch elseBranch;
private boolean endifCalled = false;
private final ISkinParam skinParam;
private final Url url;
private final Instruction parent;
private Branch current;
private final LinkRendering topInlinkRendering;
private LinkRendering outColor = LinkRendering.none();
private final Stereotype stereotype;
private final Swimlane swimlane;
private final StyleBuilder currentStyleBuilder;
@Override
public boolean containsBreak() {
for (Branch branch : thens)
if (branch.containsBreak())
return true;
if (elseBranch != null)
return elseBranch.containsBreak();
return false;
}
public InstructionIf(Swimlane swimlane, Instruction parent, Display labelTest, LinkRendering whenThen,
LinkRendering inlinkRendering, HColor color, ISkinParam skinParam, Url url, Stereotype stereotype) {
this.url = url;
this.stereotype = stereotype;
this.parent = parent;
this.skinParam = skinParam;
this.topInlinkRendering = Objects.requireNonNull(inlinkRendering);
this.swimlane = swimlane;
this.currentStyleBuilder = skinParam.getCurrentStyleBuilder();
this.thens.add(new Branch(currentStyleBuilder, swimlane, whenThen, labelTest, color, LinkRendering.none(),
stereotype));
this.current = this.thens.get(0);
}
@Override
public CommandExecutionResult add(Instruction ins) {
return current.add(ins);
}
// ::comment when __CORE__
@Override
public Gtile createGtile(ISkinParam skinParam, StringBounder stringBounder) {
for (Branch branch : thens)
branch.updateGtile(skinParam, stringBounder);
final List gtiles = new ArrayList<>();
final List branches = new ArrayList<>();
for (Branch branch : thens) {
gtiles.add(branch.getGtile());
branches.add(branch);
}
if (elseBranch != null && elseBranch.isEmpty() == false) {
elseBranch.updateGtile(skinParam, stringBounder);
gtiles.add(elseBranch.getGtile());
branches.add(elseBranch);
}
if (branches.size() == 1)
return new GtileIfAlone(swimlane, gtiles.get(0), branches.get(0));
return GtileIfHexagon.build(swimlane, gtiles, branches);
}
@Override
public Ftile createFtile(FtileFactory factory) {
for (Branch branch : thens)
branch.updateFtile(factory);
if (elseBranch == null)
this.elseBranch = new Branch(currentStyleBuilder, swimlane, LinkRendering.none(),
Display.NULL, null, LinkRendering.none(), stereotype);
elseBranch.updateFtile(factory);
Ftile result = factory.createIf(swimlane, thens, elseBranch, outColor, topInlinkRendering, url,
getPositionedNotes(), stereotype, currentStyleBuilder);
// if (getPositionedNotes().size() > 0)
// result = FtileWithNoteOpale.create(result, getPositionedNotes(), false, VerticalAlignment.CENTER);
final List weldingPoints = new ArrayList<>();
for (Branch branch : thens)
weldingPoints.addAll(branch.getWeldingPoints());
weldingPoints.addAll(elseBranch.getWeldingPoints());
if (weldingPoints.size() > 0)
result = new FtileDecorateWelding(result, weldingPoints);
return result;
}
public Instruction getParent() {
return parent;
}
public boolean swithToElse2(LinkRendering whenElse, LinkRendering nextLinkRenderer) {
this.current.setSpecial(nextLinkRenderer);
if (elseBranch != null)
return false;
this.current.setInlinkRendering(nextLinkRenderer);
this.elseBranch = new Branch(skinParam.getCurrentStyleBuilder(), swimlane, whenElse, Display.NULL, null,
LinkRendering.none(), stereotype);
this.current = elseBranch;
return true;
}
public boolean elseIf(LinkRendering inlabel, Display test, LinkRendering whenThen, LinkRendering nextLinkRenderer,
HColor color) {
if (elseBranch != null)
return false;
this.current.setSpecial(nextLinkRenderer);
this.current = new Branch(skinParam.getCurrentStyleBuilder(), swimlane, whenThen, test, color, inlabel,
stereotype);
this.thens.add(current);
return true;
}
public void endif(LinkRendering nextLinkRenderer) {
endifCalled = true;
if (elseBranch == null)
this.elseBranch = new Branch(skinParam.getCurrentStyleBuilder(), swimlane, LinkRendering.none(),
Display.NULL, null, LinkRendering.none(), stereotype);
this.elseBranch.setSpecial(nextLinkRenderer);
this.current.setInlinkRendering(nextLinkRenderer);
}
@Override
final public boolean kill() {
if (endifCalled)
for (Branch branch : thens) {
if (branch.getLast() != null && branch.getLast().kill() == false)
return false;
if (elseBranch != null && elseBranch.getLast() != null && elseBranch.getLast().kill() == false)
return false;
return true;
}
return current.kill();
}
@Override
public LinkRendering getInLinkRendering() {
return topInlinkRendering;
}
@Override
public boolean addNote(Display note, NotePosition position, NoteType type, Colors colors, Swimlane swimlaneNote) {
if (endifCalled || current.isEmpty())
return super.addNote(note, position, type, colors, swimlaneNote);
else
return current.addNote(note, position, type, colors, swimlaneNote);
}
@Override
public Set getSwimlanes() {
final Set result = new HashSet<>();
if (swimlane != null)
result.add(swimlane);
for (Branch branch : thens)
result.addAll(branch.getSwimlanes());
if (elseBranch != null)
result.addAll(elseBranch.getSwimlanes());
return Collections.unmodifiableSet(result);
}
@Override
public Swimlane getSwimlaneIn() {
return swimlane;
}
@Override
public Swimlane getSwimlaneOut() {
return swimlane;
}
@Override
public Instruction getLast() {
if (elseBranch == null)
return thens.get(thens.size() - 1).getLast();
return elseBranch.getLast();
}
public void outColor(LinkRendering outColor) {
this.outColor = outColor;
}
}