net.sourceforge.plantuml.sequencediagram.Reference 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.Collections;
import java.util.Iterator;
import java.util.List;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.style.StyleBuilder;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
import net.sourceforge.plantuml.url.Url;
public class Reference extends AbstractEvent implements EventWithNote {
private final List participants;
private final Url url;
private final HColor backColorGeneral;
private final HColor backColorElement;
private final Display strings;
final private Style style;
final private Style styleHeader;
public StyleSignatureBasic getDefaultStyleDefinition() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.sequenceDiagram, SName.reference);
}
private StyleSignatureBasic getHeaderStyleDefinition() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.sequenceDiagram, SName.referenceHeader);
}
public Style[] getUsedStyles() {
return new Style[] { style, styleHeader == null ? styleHeader
: styleHeader.eventuallyOverride(PName.BackGroundColor, backColorElement) };
}
public Reference(List participants, Url url, Display strings, HColor backColorGeneral,
HColor backColorElement, StyleBuilder styleBuilder) {
this.participants = uniq(participants);
this.url = url;
this.strings = strings;
this.backColorGeneral = backColorGeneral;
this.backColorElement = backColorElement;
this.style = getDefaultStyleDefinition().getMergedStyle(styleBuilder);
this.styleHeader = getHeaderStyleDefinition().getMergedStyle(styleBuilder);
}
static private List uniq(List all) {
final List result = new ArrayList();
for (Participant p : all)
if (result.contains(p) == false)
result.add(p);
return Collections.unmodifiableList(result);
}
public List getParticipant() {
return participants;
}
public Display getStrings() {
return strings;
}
public boolean dealWith(Participant someone) {
return participants.contains(someone);
}
public final Url getUrl() {
return url;
}
public boolean hasUrl() {
return url != null;
}
@Override
public String toString() {
final StringBuilder sb = new StringBuilder();
for (final Iterator it = participants.iterator(); it.hasNext();) {
sb.append(it.next().getCode());
if (it.hasNext())
sb.append("-");
}
return sb.toString();
}
public final HColor getBackColorGeneral() {
return backColorGeneral;
}
public final HColor getBackColorElement() {
return backColorElement;
}
private List noteOnMessages = new ArrayList<>();
@Override
public final void addNote(Note note) {
if (note.getPosition() != NotePosition.LEFT && note.getPosition() != NotePosition.RIGHT)
throw new IllegalArgumentException();
this.noteOnMessages.add(note);
}
public final List getNoteOnMessages() {
return noteOnMessages;
}
}