net.sourceforge.plantuml.api.v2.DiagramUtils 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.api.v2;
import java.awt.image.BufferedImage;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.Reader;
import java.io.StringReader;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import net.sourceforge.plantuml.BlockUml;
import net.sourceforge.plantuml.BlockUmlBuilder;
import net.sourceforge.plantuml.ErrorUml;
import net.sourceforge.plantuml.FileFormat;
import net.sourceforge.plantuml.FileFormatOption;
import net.sourceforge.plantuml.FileSystem;
import net.sourceforge.plantuml.core.Diagram;
import net.sourceforge.plantuml.core.ImageData;
import net.sourceforge.plantuml.error.PSystemError;
import net.sourceforge.plantuml.preproc.Defines;
import net.sourceforge.plantuml.security.SImageIO;
public abstract class DiagramUtils {
public static DiagramReturn exportDiagram(String... source) throws IOException {
final Reader reader = new StringReader(String.join("\n", source));
final BlockUmlBuilder builder = new BlockUmlBuilder(Collections.emptyList(),
java.nio.charset.StandardCharsets.UTF_8, Defines.createEmpty(), reader,
FileSystem.getInstance().getCurrentDir(), "string");
final List blocks = builder.getBlockUmls();
if (blocks.size() == 0)
return new DiagramReturnError("No @start/@end found");
final BlockUml blockUml = blocks.get(0);
final Diagram diagram = blockUml.getDiagram();
return new DiagramReturn() {
@Override
public Diagram getDiagram() {
return diagram;
}
@Override
public String error() {
if (diagram instanceof PSystemError) {
final PSystemError diagramError = (PSystemError) diagram;
final ErrorUml error = diagramError.getFirstError();
return error.getError();
}
return null;
}
@Override
public Optional getErrorLine() {
if (diagram instanceof PSystemError) {
final PSystemError diagramError = (PSystemError) diagram;
final ErrorUml error = diagramError.getFirstError();
return Optional.of(error.getLineLocation().getPosition());
}
return Optional.empty();
}
@Override
public BufferedImage asImage() throws IOException {
try (final ByteArrayOutputStream os = new ByteArrayOutputStream()) {
final FileFormatOption fileFormatOption = new FileFormatOption(FileFormat.PNG);
final ImageData imageData = diagram.exportDiagram(os, 0, fileFormatOption);
return SImageIO.read(os.toByteArray());
}
}
@Override
public Throwable getRootCause() {
try (final ByteArrayOutputStream os = new ByteArrayOutputStream()) {
final FileFormatOption fileFormatOption = new FileFormatOption(FileFormat.PNG);
final ImageData imageData = diagram.exportDiagram(os, 0, fileFormatOption);
return imageData.getRootCause();
} catch (IOException e) {
e.printStackTrace();
return e;
}
}
};
}
}