net.sourceforge.plantuml.sequencediagram.Participant 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.sequencediagram;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.Set;
import net.sourceforge.plantuml.abel.EntityPortion;
import net.sourceforge.plantuml.abel.SpecificBackcolorable;
import net.sourceforge.plantuml.klimt.Fashion;
import net.sourceforge.plantuml.klimt.color.ColorType;
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.stereo.Stereotype;
import net.sourceforge.plantuml.style.MergeStrategy;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.style.StyleBuilder;
import net.sourceforge.plantuml.style.StyleSignature;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
import net.sourceforge.plantuml.style.WithStyle;
import net.sourceforge.plantuml.url.Url;
public class Participant implements SpecificBackcolorable, WithStyle {
// ::remove folder when __HAXE__
private final String code;
private Display display;
private final ParticipantType type;
private int initialLife = 0;
private Stereotype stereotype;
private boolean stereotypePositionTop;
private final Set hiddenPortions;
private final int order;
private final StyleBuilder styleBuilder;
// private Style style;
public StyleSignatureBasic getStyleSignature() {
return type.getStyleSignature().addClickable(getUrl());
}
public Style[] getUsedStyles() {
final StyleSignature signature = getStyleSignature().withTOBECHANGED(stereotype);
Style tmp = signature.getMergedStyle(styleBuilder);
tmp = tmp.eventuallyOverride(getColors());
Style stereo = getStyleSignature().forStereotypeItself(stereotype).getMergedStyle(styleBuilder);
if (tmp != null)
stereo = tmp.mergeWith(stereo, MergeStrategy.OVERWRITE_EXISTING_VALUE);
return new Style[] { tmp, stereo };
}
public Participant(ParticipantType type, String code, Display display, Set hiddenPortions, int order,
StyleBuilder styleBuilder) {
this.hiddenPortions = hiddenPortions;
this.styleBuilder = styleBuilder;
this.order = order;
this.code = Objects.requireNonNull(code);
if (code.length() == 0)
throw new IllegalArgumentException();
if (Display.isNull(display) || display.size() == 0)
throw new IllegalArgumentException();
this.type = Objects.requireNonNull(type);
this.display = display;
}
public String getCode() {
return code;
}
@Override
public String toString() {
return getCode();
}
public Display getDisplay(boolean underlined) {
Display result = underlined ? display.underlined() : display;
if (stereotype != null && hiddenPortions.contains(EntityPortion.STEREOTYPE) == false) {
if (stereotypePositionTop)
result = result.addFirst(stereotype);
else
result = result.add(stereotype);
}
return result;
}
public ParticipantType getType() {
return type;
}
public final void setStereotype(Stereotype stereotype, boolean stereotypePositionTop) {
if (this.stereotype != null)
throw new IllegalStateException();
this.stereotype = Objects.requireNonNull(stereotype);
this.stereotypePositionTop = stereotypePositionTop;
}
public final int getInitialLife() {
return initialLife;
}
private List liveBackcolors = new ArrayList<>();
public final void incInitialLife(Fashion colors) {
initialLife++;
this.liveBackcolors.add(colors);
}
public Fashion getLiveSpecificBackColors(int which) {
return liveBackcolors.get(which);
}
public Colors getColors() {
return colors;
}
public void setSpecificColorTOBEREMOVED(ColorType type, HColor color) {
if (color != null)
this.colors = colors.add(type, color);
}
private Colors colors = Colors.empty();
public void setColors(Colors colors) {
this.colors = colors;
}
private Url url;
public final Url getUrl() {
return url;
}
public final void setUrl(Url url) {
this.url = url;
}
public final Stereotype getStereotype() {
return stereotype;
}
public int getOrder() {
return order;
}
}