net.sourceforge.plantuml.SourceStringReader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-lgpl Show documentation
Show all versions of plantuml-lgpl 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 Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* PlantUML distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see blocks;
public SourceStringReader(String source) {
this(Defines.createEmpty(), source, Collections.emptyList());
}
public SourceStringReader(String source, String charset) {
this(Defines.createEmpty(), source, UTF_8.name(), Collections.emptyList());
}
public SourceStringReader(String source, Charset charset) {
this(Defines.createEmpty(), source, charset.name(), Collections.emptyList());
}
public SourceStringReader(Defines defines, String source, List config) {
this(defines, source, UTF_8.name(), config);
}
public SourceStringReader(Defines defines, String source) {
this(defines, source, UTF_8.name(), Collections.emptyList());
}
public SourceStringReader(String source, SFile newCurrentDir) {
this(Defines.createEmpty(), source, UTF_8, Collections.emptyList(), newCurrentDir);
}
public SourceStringReader(Defines defines, String source, String charset, List config) {
this(defines, source, charset, config, FileSystem.getInstance().getCurrentDir());
}
public SourceStringReader(Defines defines, String source, String charset, List config,
SFile newCurrentDir) {
this(defines, source, charsetOrDefault(charset), config, newCurrentDir);
}
public SourceStringReader(Defines defines, String source, Charset charset, List config,
SFile newCurrentDir) {
try {
final BlockUmlBuilder builder = new BlockUmlBuilder(config, charset, defines, new StringReader(source),
newCurrentDir, "string");
this.blocks = builder.getBlockUmls();
} catch (IOException e) {
Log.error("error " + e);
throw new IllegalStateException(e);
}
}
/**
* @deprecated Use {@link #outputImage(OutputStream)} instead
*/
@Deprecated
public String generateImage(OutputStream os) throws IOException {
return outputImage(os).getDescription();
}
public DiagramDescription outputImage(OutputStream os) throws IOException {
return outputImage(os, 0);
}
// ::comment when __CORE__
/**
* @deprecated Use {@link #outputImage(SFile)} instead
*/
@Deprecated
public String generateImage(SFile f) throws IOException {
return outputImage(f).getDescription();
}
public DiagramDescription outputImage(SFile f) throws IOException {
try (OutputStream os = f.createBufferedOutputStream()) {
return outputImage(os, 0);
}
}
/**
* @deprecated Use {@link #outputImage(OutputStream, FileFormatOption)} instead
*/
@Deprecated
public String generateImage(OutputStream os, FileFormatOption fileFormatOption) throws IOException {
return outputImage(os, fileFormatOption).getDescription();
}
public DiagramDescription outputImage(OutputStream os, FileFormatOption fileFormatOption) throws IOException {
return outputImage(os, 0, fileFormatOption);
}
/**
* @deprecated Use {@link #outputImage(OutputStream, int)} instead
*/
@Deprecated
public String generateImage(OutputStream os, int numImage) throws IOException {
return outputImage(os, numImage).getDescription();
}
public DiagramDescription outputImage(OutputStream os, int numImage) throws IOException {
return outputImage(os, numImage, new FileFormatOption(FileFormat.PNG));
}
/**
* @deprecated Use {@link #outputImage(OutputStream, int, FileFormatOption)} instead
*/
@Deprecated
public String generateImage(OutputStream os, int numImage, FileFormatOption fileFormatOption) throws IOException {
return outputImage(os, numImage, fileFormatOption).getDescription();
}
public DiagramDescription outputImage(OutputStream os, int numImage, FileFormatOption fileFormatOption)
throws IOException {
if (blocks.size() == 0) {
noValidStartFound(os, fileFormatOption);
return null;
}
if (fileFormatOption.getFileFormat() == FileFormat.PREPROC) {
final BlockUml first = blocks.get(0);
for (StringLocated s : first.getData()) {
os.write(s.getString().getBytes(UTF_8));
os.write("\n".getBytes(UTF_8));
}
return new DiagramDescription("PREPROC");
}
for (BlockUml b : blocks) {
final Diagram system = b.getDiagram();
final int nbInSystem = system.getNbImages();
if (numImage < nbInSystem) {
// final CMapData cmap = new CMapData();
final ImageData imageData = system.exportDiagram(os, numImage, fileFormatOption);
// if (imageData.containsCMapData()) {
// return system.getDescription().getDescription() + BackSlash.BS_N +
// imageData.getCMapData("plantuml");
// }
return system.getDescription();
}
numImage -= nbInSystem;
}
Log.error("numImage is too big = " + numImage);
return null;
}
public DiagramDescription generateDiagramDescription(int numImage, FileFormatOption fileFormatOption) {
if (blocks.size() == 0)
return null;
for (BlockUml b : blocks) {
final Diagram system = b.getDiagram();
final int nbInSystem = system.getNbImages();
if (numImage < nbInSystem) {
// final ImageData imageData = system.exportDiagram(os, numImage,
// fileFormatOption);
// if (imageData.containsCMapData()) {
// return
// system.getDescription().withCMapData(imageData.getCMapData("plantuml"));
// }
return system.getDescription();
}
numImage -= nbInSystem;
}
Log.error("numImage is too big = " + numImage);
return null;
}
public DiagramDescription generateDiagramDescription() {
return generateDiagramDescription(0);
}
public DiagramDescription generateDiagramDescription(FileFormatOption fileFormatOption) {
return generateDiagramDescription(0, fileFormatOption);
}
public DiagramDescription generateDiagramDescription(int numImage) {
return generateDiagramDescription(numImage, new FileFormatOption(FileFormat.PNG));
}
public String getCMapData(int numImage, FileFormatOption fileFormatOption) throws IOException {
if (blocks.size() == 0)
return null;
for (BlockUml b : blocks) {
final Diagram system = b.getDiagram();
final int nbInSystem = system.getNbImages();
if (numImage < nbInSystem) {
final ImageData imageData = system.exportDiagram(new NullOutputStream(), numImage, fileFormatOption);
if (imageData.containsCMapData())
return imageData.getCMapData("plantuml");
return null;
}
numImage -= nbInSystem;
}
return null;
}
public ImageData noValidStartFound(OutputStream os, FileFormatOption fileFormatOption) throws IOException {
final TextBlock error = GraphicStrings.createForError(
Arrays.asList("No valid @start/@end found, please check the version"),
fileFormatOption.isUseRedForError());
return plainImageBuilder(error, fileFormatOption).write(os);
}
public final List getBlocks() {
return Collections.unmodifiableList(blocks);
}
}