net.sourceforge.plantuml.activitydiagram3.InstructionSwitch 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.FtileFactory;
import net.sourceforge.plantuml.activitydiagram3.ftile.Swimlane;
import net.sourceforge.plantuml.activitydiagram3.gtile.Gtile;
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.klimt.geom.VerticalAlignment;
import net.sourceforge.plantuml.sequencediagram.NotePosition;
import net.sourceforge.plantuml.sequencediagram.NoteType;
import net.sourceforge.plantuml.style.ISkinParam;
public class InstructionSwitch extends WithNote implements Instruction, InstructionCollection {
// ::remove folder when __HAXE__
private final List switches = new ArrayList<>();
private final ISkinParam skinParam;
private final Instruction parent;
private Branch current;
private final LinkRendering topInlinkRendering;
private LinkRendering afterEndwhile = LinkRendering.none();
private final Display labelTest;
private final Swimlane swimlane;
@Override
public boolean containsBreak() {
for (Branch branch : switches)
if (branch.containsBreak())
return true;
return false;
}
public InstructionSwitch(Swimlane swimlane, Instruction parent, Display labelTest, LinkRendering inlinkRendering,
HColor color, ISkinParam skinParam) {
this.topInlinkRendering = Objects.requireNonNull(inlinkRendering);
this.parent = parent;
this.skinParam = skinParam;
this.labelTest = labelTest;
this.swimlane = swimlane;
}
@Override
public CommandExecutionResult add(Instruction ins) {
if (current == null)
return CommandExecutionResult.error("No 'case' in this switch");
return current.add(ins);
}
// ::comment when __CORE__
@Override
public Gtile createGtile(ISkinParam skinParam, StringBounder stringBounder) {
for (Branch branch : switches)
branch.updateGtile(skinParam, stringBounder);
final List gtiles = new ArrayList<>();
final List branches = new ArrayList<>();
for (Branch branch : switches) {
gtiles.add(branch.getGtile());
branches.add(branch);
}
return GtileIfHexagon.build(swimlane, gtiles, switches);
}
public Ftile createFtile(FtileFactory factory) {
for (Branch branch : switches)
branch.updateFtile(factory);
Ftile result = factory.createSwitch(swimlane, switches, afterEndwhile, topInlinkRendering, labelTest);
result = eventuallyAddNote(factory, result, getSwimlaneIn(), VerticalAlignment.TOP);
return result;
}
@Override
final public boolean kill() {
return current.kill();
}
@Override
public LinkRendering getInLinkRendering() {
return topInlinkRendering;
}
@Override
public Set getSwimlanes() {
final Set result = new HashSet<>();
if (swimlane != null)
result.add(swimlane);
for (Branch branch : switches)
result.addAll(branch.getSwimlanes());
return Collections.unmodifiableSet(result);
}
@Override
public Swimlane getSwimlaneIn() {
return swimlane;
}
@Override
public Swimlane getSwimlaneOut() {
return swimlane;
}
@Override
public Instruction getLast() {
return switches.get(switches.size() - 1).getLast();
}
public boolean switchCase(Display labelCase, LinkRendering nextLinkRenderer) {
if (this.current != null)
this.current.setSpecial(nextLinkRenderer);
this.current = new Branch(skinParam.getCurrentStyleBuilder(), swimlane,
LinkRendering.none().withDisplay(labelCase), labelCase, null,
LinkRendering.none().withDisplay(labelCase), null);
this.switches.add(this.current);
return true;
}
public Instruction getParent() {
return parent;
}
public void endSwitch(LinkRendering nextLinkRenderer) {
if (this.current != null)
this.current.setSpecial(nextLinkRenderer);
}
@Override
public boolean addNote(Display note, NotePosition position, NoteType type, Colors colors, Swimlane swimlaneNote) {
if (current == null || current.isEmpty())
return super.addNote(note, position, type, colors, swimlaneNote);
else
return current.addNote(note, position, type, colors, swimlaneNote);
}
}