From 6cd17bb9fb53792e532dfd74d048cc41568a97ec Mon Sep 17 00:00:00 2001 From: Project Nayuki Date: Wed, 28 Jul 2021 17:06:27 +0000 Subject: [PATCH] In Java version: moved QrCode.toSvgString() out of the library and into the runnable demo program, slightly adapted some code, updated documentation comments. --- .../main/java/io/nayuki/qrcodegen/QrCode.java | 34 ---------------- .../nayuki/qrcodegen/QrCodeGeneratorDemo.java | 39 ++++++++++++++++++- .../io/nayuki/qrcodegen/package-info.java | 2 +- 3 files changed, 39 insertions(+), 36 deletions(-) diff --git a/java/src/main/java/io/nayuki/qrcodegen/QrCode.java b/java/src/main/java/io/nayuki/qrcodegen/QrCode.java index 49742f7..2fb8b97 100644 --- a/java/src/main/java/io/nayuki/qrcodegen/QrCode.java +++ b/java/src/main/java/io/nayuki/qrcodegen/QrCode.java @@ -284,40 +284,6 @@ public final class QrCode { } - /** - * Returns a string of SVG code for an image depicting this QR Code, with the specified number - * of border modules. The string always uses Unix newlines (\n), regardless of the platform. - * @param border the number of border modules to add, which must be non-negative - * @return a string representing this QR Code as an SVG XML document - * @throws IllegalArgumentException if the border is negative - */ - public String toSvgString(int border) { - if (border < 0) - throw new IllegalArgumentException("Border must be non-negative"); - long brd = border; - StringBuilder sb = new StringBuilder() - .append("\n") - .append("\n") - .append(String.format("\n", - size + brd * 2)) - .append("\t\n") - .append("\t\n") - .append("\n") - .toString(); - } - - /*---- Private helper methods for constructor: Drawing function modules ----*/ diff --git a/java/src/main/java/io/nayuki/qrcodegen/QrCodeGeneratorDemo.java b/java/src/main/java/io/nayuki/qrcodegen/QrCodeGeneratorDemo.java index 2b6b619..5f70344 100644 --- a/java/src/main/java/io/nayuki/qrcodegen/QrCodeGeneratorDemo.java +++ b/java/src/main/java/io/nayuki/qrcodegen/QrCodeGeneratorDemo.java @@ -62,7 +62,7 @@ public final class QrCodeGeneratorDemo { File imgFile = new File("hello-world-QR.png"); // File path for output ImageIO.write(img, "png", imgFile); // Write image to file - String svg = qr.toSvgString(4); // Convert to SVG XML code + String svg = toSvgString(qr, 4); // Convert to SVG XML code File svgFile = new File("hello-world-QR.svg"); // File path for output Files.write(svgFile.toPath(), // Write image to file svg.getBytes(StandardCharsets.UTF_8)); @@ -204,4 +204,41 @@ public final class QrCodeGeneratorDemo { ImageIO.write(img, "png", new File(filepath)); } + + /** + * Returns a string of SVG code for an image depicting the specified QR Code, with the specified + * number of border modules. The string always uses Unix newlines (\n), regardless of the platform. + * @param qr the QR Code to render (not {@code null}) + * @param border the number of border modules to add, which must be non-negative + * @return a string representing the QR Code as an SVG XML document + * @throws NullPointerException if the QR Code is {@code null} + * @throws IllegalArgumentException if the border is negative + */ + private static String toSvgString(QrCode qr, int border) { + Objects.requireNonNull(qr); + if (border < 0) + throw new IllegalArgumentException("Border must be non-negative"); + long brd = border; + StringBuilder sb = new StringBuilder() + .append("\n") + .append("\n") + .append(String.format("\n", + qr.size + brd * 2)) + .append("\t\n") + .append("\t\n") + .append("\n") + .toString(); + } + } diff --git a/java/src/main/java/io/nayuki/qrcodegen/package-info.java b/java/src/main/java/io/nayuki/qrcodegen/package-info.java index f741b64..04ff2cd 100644 --- a/java/src/main/java/io/nayuki/qrcodegen/package-info.java +++ b/java/src/main/java/io/nayuki/qrcodegen/package-info.java @@ -10,7 +10,7 @@ *
  • Available in 6 programming languages, all with nearly equal functionality: Java, TypeScript/JavaScript, Python, Rust, C++, C

  • *
  • Significantly shorter code but more documentation comments compared to competing libraries

  • *
  • Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard

  • - *
  • Output formats: Raw modules/pixels of the QR symbol, SVG XML string

  • + *
  • Output format: Raw modules/pixels of the QR symbol

  • *
  • Encodes numeric and special-alphanumeric text in less space than general text

  • *
  • Open source code under the permissive MIT License

  • *