mirror of
https://github.com/octoleo/plantuml-server.git
synced 2024-12-23 17:28:55 +00:00
376 lines
18 KiB
HTML
376 lines
18 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
<!-- NewPage -->
|
||
|
<html lang="en">
|
||
|
<head>
|
||
|
<!-- Generated by javadoc (11.0.13) on Thu Nov 11 13:36:22 UTC 2021 -->
|
||
|
<title>UmlExtractor (PlantUML Servlet 1-SNAPSHOT API)</title>
|
||
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
<meta name="dc.created" content="2021-11-11">
|
||
|
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
||
|
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
|
||
|
<script type="text/javascript" src="../../../../../script.js"></script>
|
||
|
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
|
||
|
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
|
||
|
<!--[if IE]>
|
||
|
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
||
|
<![endif]-->
|
||
|
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
|
||
|
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
|
||
|
</head>
|
||
|
<body>
|
||
|
<script type="text/javascript"><!--
|
||
|
try {
|
||
|
if (location.href.indexOf('is-external=true') == -1) {
|
||
|
parent.document.title="UmlExtractor (PlantUML Servlet 1-SNAPSHOT API)";
|
||
|
}
|
||
|
}
|
||
|
catch(err) {
|
||
|
}
|
||
|
//-->
|
||
|
var data = {"i0":9,"i1":9,"i2":9};
|
||
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
|
||
|
var altColor = "altColor";
|
||
|
var rowColor = "rowColor";
|
||
|
var tableTab = "tableTab";
|
||
|
var activeTableTab = "activeTableTab";
|
||
|
var pathtoroot = "../../../../../";
|
||
|
var useModuleDirectories = true;
|
||
|
loadScripts(document, 'script');</script>
|
||
|
<noscript>
|
||
|
<div>JavaScript is disabled on your browser.</div>
|
||
|
</noscript>
|
||
|
<header role="banner">
|
||
|
<nav role="navigation">
|
||
|
<div class="fixedNav">
|
||
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
||
|
<div class="topNav"><a id="navbar.top">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
||
|
<a id="navbar.top.firstrow">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="navList" title="Navigation">
|
||
|
<li><a href="../../../../../index.html">Overview</a></li>
|
||
|
<li><a href="package-summary.html">Package</a></li>
|
||
|
<li class="navBarCell1Rev">Class</li>
|
||
|
<li><a href="class-use/UmlExtractor.html">Use</a></li>
|
||
|
<li><a href="package-tree.html">Tree</a></li>
|
||
|
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
|
||
|
<li><a href="../../../../../index-all.html">Index</a></li>
|
||
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="subNav">
|
||
|
<ul class="navList" id="allclasses_navbar_top">
|
||
|
<li><a href="../../../../../allclasses.html">All Classes</a></li>
|
||
|
</ul>
|
||
|
<ul class="navListSearch">
|
||
|
<li><label for="search">SEARCH:</label>
|
||
|
<input type="text" id="search" value="search" disabled="disabled">
|
||
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
||
|
</li>
|
||
|
</ul>
|
||
|
<div>
|
||
|
<script type="text/javascript"><!--
|
||
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
||
|
if(window==top) {
|
||
|
allClassesLink.style.display = "block";
|
||
|
}
|
||
|
else {
|
||
|
allClassesLink.style.display = "none";
|
||
|
}
|
||
|
//-->
|
||
|
</script>
|
||
|
<noscript>
|
||
|
<div>JavaScript is disabled on your browser.</div>
|
||
|
</noscript>
|
||
|
</div>
|
||
|
<div>
|
||
|
<ul class="subNavList">
|
||
|
<li>Summary: </li>
|
||
|
<li>Nested | </li>
|
||
|
<li>Field | </li>
|
||
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
||
|
<li><a href="#method.summary">Method</a></li>
|
||
|
</ul>
|
||
|
<ul class="subNavList">
|
||
|
<li>Detail: </li>
|
||
|
<li>Field | </li>
|
||
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
||
|
<li><a href="#method.detail">Method</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<a id="skip.navbar.top">
|
||
|
<!-- -->
|
||
|
</a></div>
|
||
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
||
|
</div>
|
||
|
<div class="navPadding"> </div>
|
||
|
<script type="text/javascript"><!--
|
||
|
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
||
|
//-->
|
||
|
</script>
|
||
|
</nav>
|
||
|
</header>
|
||
|
<!-- ======== START OF CLASS DATA ======== -->
|
||
|
<main role="main">
|
||
|
<div class="header">
|
||
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">net.sourceforge.plantuml.servlet.utility</a></div>
|
||
|
<h2 title="Class UmlExtractor" class="title">Class UmlExtractor</h2>
|
||
|
</div>
|
||
|
<div class="contentContainer">
|
||
|
<ul class="inheritance">
|
||
|
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
|
||
|
<li>
|
||
|
<ul class="inheritance">
|
||
|
<li>net.sourceforge.plantuml.servlet.utility.UmlExtractor</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<div class="description">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<hr>
|
||
|
<pre>public abstract class <span class="typeNameLabel">UmlExtractor</span>
|
||
|
extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
|
||
|
<div class="block">Utility class to extract the UML source from the compressed UML source contained in the end part
|
||
|
of the requested URI.</div>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="summary">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||
|
<section role="region">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a id="constructor.summary">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Constructor Summary</h3>
|
||
|
<table class="memberSummary">
|
||
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
||
|
<tr>
|
||
|
<th class="colFirst" scope="col">Constructor</th>
|
||
|
<th class="colLast" scope="col">Description</th>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">UmlExtractor</a></span>()</code></th>
|
||
|
<td class="colLast"> </td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
<!-- ========== METHOD SUMMARY =========== -->
|
||
|
<section role="region">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a id="method.summary">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Method Summary</h3>
|
||
|
<table class="memberSummary">
|
||
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
||
|
<tr>
|
||
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
|
<th class="colSecond" scope="col">Method</th>
|
||
|
<th class="colLast" scope="col">Description</th>
|
||
|
</tr>
|
||
|
<tr id="i0" class="altColor">
|
||
|
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
|
||
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#extractMap(java.lang.String)">extractMap</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> uml)</code></th>
|
||
|
<td class="colLast">
|
||
|
<div class="block">Get image map from uml.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i1" class="rowColor">
|
||
|
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
|
||
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#extractMap(java.lang.String,net.sourceforge.plantuml.FileFormat)">extractMap</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> uml,
|
||
|
net.sourceforge.plantuml.FileFormat fileFormat)</code></th>
|
||
|
<td class="colLast">
|
||
|
<div class="block">Get image map from uml.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i2" class="altColor">
|
||
|
<td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
|
||
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUmlSource(java.lang.String)">getUmlSource</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> source)</code></th>
|
||
|
<td class="colLast">
|
||
|
<div class="block">Build the complete UML source from the compressed source extracted from the
|
||
|
HTTP URI.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
|
||
|
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="details">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||
|
<section role="region">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a id="constructor.detail">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Constructor Detail</h3>
|
||
|
<a id="<init>()">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockListLast">
|
||
|
<li class="blockList">
|
||
|
<h4>UmlExtractor</h4>
|
||
|
<pre>public UmlExtractor()</pre>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
<!-- ============ METHOD DETAIL ========== -->
|
||
|
<section role="region">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a id="method.detail">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Method Detail</h3>
|
||
|
<a id="getUmlSource(java.lang.String)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>getUmlSource</h4>
|
||
|
<pre class="methodSignature">public static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getUmlSource​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> source)</pre>
|
||
|
<div class="block">Build the complete UML source from the compressed source extracted from the
|
||
|
HTTP URI.</div>
|
||
|
<dl>
|
||
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
<dd><code>source</code> - the last part of the URI containing the compressed UML</dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>the textual UML source</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a id="extractMap(java.lang.String)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>extractMap</h4>
|
||
|
<pre class="methodSignature">public static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> extractMap​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> uml)
|
||
|
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
||
|
<div class="block">Get image map from uml.</div>
|
||
|
<dl>
|
||
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
<dd><code>uml</code> - textual diagram source</dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>image map of the diagram in HTML format if the image has some position information; otherwise `null`</dd>
|
||
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - if an input or output exception occurred</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a id="extractMap(java.lang.String,net.sourceforge.plantuml.FileFormat)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockListLast">
|
||
|
<li class="blockList">
|
||
|
<h4>extractMap</h4>
|
||
|
<pre class="methodSignature">public static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> extractMap​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> uml,
|
||
|
net.sourceforge.plantuml.FileFormat fileFormat)
|
||
|
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
||
|
<div class="block">Get image map from uml.</div>
|
||
|
<dl>
|
||
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
<dd><code>uml</code> - textual diagram source</dd>
|
||
|
<dd><code>fileFormat</code> - underlying file format of uml image</dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>image map of the diagram in HTML format if the image has some position information; otherwise `null`</dd>
|
||
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - if an input or output exception occurred</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
</div>
|
||
|
</main>
|
||
|
<!-- ========= END OF CLASS DATA ========= -->
|
||
|
<footer role="contentinfo">
|
||
|
<nav role="navigation">
|
||
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||
|
<div class="bottomNav"><a id="navbar.bottom">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
||
|
<a id="navbar.bottom.firstrow">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="navList" title="Navigation">
|
||
|
<li><a href="../../../../../index.html">Overview</a></li>
|
||
|
<li><a href="package-summary.html">Package</a></li>
|
||
|
<li class="navBarCell1Rev">Class</li>
|
||
|
<li><a href="class-use/UmlExtractor.html">Use</a></li>
|
||
|
<li><a href="package-tree.html">Tree</a></li>
|
||
|
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
|
||
|
<li><a href="../../../../../index-all.html">Index</a></li>
|
||
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="subNav">
|
||
|
<ul class="navList" id="allclasses_navbar_bottom">
|
||
|
<li><a href="../../../../../allclasses.html">All Classes</a></li>
|
||
|
</ul>
|
||
|
<div>
|
||
|
<script type="text/javascript"><!--
|
||
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
||
|
if(window==top) {
|
||
|
allClassesLink.style.display = "block";
|
||
|
}
|
||
|
else {
|
||
|
allClassesLink.style.display = "none";
|
||
|
}
|
||
|
//-->
|
||
|
</script>
|
||
|
<noscript>
|
||
|
<div>JavaScript is disabled on your browser.</div>
|
||
|
</noscript>
|
||
|
</div>
|
||
|
<div>
|
||
|
<ul class="subNavList">
|
||
|
<li>Summary: </li>
|
||
|
<li>Nested | </li>
|
||
|
<li>Field | </li>
|
||
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
||
|
<li><a href="#method.summary">Method</a></li>
|
||
|
</ul>
|
||
|
<ul class="subNavList">
|
||
|
<li>Detail: </li>
|
||
|
<li>Field | </li>
|
||
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
||
|
<li><a href="#method.detail">Method</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<a id="skip.navbar.bottom">
|
||
|
<!-- -->
|
||
|
</a></div>
|
||
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||
|
</nav>
|
||
|
<p class="legalCopy"><small>Copyright © 2021. All rights reserved.</small></p>
|
||
|
</footer>
|
||
|
</body>
|
||
|
</html>
|