Labels refactoring.

Author: mjfryc

build.gradle

@@ -6,7 +6,7 @@ plugins {
 }
 
 group 'io.github.mjfryc'
-version '1.0.0'
+version '1.0.1'
 
 repositories {
     mavenCentral()

src/main/java/pl/mjaron/tinyloki/Labels.java

@@ -394,19 +394,33 @@ public static Labels prettify(final Labels labels, final LabelSettings labelSett
      *
      * @param labels Map with label-name mapped to label-value pairs.
      * @return New instance of {@link Labels}.
-     * @since 1.0.0
+     * @since 1.0.1
      */
-    public static Labels make(final Map<String, String> labels) {
+    public static Labels of(final Map<String, String> labels) {
         return new Labels(labels);
     }
 
     /**
-     * Creates a new empty labels instance.
+     * Creates labels containing single name-value pair. Call {@link #l(String, String)} method to add more labels.
      *
+     * @param name  Label name. Valid label identifier starts with letter and contains only letters, digits or '_'.
+     * @param value Label value. Valid label identifier starts with letter and contains only letters, digits or '_'.
      * @return New instance of {@link Labels}.
-     * @since 1.0.0
+     * @see #l(String, String)
+     * @since 1.0.1
      */
-    public static Labels make() {
+    public static Labels of(final String name, final String value) {
+        return new Labels().l(name, value);
+    }
+
+    /**
+     * Creates a new empty labels instance. Call {@link #l(String, String)} method to add any labels.
+     *
+     * @return New instance of {@link Labels}.
+     * @see #l(String, String)
+     * @since 1.0.1
+     */
+    public static Labels of() {
         return new Labels();
     }
 
@@ -479,16 +493,14 @@ public String toString() {
     /**
      * Add a new label and return this object.
      *
-     * @param labelName  Label name. Valid label identifier starts with letter and contains only letters, digits or
-     *                   '_'.
-     * @param labelValue Label value. Valid label identifier starts with letter and contains only letters, digits or
-     *                   '_'.
+     * @param name  Label name. Valid label identifier starts with letter and contains only letters, digits or '_'.
+     * @param value Label value. Valid label identifier starts with letter and contains only letters, digits or '_'.
      * @return This object with added label.
-     * @throws RuntimeException when given <code>labelName</code> or <code>labelValue</code> is null or empty.
+     * @throws RuntimeException when given <code>name</code> or <code>value</code> is null or empty.
      * @since 0.1.22
      */
-    public Labels l(final String labelName, final String labelValue) {
-        map.put(labelName, labelValue);
+    public Labels l(final String name, final String value) {
+        map.put(name, value);
         return this;
     }
 

src/main/java/pl/mjaron/tinyloki/TinyLoki.java

@@ -239,7 +239,7 @@ public IExecutor getExecutor() {
      */
     @SuppressWarnings("unused")
     public ILogStream createStream(final Map<String, String> labels) {
-        return this.createStream(Labels.make(labels));
+        return this.createStream(Labels.of(labels));
     }
 
     /**

src/test/java/pl/mjaron/tinyloki/IntegrationTest.java

@@ -35,7 +35,7 @@ void verboseTest() throws InterruptedException {
 
         // Initialize the log controller instance with URL.
         // The endpoint loki/api/v1/push will be added by default if missing.
-        // Usually creating more than one TinyLoki instance doesn't make sense.
+        // Usually creating more than one TinyLoki instance doesn't of sense.
         // TinyLoki (its default IExecutor implementation) owns separate thread which sends logs periodically.
         // It may be called inside try-with-resources block, but the default close() method doesn't synchronize the logs,
         // but just interrupts the background worker thread.

src/test/java/pl/mjaron/tinyloki/JsonLogCollectorTest.java

@@ -68,7 +68,7 @@ private static String byteArrayToCode(byte[] array) {
     }
 
     public static byte[] hexStringToByteArray(String hexStr) {
-        System.out.println(hexStr);  // log our input make sure it is what we think it is.
+        System.out.println(hexStr);  // log our input of sure it is what we think it is.
         byte[] bArray = new byte[hexStr.length() / 3];
         int index = 0;
         for (String cell : hexStr.split(" ")) {

src/test/java/pl/mjaron/tinyloki/LabelsTest.java

@@ -140,7 +140,7 @@ void from() {
         HashMap<String, String> map = new HashMap<>();
         map.put("abc", "123");
         map.put("def", "456");
-        Labels l = Labels.make(map);
+        Labels l = Labels.of(map);
         assertEquals(l.getMap(), map);
     }
 
@@ -149,7 +149,7 @@ void getMap() {
         HashMap<String, String> map = new HashMap<>();
         map.put("abc", "123");
         map.put("def", "456");
-        Labels l = Labels.make(map);
+        Labels l = Labels.of(map);
         assertEquals(l.getMap(), map);
     }
 

src/test/java/pl/mjaron/tinyloki/TinyLokiTest.java

@@ -9,7 +9,7 @@ public class TinyLokiTest {
     @Test
     void dummySendLegacyTest() {
         TinyLoki tinyLoki = TinyLoki.withUrl("http://localhost/loki/api/v1/push").withLogSender(new DummyLogSender(1000)).withLogMonitor(new VerboseLogMonitor()).withLabelLength(1, 1).start();
-        ILogStream abcStream = tinyLoki.createStream(Labels.make().info().l("abc", "bcd"));
+        ILogStream abcStream = tinyLoki.createStream(Labels.of().info().l("abc", "bcd"));
         abcStream.log(1, "Hello world.");
         tinyLoki.softStop().hardStop();
     }