octoleo/plantuml
1
0
Fork 0
mirror of https://github.com/octoleo/plantuml.git synced 2024-12-22 10:59:01 +00:00
Code Issues Releases Wiki Activity

Document plasma package

Browse Source
This commit is contained in:
Benjamin Davies 2023-08-26 15:48:49 +12:00
parent ef8879f3b3
commit 5386b9e7e2
No known key found for this signature in database
GPG Key ID: 9FFDE0674336C460
4 changed files with 67 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/net/sourceforge/plantuml/plasma/PEntry.java
View File

@ -35,6 +35,16 @@
*/
package net.sourceforge.plantuml.plasma;
/**
* Keeps track of the {@link Quark} objects that have a given name. Short for
* {@link Plasma} entry.
*
* <p>
* Tracks the first instace created with that name, as well as the number of
* quarks with that name.
*
* @see Plasma#stats
*/
class PEntry<DATA> {
// ::remove folder when __HAXE__

5
src/net/sourceforge/plantuml/plasma/Plasma.java
View File

@ -42,6 +42,11 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* A namespace for {@link Quark} objects.
*
* @see net.sourceforge.plantuml.plasma
*/
public class Plasma<DATA> {
private String separator = "\u0000";

5
src/net/sourceforge/plantuml/plasma/Quark.java
View File

@ -40,6 +40,11 @@ import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
/**
* A named node in the entity graph.
*
* @see net.sourceforge.plantuml.plasma
*/
public class Quark<DATA> {
private final Plasma<DATA> plasma;

47
src/net/sourceforge/plantuml/plasma/package-info.java Normal file
View File

@ -0,0 +1,47 @@
/* ========================================================================
* 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/paypal
*
* This file is part of PlantUML.
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the GNU 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 General Public
* License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
*
* Original Author: Benjamin Davies
*
*
*/
/**
* Provides {@link Plasma} and {@link Quark} classes.
*
* <p>
* Class diagrams (and other free-form graphs) are represented as a tree of
* enities. The tree structure is represented using {@link Quark} objects, each
* of which corresponds to an {@link net.sourceforge.plantuml.abel.Entity}. The
* quark for an entity can be retrieved using a method on the entity, and
* vice-versa.
*/
package net.sourceforge.plantuml.plasma;