net.sourceforge.plantuml.json.PrettyPrint 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
PlantUML is a component that allows to quickly write diagrams from text.
There is a newer version: 1.2024.8
// 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.json;

import java.io.IOException;
import java.io.Writer;
import java.util.Arrays;

/**
 * Enables human readable JSON output by inserting whitespace between
 * values.after commas and colons. Example:
 *
 *  * jsonValue.writeTo(writer, PrettyPrint.singleLine());
 * 
 */
public class PrettyPrint extends WriterConfig {

	private final char[] indentChars;

	protected PrettyPrint(char[] indentChars) {
		this.indentChars = indentChars;
	}

	/**
	 * Print every value on a separate line. Use tabs (\t) for
	 * indentation.
	 *
	 * @return A PrettyPrint instance for wrapped mode with tab indentation
	 */
	public static PrettyPrint singleLine() {
		return new PrettyPrint(null);
	}

	/**
	 * Print every value on a separate line. Use the given number of spaces for
	 * indentation.
	 *
	 * @param number the number of spaces to use
	 * @return A PrettyPrint instance for wrapped mode with spaces indentation
	 */
	public static PrettyPrint indentWithSpaces(int number) {
		if (number < 0) {
			throw new IllegalArgumentException("number is negative");
		}
		char[] chars = new char[number];
		Arrays.fill(chars, ' ');
		return new PrettyPrint(chars);
	}

	/**
	 * Do not break lines, but still insert whitespace between values.
	 *
	 * @return A PrettyPrint instance for single-line mode
	 */
	public static PrettyPrint indentWithTabs() {
		return new PrettyPrint(new char[] { '\t' });
	}

	@Override
	protected JsonWriter createWriter(Writer writer) {
		return new PrettyPrintWriter(writer, indentChars);
	}

	private static class PrettyPrintWriter extends JsonWriter {

		private final char[] indentChars;
		private int indent;

		private PrettyPrintWriter(Writer writer, char[] indentChars) {
			super(writer);
			this.indentChars = indentChars;
		}

		@Override
		protected void writeArrayOpen() throws IOException {
			indent++;
			writer.write('[');
			writeNewLine();
		}

		@Override
		protected void writeArrayClose() throws IOException {
			indent--;
			writeNewLine();
			writer.write(']');
		}

		@Override
		protected void writeArraySeparator() throws IOException {
			writer.write(',');
			if (!writeNewLine()) {
				writer.write(' ');
			}
		}

		@Override
		protected void writeObjectOpen() throws IOException {
			indent++;
			writer.write('{');
			writeNewLine();
		}

		@Override
		protected void writeObjectClose() throws IOException {
			indent--;
			writeNewLine();
			writer.write('}');
		}

		@Override
		protected void writeMemberSeparator() throws IOException {
			writer.write(':');
			writer.write(' ');
		}

		@Override
		protected void writeObjectSeparator() throws IOException {
			writer.write(',');
			if (!writeNewLine()) {
				writer.write(' ');
			}
		}

		private boolean writeNewLine() throws IOException {
			if (indentChars == null) {
				return false;
			}
			writer.write('\n');
			for (int i = 0; i < indent; i++) {
				writer.write(indentChars);
			}
			return true;
		}

	}

}